Africa Fintech FoundryDeveloper Portal
Get API keys
Escrow API

Payments & payouts

Resolve settlement accounts, receive payment callbacks, confirm buyer funding, and release an eligible transaction to the seller.

GET

Name enquiry

/api/Payment/nameEnquiry
Returns the account name associated with an account number and bank code.
Parameters
accountNostring · queryAccount number to resolve.
bankCodestring · queryDestination bank code.
// path/query parameters
accountNo=0000000001
bankCode=044
POST

Payment callback service

/api/Payment/callbackService
Receives the payment callback payload represented by CallbackReq.
Parameters
customer_idstring · nullableCustomer identifier.
virtual_account_nostring · nullableVirtual account number.
virtual_account_namestring · nullableVirtual account name.
transaction_amountstring · nullableTransaction amount.
transaction_referencestring · nullableTransaction reference.
bo_referencenostring · nullableBack-office reference.
source_accountstring · nullableSource account number.
source_account_namestring · nullableSource account name.
source_bankstring · nullableSource bank name.
source_bank_codestring · nullableSource bank code.
narrationstring · nullableTransaction narration.
session_idstring · nullableSwitch session identifier.
transaction_datestring · date-time · nullableTransaction date and time.
tran_response_codestring · nullableTransaction response code.
tran_response_messagestring · nullableTransaction response message.
channel_codestring · nullableChannel code.
transaction_typestring · nullableTransaction type.
transaction_feestring · nullableTransaction fee.
userIdstring · nullableUser identifier.
// request
{
  "customer_id": "buyer@example.invalid",
  "virtual_account_no": "0000000014",
  "virtual_account_name": "ESCROW ESC-8F2C-0114",
  "transaction_amount": "25000",
  "transaction_reference": "ESC-PAY-0114",
  "bo_referenceno": "BO-0114",
  "source_account": "0000000002",
  "source_account_name": "ADAEZE NWOSU",
  "source_bank": "Access Bank",
  "source_bank_code": "044",
  "narration": "Escrow payment",
  "session_id": "TST0000000000114",
  "transaction_date": "2026-07-15T13:22:04Z",
  "tran_response_code": "00",
  "tran_response_message": "Successful",
  "channel_code": "ESCROW",
  "transaction_type": "CREDIT",
  "transaction_fee": "0",
  "userId": "buyer@example.invalid"
}
POST

Confirm payment

/api/Payment/confirmPayment
Confirms whether payment has been received for an escrow transaction.
Parameters
idstring · queryEscrow transaction identifier.
// path/query parameters
id=ESC-8F2C-0114
POST

Make seller payment

/api/Payment/makeSellerPaymentt
Initiates settlement to the seller for an escrow transaction.
Parameters
idstring · queryEscrow transaction identifier.
// path/query parameters
id=ESC-8F2C-0114