Sign in

v1

latestOpenAPI 3.0.02026-08-06363576.8 KB
Payment

Refund a settled Payment

If a Payment is in the settled state and the payment processor supports refunds, you can refund it. Requires a secret key.

post/payments/{uuid}/refund/

Path parameters

uuidstring uuid required

Response

Successful operation

uuidstring uuid
amountstring
currencystring
descriptionstring
referencestring
state'failed' | 'settled' | 'pending' | 'retrying'
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "amount": "100.00",
    "currency": "USD",
    "state": "settled",
    "transactions": [
      {
        "amount": "6.99",
        "currency": "USD"
      }
    ]
  }
]