ALalternativepayments
Refunds

Create refund

Create a full refund for a payment. Partial refunds are not supported.

post/refunds

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/refunds
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: refunds:write

Request body

amountstring
idempotency_keystring
payment_idstring

Example request

{
  "amount": "50.00",
  "idempotency_key": "00000000-0000-0000-0000-000000000000",
  "payment_id": "00000000-0000-0000-0000-000000000000",
  "reason": {
    "description": "Please specify the reason in more detail. Min 40 characters."
  }
}

Response

Refund is being processed!

string required

Changes

No recorded changes to this operation across all 7 revisions of this API.