Specifications

Request

JSON PATH	Description	Format	Sample/Example	Required
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
type	Optional information to be applied. Restricted to 20 characters	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",
    "amount": ,
    "type": "",
    "reference": "",
    "reference_id": ""
}

Response

Succesful

JSON PATH	Description	Sample/Example	Format	Required
previous_account_balance	The previous balance of the Account.A minus figure indicates a debit balance	100	string	Yes
new_account_balance	The new Account balance following the request. A minus figure indicates a debit balance	200	string	Yes
previous_available_account_balance	The previous available balance of the Account. A minus figure indicates a debit balance	0	string	Yes
new_available_balance	The value that is available to be spent. A minus figure indicates a debit balance	100	string	Yes
trace_id	The Identifier associated with the API	15bfc289-de75-4668-bb11-3998aadf226d	string	Yes

Example

{
    "previous_account_balance": "100",
    "new_account_balance": "200",
    "previous_avaliable_account_balance": "0",     
    "new_avaliable_account_balance": "100",  
    "trace_id": "15bfc289-de75-4668-bb11-3998aadf226d"
}