Affinity API 1.0 Help

Transaction

Make a transfer

POST method/transactions/transfer

Transfer money from customer account to desired destination account

Request parameters

{ "destinationGipCode": "example", "sourceAccountNumber": "example", "branch": "example", "amount": 96, "currency": "example", "customerReference": "example", "destinationAccountNumber": "example", "idempotencyKey": "7c62e63a-b7fb-3d10-966b-70945dc48b52", "beneficiaryName": "example" }

Responses

{ "reference": "example", "status": "PROCESSING", "statusCode": "example", "createdAt": "example", "updatedAt": "example", "currency": "example", "amount": "example", "fee": "example", "note": "example", "seviceType": "DEPOSIT" }
[ { "message": "example", "code": "example", "field": "example" } ]
{ "message": "example" }
{ "code": 81, "message": "example", "errors": [ { "field": "example", "error": "example" } ] }

Check transaction status

GET method/transactions/{idempotencyKey}/status

Retrieve a transaction with it's status

Request parameters

Responses

{ "reference": "example", "status": "PROCESSING", "statusCode": "example", "createdAt": "example", "updatedAt": "example", "currency": "example", "amount": "example", "fee": "example", "note": "example", "seviceType": "DEPOSIT" }
[ { "message": "example", "code": "example", "field": "example" } ]
{ "message": "example" }
{ "code": 81, "message": "example", "errors": [ { "field": "example", "error": "example" } ] }

Make a deposit

POST method/transactions/deposit

Deposit money into a customer's account

Request parameters

{ "accountNumber": "example", "amount": 96, "transactionReference": "example", "customerReference": "example", "paymentChannel": "BANK", "currency": "example", "idempotencyKey": "7c62e63a-b7fb-3d10-966b-70945dc48b52" }

Responses

{ "reference": "example", "status": "PROCESSING", "statusCode": "example", "createdAt": "example", "updatedAt": "example", "currency": "example", "amount": "example", "fee": "example", "note": "example", "seviceType": "DEPOSIT" }
[ { "message": "example", "code": "example", "field": "example" } ]
{ "message": "example" }
{ "code": 81, "message": "example", "errors": [ { "field": "example", "error": "example" } ] }

Retrieve account statement

POST method/transactions/statements

Request statement for an account

Request parameters

{ "accountNumber": "example", "startDate": "example", "endDate": "example" }

Responses

{ "startDate": "example", "endDate": "example", "accountNumber": "example", "accountName": "example", "transactions": [ { "reference": "example", "amount": "example", "currency": "example", "type": "DEBIT", "createdAt": "example", "updateAt": "example", "note": "example" } ] }
[ { "message": "example", "code": "example", "field": "example" } ]
{ "message": "example" }
Last modified: 27 August 2025