Transfer resource

Field

Description

uuid
string

Identifier of the transfer

amount
double

Amount of the transfer

label
string

Label of the transfer

bank_reference
string

Reference of the bank if available

sender_account_id
long

Sender account unique identifier

beneficiary
beneficiary hash

Beneficiary's details: name (string) and iban (string)

item_id
long

Item unique identifier

status
string

Transfer's status

status_reason
string

Transfer's status reason: more information about why a transfer failed

bulk_transfer_id
string

Bulk transfer unique identifier if the transfer is part of a bulk

client_reference
string

Reference provided by the client

created_at
timestamp

updated_at
timestamp

Example transfer resource

{
  "uuid": "02d5b0b6-37e2-4684-aca9-4ede5fb9d7da",
  "amount": 1.0,
  "label": "Label test",
  "bank_reference": "123456789",
  "sender_account_id": 11679775,
  "beneficiary": {
    "name": "Michel Dupont",
    "iban": "FR76XXXXXXXXXXXXXXXXXXXX882"
  },
  "item_id": 4036595,
  "status": "failed",
  "status_reason": "expired"
  "created_at": "2020-08-26T09:13:22.000Z",
  "updated_at": "2020-08-26T09:13:27.000Z",
  "bulk_transfer_id": "fc223ce9-080e-4a96-9cdc-73b2459c32d8",
  "client_reference": "3bc40e21-3ea5-4274-9744-c2f984f7072e",
}