API Reference

Settle PaymentOrder

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

The "Settle PaymentOrder" endpoints settles a PaymentOrder for future disbursement. Refunds will no longer be possible. This endpoint is idempotent which means making multiple identical requests has the same effect as making a single request.

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

PaymentOrderID path param

Body Params

PaymentOrder settling request body

boolean
Defaults to false

Enables or disables fast forwarding of the PaymentOrder lifecycle for this request. When false, settling an order that is not not already split will produce an error. When true, settling a PaymentOrder will - if not already done - first close it, then split it, and finally settle it.

Headers
uuid
required

Tenant ID header

date

API version for the specific endpoint

Responses
204

PaymentOrder was successfully settled

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