Transfers

Transfer bookings and credits between users.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

transferIdstringRequired

Body

amountnumberRequired

Responses

201

Returns a TransferDto

application/json

idstringRead-onlyRequired

amountnumberRead-onlyRequired

reversedAmountnumber · nullableRead-onlyRequired

reversedDatestring · date-time · nullableRead-onlyRequired

currencystringRead-onlyRequired

statusstring · enumRead-onlyRequiredPossible values:

transferDatestring · date-timeRead-onlyRequired

_linksobjectRead-onlyRequired

post/transfers/{transferId}/reverse

POST /apis/v2/transfers/{transferId}/reverse HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "amount": 1
}

201

Returns a TransferDto

{
  "id": "text",
  "amount": 1,
  "reversedAmount": 1,
  "reversedDate": "2026-01-01T00:00:00.000Z",
  "currency": "text",
  "status": "PENDING",
  "transferDate": "2026-01-01T00:00:00.000Z",
  "stripe": {
    "id": "text"
  },
  "payment": {
    "id": "text"
  },
  "user": {
    "id": "text"
  },
  "reversedByUser": {
    "id": "text"
  },
  "_links": {}
}