Skip to content

The Balance History Object

A Balance History object is created when your YouCan Pay balance is updated (incremented or decremented).

Attributes

ParameterTypeDescription
idstringThe object's unique identifier.
account_idstringThe YouCan Pay account to which the balance history is attributed.
display_amountstringThe balance change's monetary value formatted for display.
causer_typenumberAn arbitrary value indicating the causer (reason for which balance was altered). Possible values: 1 (withdrawal), 2 (deposit), 3 (transfer), 4 (payout), 5 (refund).
causer_type_textstringThe string representation of the causer_type property.
causer_idstringThe causer's unique identifier, used in conjunction with causer_type to determine which exact event affected the balance.
created_attimestampThe time that this record of the transfer was first created.

Response

json
{
  "id": "70a5e31c-8b00-4fbd-bc0c-1736c6e5304a",
  "account_id": "4ad60bd6-52fa-46cc-ab67-e729fd166922",
  "display_amount": "-50,00 MAD",
  "causer_type": 3,
  "causer_id": "0ff1ca3b-4e50-4056-88d4-b0f822c38376",
  "causer_type_text": "transfer"
}