The Transfer Object

A Transfer object is created when moving a sum between two YouCanPay accounts. You can make a transfer or retrieve a list of transfers related to your account. Each transfer is identified by a random unique ID.

Attributes

Parameter	Type	Description
id	string	The object's unique identifier.
display_amount	string	The transfer's monetary value formatted for display.
message	string	A message from the account that initiated the transfer, that may be empty.
is_incoming	boolean	Indicates whether the transfer is incoming or outgoing. Is false when your account is the one that initiated the transfer.
transceiver	hash	The other account that partook in the transfer.
created_at	timestamp	The time that this record of the transfer was first created.

Example

{
  "data": {
    "id": "6ae1bc33-0752-479d-8f76-d7cdee4aa1b4",
    "display_amount": "MAD 5.00",
    "message": "Hello o/",
    "is_incoming": false,
    "created_at": "2021-12-16 15:17:25",
    "transceiver": {
      "data": {
        "id": "268e1200-b2f2-4ea8-a640-d19b58989891",
        "first_name": "Cesar",
        "last_name": "Walter",
        "phone": "537-631-0416",
        "email": "[email protected]",
        "type": 1,
        "type_text": "PERSONAL"
      }
    }
  }
}