TRtruelayer
Payments

Create payment refund

Refund a merchant account payment.

post/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

The payment ID for the payment to be fully or partially refunded.

Headers

Idempotency-Keystring required

An idempotency key to allow safe retrying without the operation being performed multiple times. The value should be unique for each operation, e.g. a UUID, with the same key being sent on a retry of the same request.

Tl-Signaturestring required

A JWS with detached content, signed with your private key. See Request Signing

Request body

amount_in_minorinteger

A 'cent' value representing the amount, e.g. 100 == 1GBP.

referencestring required

A reference for the refund.

metadataMetadata

Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters.

Example request

{
  "metadata": {
    "prop1": "value1",
    "prop2": "value2"
  }
}

Response

Refund

idstring required

Unique ID for the refund

Example response

{
  "id": "43d12d0f-d775-410f-aaff-482200c17017"
}

Changes

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