Originator Transfer

idinteger, (int64)

Transfer ID

Example:16521632

userinteger, (int64)

Your user ID

Example:4342275

targetAccountinteger, (int64)

Recipient account ID

Example:8692237

sourceAccountinteger or null, (int64)

Refund recipient account ID

Example:null

quotestring

Quote ID

Example:"8fa9be20-ba43-4b15-abbb-9424e1481050"

statusstring

Transfer's current status. See Tracking transfers for all possible statuses.

Example:"cancelled"

ratenumber

Exchange rate value

Example:0.89

createdstring, (date-time)

Timestamp when transfer was created.

Example:"2025-10-29T12:28:16.000Z"

businessinteger or null, (int64)

Your business profile ID

Example:null

detailsobject

originatorobject

Data block to capture payment originator details.

hasActiveIssuesboolean

Indicates any pending issues that could stop the transfer from executing.

Example:false

sourceCurrencystring

Source currency code

Example:"EUR"

sourceValuenumber

Transfer amount in source currency

Example:0

targetCurrencystring

Target currency code

Example:"GBP"

targetValuenumber

Transfer amount in target currency

Example:150

originalTransferIdstring

Unique identifier randomly generated per transfer request by the calling client.

Example:"54a6bc09-cef9-49a8-9041-f1f0c654cd88"

payinSessionIdstring, (uuid)

ID of the Payin Session generated for the transfer, which can be used for certain payin methods when funding the transfer.

Example:"23330542-8e9e-419f-95eb-312b880f92ad"

referencestringdeprecated

Deprecated, use details.reference instead.

Example:"reference text"

transferRequestinteger or nulldeprecated

Deprecated

Example:null

{
  "id": 16521632,
  "user": 4342275,
  "targetAccount": 8692237,
  "sourceAccount": null,
  "quote": "8fa9be20-ba43-4b15-abbb-9424e1481050",
  "status": "cancelled",
  "reference": "reference text",
  "rate": 0.89,
  "created": "2025-10-29T12:28:16.000Z",
  "business": null,
  "transferRequest": null,
  "details": {
    "reference": "Testing"
  },
  "originator": {
    "legalEntityType": "PRIVATE",
    "reference": "CST-2991992",
    "name": {
      "givenName": "John",
      "middleNames": [ … ],
      "familyName": "Godspeed",
      "patronymicName": null,
      "fullName": "John Godspeed"
    },
    "dateOfBirth": "1977-07-01",
    "businessRegistrationCode": null,
    "address": {
      "firstLine": "Salu tee 14",
      "city": "Tallinn",
      "stateCode": null,
      "countryCode": "EE",
      "postCode": "12112"
    },
    "accountDetails": "23456789"
  },
  "hasActiveIssues": false,
  "sourceCurrency": "EUR",
  "sourceValue": 0,
  "targetCurrency": "GBP",
  "targetValue": 150,
  "originalTransferId": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
  "payinSessionId": "23330542-8e9e-419f-95eb-312b880f92ad"
}