Skip to main content
POST
/
v1
/
transfers
/
{id}
/
reversals
/
{id}
Update a transfer reversal
curl --request POST \
  --url https://api.yorlet.com/v1/transfers/{id}/reversals/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {}
}'
{
  "id": "<string>",
  "created": 123,
  "object": "transfer_reversal",
  "amount": 123,
  "currency": "gbp",
  "description": "<string>",
  "transfer": "<string>",
  "account": "<string>",
  "deleted": false,
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

​
id
string
required

The id identifier.

Body

application/json
​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Response

200 - application/json

Returns the transfer reversal.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
transfer_reversal
​
amount
integer
required

The amount reversed, in the smallest currency unit.

​
currency
enum<string>
required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Available options:
gbp,
usd,
eur,
sek
Example:

"gbp"

​
description
string | null
required

An arbitrary string attached to the reversal. Often useful for displaying to users.

​
transfer
string
required

The ID of the transfer that was reversed.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.