TRtruelayer
Payments

Get payment refund

Returns refund details.

get/v3/payments/{payment_id}/refunds/{refund_id}

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/payments/{payment_id}/refunds/{refund_id}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.truelayer.com/connect/token scopes: payments
    • or OAuth 2
      Client credentials
      Token URL: https://auth.truelayer.com/connect/token scopes: payments:refund

Path parameters

payment_idstring required

Unique ID for the Payment

Example:0afd1f6a-f611-48ce-9488-321129bb3a70

ID of the payment

refund_idstring required

Unique ID for the refund

Example:43d12d0f-d775-410f-aaff-482200c17017

ID of the refund

Response

Refund

OR
OR
OR

Example response

{
  "id": "43d12d0f-d775-410f-aaff-482200c17017",
  "currency": "GBP",
  "metadata": {
    "prop1": "value1",
    "prop2": "value2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.