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

integer
required
0 to 9223372036854776000

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

string
enum
required

Currency

Allowed:
string

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

string

Message that will be shown to the original payer

order_items
array of objects
Defaults to []

Items of purchase

order_items
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 about 2 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 about 2 months ago

Did this page help you?