Refunds

Get refund by ID

Retrieve detailed information about a specific refund

get/refunds/{id}

Request

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

Path parameters

idstring required

Refund ID

Response

OK

created_atstring
customer_idstring
due_datestring
idstring
payment_methodstring
sub_totalnumber
totalnumber

Example response

{
  "created_at": "2021-01-01T00:00:00Z",
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "due_date": "2021-01-01T00:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "payment_method": "card,standard_ach,same_day_ach,manual",
  "sub_total": 50,
  "total": 50
}

Changes

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