Affinity API 1.0 Help

Account

Get account by account number

GET method/accounts/{accountNumber}

Retrieve an account by accountNumber

Request parameters

Responses

{ "reference": "example", "name": "example", "balances": { "totalBalance": 88, "availableBalance": 87 }, "type": "BUSINESS", "accountNumber": "example", "createdAt": "example", "updatedAt": "example", "status": "INACTIVE" }
[ { "message": "example", "code": "example", "field": "example" } ]
{ "message": "example" }

Get account balances

GET method/accounts/{accountNumber}/balances

Retrieve balances of an account by account number

Request parameters

Responses

{ "reference": "example", "name": "example", "balances": { "totalBalance": 88, "availableBalance": 87 }, "type": "BUSINESS", "accountNumber": "example", "createdAt": "example", "updatedAt": "example", "status": "INACTIVE" }
[ { "message": "example", "code": "example", "field": "example" } ]
{ "message": "example" }

Query name on account

GET method/accounts/{accountNumber}/query

Retrieve an account name using the account number

Request parameters

Responses

{ "accountName": "example", "status": "SUCCESS", "statusCode": "00" }
[ { "message": "example", "code": "example", "field": "example" } ]
{ "message": "example" }
Last modified: 27 August 2025