Transfer resource

FieldDescription
uuid
string
Identifier of the transfer.
resource_uri
string
resource_type
string, constant
amount
double
Amount of the transfer.
label
string
Label of the transfer.
external_reference
string
Reference of the bank if available.
sender_account
sender account hash
Sender account details.
receiver_account
receiver account hash
Not used: will be null
item
item hash
Item details.
result_message
string
Result message of the transfer initiation.
status
string
Status of the transfer : succeeded or failed.
bulk_transfer_id
string
null if the transfer isn't part of a bulk.
client_reference
string
Reference provided by the client.
created_at
timestamp
updated_at
timestamp
receiver_iban stringBeneficiary's IBAN
beneficiary_name stringBeneficiary's name

Example transfer resource

{
  "uuid": "02d5b0b6-37e2-4684-aca9-4ede5fb9d7da",
  "resource_uri": "/v2/transfers/02d5b0b6-37e2-4684-aca9-4ede5fb9d7da",
  "resource_type": "transfer",
  "amount": 1.0,
  "label": "Label test",
  "external_reference": null,
  "sender_account": {
    "id": 11679775,
    "iban": "FR00XXXXXXXXXXXXXXXXXXXX004",
    "name": "internal account 4",
    "resource_uri": "/v2/transfers/accounts/11679775",
    "resource_type": "transfer_account"
  },
  "receiver_account": null,
  "item": {
    "id": 4036595,
    "transfers_allowed": true,
    "resource_uri": "/v2/items/4036595",
    "resource_type": "item"
  },
  "result_message": "Une erreur s'est produite empêchant la réalisation du virement. Le compte emetteur est invalide.",
  "status": "failed",
  "created_at": "2020-08-26T09:13:22.000Z",
  "updated_at": "2020-08-26T09:13:27.000Z",
  "bulk_transfer_id": null,
  "client_reference": "3bc40e21-3ea5-4274-9744-c2f984f7072e",
  "receiver_iban": "FR25XXXXXXXXXXXXXXXXXXXXN83",
  "beneficiary_name": "Test Name"
}