Reverse a transfer initiation

Reverse transfer initiation

POST /api/payments/transfer-initiations/{transferId}/reverse

Try it

Reverse a transfer initiation

cURL

curl --request POST \
  --url http://localhost/api/payments/transfer-initiations/{transferId}/reverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "XXX",
  "description": "<string>",
  "amount": 123,
  "asset": "USD",
  "metadata": {}
}
'

default

{
  "errorCode": "VALIDATION",
  "errorMessage": "[VALIDATION] missing reference"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

transferId · string · required

The transfer ID.

Body

application/json

reference · string · required

Example:

"XXX"

description · string · required

amount · integer<bigint> · required

asset · string · required

Example:

"USD"

metadata · object · required

Show child attributes

metadata. {key} · string

Response

204

No content