Create PaymentOrder

post

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

The "Create PaymentOrder" is used to create a new PaymentOrder which is used to group a set of payments. For example all payments pertaining to a single purchase. If the Payments within the PaymentOrder needs to be disbursed at different rates or under distinct conditions they must belong to different PaymentOrders.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

PaymentOrder creation request body

close_condition

currency

string

enum

required

Currency used for this Payment Order

Allowed:

string | null

Payment Order reference ID (UUID4)

settle_schedule

split_parameters

object

Parameters used to control parts of the split tree

split_tree_id

uuid | null

ID for the split tree to be used. If null, the default split tree will be used

status_callback_url

uri | null

URL to receive web callbacks when payment order status changes (e.g. CLOSED, SETTLED)

Headers

tenant_id

uuid

required

Tenant ID header

x-api-version

date

API version for the specific endpoint

Responses

Callback

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200CreatePaymentOrderResponse

403API Error

422Validation Error