TRtruelayer
Payments

Get payment refunds

Returns all refunds of a payment.

get/v3/payments/{id}/refunds

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/payments/{id}/refunds
  • 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

idstring required

Unique ID for the Payment

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

ID of the merchant account payment

Response

Refunds of the payment

Example response

{
  "items": [
    {
      "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.