API Reference

Initiate Payment

post
https://sandbox.pingpayments.com/payments/api/v1/payment_orders//payments

The "Initiate Payment" endpoint is utilized to initiate a new payment using a specified payment method.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

PaymentOrderID path param

Body Params

Payment request body

string
enum
required

Currency

Allowed:
string | null

Payment reference ID (UUID4)

metadata
object | null

Set of key-value pairs for storing additional information about the Payment

string
enum
required

Payment method

order_items
array of objects
required
length ≥ 1

Items of purchase

order_items*
integer
required
0 to 9223372036854776000

Cost of item given in minor unit of currency (eg. öre for SEK) of the parent payment

uuid | null

Liquidity Account ID (UUID4)

uuid | null

Merchant ID (UUID4)

metadata
object
string
required

Item name

tags
array of strings

Tags used for routing funds

tags
number
required
0 to 99

The items VAT rate

payer
object | null

payer of payment

string
enum
required

Payment method provider

provider_method_parameters
required

Parameters dependent on the given provider and method

string | null

Callback for receiving status updates on a Payment

integer
required
0 to 9223372036854776000

Total payment amount in minor unit of currency (eg. öre for SEK)

Headers
uuid
required

Tenant ID header

date

API version for the specific endpoint

Responses

404

PaymentOrder could not be found

Callback

Updated 5 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago