API Reference
Asset librariesConsole
Start typing to search…

Create payment refund

post
https://api.truelayer-sandbox.com/v3/payments//refunds

Refund a merchant account payment.

📘

Endpoint path changes

All Payments API v3 endpoints now start with /v3/. The old endpoints still work, but you must use the new path for all new integrations.

Path Params
string
required

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

Body Params
integer
≥ 1

A 'cent' value representing the amount. eg 100 == 1GBP.

string
required

A reference for the refund.

metadata
object

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.

Headers
string
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.

string
required

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

string
enum
Defaults to application/json; charset=UTF-8

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
URL
Response 
 Choose an example:
application/json; charset=UTF-8
application/problem+json; charset=UTF-8
Updated 3 months ago