Specifications

Request

JSON PATH	Description	Format	Sample/Example	Required
client_id	The Identifier associated to you or your Client	UUID	15bfc289-de75-4668-bb11-3998aadf226d	No
account_id	The Identifier associated to the Account	UUID	fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4	Yes
amount	The amount to be applied to the Account	integer	1000	Yes
direction	Debit or Credit	string	Credit	Yes
type	Optional information to be applied	string	Debit Card	No
destination	Destination where the funds are to be sent	string	Debit Card	No
reference	Optional reference for the Account Balance change	string	Weekly increase	No
reference_id	Optional Identifier relating to the Account Balance change	string	Transfer 20250705	No

Example

{
    "account_id": "fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4",
    "client_id": "15bfc289-de75-4668-bb11-3998aadf226d",
    "amount": ,
    "direction": "",
    "type": "",
    "destination": "",
    "reference": "",
    "reference_id": ""
}

Response

Succesful

JSON PATH	Description	Sample/Example	Format	Required
account_id	The Identifier associated to the Account	fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4	UUID	Yes
previous_account_balance	The previous balance of the Account	100	string	Yes
previous_account_balance_direction	Credit means a positive balance, whereas Debit means the balance is in negative	credit	string	Yes
new_account_balance	The new Account balance following the request	200	string	Yes
new_account_balance_direction	Credit means a positive balance, whereas Debit means the balance is in negative	credit
trace_id	The Identifier associated with the API	15bfc289-de75-4668-bb11-3998aadf226d	UUID	Yes

Example

{
    "account_id": "fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4",
    "previous_account_balance": "100",
    "previous_account_balance_driection": "credit",
    "new_account_balance": "200",
    "new_account_balance_driection": "credit",
    "trace_id": "15bfc289-de75-4668-bb11-3998aadf226d"
}

Unsuccessful

JSON PATH	Description	Sample/Example	Format	Required
account_id	The Identifier associated to the Account	fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4	UUID	Yes
reason	The reason why the request has not been successful. For example: exceeds daily limit exceeds maximum balance insufficient balance	exceeds daily limit	string	Yes
trace_id	The Identifier associated with the API	15bfc289-de75-4668-bb11-3998aadf226d	UUID	Yes

{
    "account_id": "fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4",
    "reason": "exceeds daily limit",
    "trace_id": "15bfc289-de75-4668-bb11-3998aadf226d"
}