API Reference

Refund Payment

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

The 'Refund Payment' endpoint allows you to refund a payment.
To be eligible for a refund, the payment must have a status of 'COMPLETED' and the payment order must not been split.

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

PaymentOrderID path param

uuid
required

PaymentID path param

Body Params

Payment refund request body

Payment refund request body

string
enum
required

Currency

Allowed:
string

An arbitrary string where you can provide more context for the refund

items
array of objects
required
length ≥ 1

How much of each item of the payment to refund. The refunded amount is their sum.

While the payment order is still open the payment is left holding what is not refunded;
once it has settled the money is reclaimed from the merchants, tenants and liquidity
accounts it was settled to.

Replaces the amount and item set of earlier versions: say what is refunded, rather than
what the payment should be left holding.

items*

How much of one item of the payment to refund

integer
required
1 to 9223372036854776000

How much of the item to refund, in minor unit of currency (eg. öre for SEK). An item can
be refunded more than once, never past its own amount in total.

uuid
required

Item ID, as returned on the payment. May be given once per refund.

string

Message that will be shown to the original payer

string
enum
required

Reason for the refund

Allowed:
Headers
uuid
required

Tenant ID header

date

API version for the specific endpoint

Responses

404

PaymentOrder could not be found

Callback

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?