v1

latestOpenAPI 3.1.02026-07-24620123.6 KB

Create Escrow

Creates a new escrow account.

post/api/b2b/escrows

Request body

amountinteger required

Amount to charge from the sender. Must be ≥ 1.

chargeCurrencystring required

The currency the buyer will be charged in.

receiverCurrencystring

The currency the seller will be settled in

externalReferencestring required

A unique reference

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "id": "DOsJPh7gBXgdIY88NVf3",
    "status": "pending_charge",
    "externalReference": "test13256",
    "senderAmount": 100,
    "senderCurrency": "KES",
    "receiverAmount": 99,
    "receiverCurrency": "KES",
    "chargeDetails": {
      "method": "momo",
      "firstName": "Jiraya",
      "lastName": "Monogatari",
      "country": "KE",
      "email": "jiraya@gmail.com",
      "phoneNumber": "254727614739",
      "momoOperatorId": "mpesa"
    },
    "payoutDetails": {
      "method": "momo",
      "country": "KE",
      "payoutMethod": {
        "accountName": "Naruto Uzumaki",
        "accountNumber": "254712345678",
        "momoOperatorId": "mpesa"
      }
    },
    "fee": {
      "feeAmount": 1,
      "feeCurrency": "KES"
    },
    "createdAt": 1760363521118
  }
}