Africa Fintech FoundryDeveloper Portal
Get API keys
Escrow API

Protected orders

Create an escrow transaction, retrieve it by id or participant email, look up supported banks, and cancel an order that should no longer proceed.

POST

Create transaction

/api/Transaction/createTransaction
Creates an escrow transaction and returns the account number into which the buyer pays.
Parameters
BuyerEmailstring · emailrequiredBuyer email address.
SellerEmailstring · emailrequiredSeller email address.
ItemNamestringrequiredName of the item being purchased.
ItemImagefileItem image.
Amountnumber · doublerequiredTransaction amount; minimum 0.01.
DeliveryFeenumberDelivery fee.
DeliveryAddressstringrequiredDelivery address.
ContactNumberstringrequiredBuyer contact number.
CommissionOninteger enumrequiredOne of 1 or 2; meanings are not named in the schema.
ExpectedDeliveryDatestring · daterequiredExpected delivery date.
// multipart form
BuyerEmail=buyer@example.invalid
SellerEmail=seller@example.invalid
ItemName=Ankara wax print, 6 yards
ItemImage=ankara.jpg
Amount=25000
DeliveryFee=2500
DeliveryAddress=12 Herbert Macaulay Way, Yaba
ContactNumber=08000000002
CommissionOn=1
ExpectedDeliveryDate=2026-07-20
GET

Get transaction

/api/Transaction/getTransaction/{id}
Returns one escrow transaction by its identifier.
Parameters
idstring · pathrequiredEscrow transaction identifier.
// path/query parameters
id=ESC-8F2C-0114
GET

Get transactions by email

/api/Transaction/getTransactionsByEmail
Returns paginated escrow transactions associated with an email address.
Parameters
emailstring · queryBuyer or seller email address.
statinteger · queryTransaction status filter; values 1–5 are unnamed in the schema.
pageNumberinteger · queryPage number; defaults to 1.
pageSizeinteger · queryPage size; defaults to 10.
// path/query parameters
email=buyer@example.invalid
stat=2
pageNumber=1
pageSize=10
GET

Fetch all banks

/api/Transaction/fetchAllBanks
Returns the NIP bank list used by account enquiries and seller settlement.
// response
{
  "succeeded": true,
  "code": 200,
  "message": "Successful",
  "data": {
    "responseCode": "00",
    "responseMessage": "Successful",
    "getNipBankListResponse": [
      {
        "bankCode": "044",
        "bankName": "Access Bank"
      },
      {
        "bankCode": "057",
        "bankName": "Zenith Bank"
      }
    ]
  },
  "errors": []
}
POST

Cancel transaction

/api/Transaction/cancelTransaction
Cancels an escrow transaction using its transaction identifier.
Parameters
transactionIdstring · queryEscrow transaction identifier.
// path/query parameters
transactionId=ESC-8F2C-0114