Withdraw

Withdraw funds to a bank account. The amount is specified in the lowest denomination of the currency (e.g., Kobo for NGN). You must first verify the bank account using the Name Enquiry endpoint before initiating a withdrawal.

post/withdraw

Request

Request body

amountstring required

The amount to withdraw in the lowest denomination (e.g., Kobo for NGN). For example, 100000 = 1,000.00 NGN

currency'NGN' required

The currency to withdraw

Example request

{
  "amount": "100000",
  "beneficiary": {
    "bankAccountNumber": "0123456789",
    "bankAccountName": "JOHN DOE",
    "bankCode": "000013",
    "bankName": "GTBANK PLC"
  }
}

Response

Withdraw response

statusstring string

Example response

{
  "status": "ok",
  "data": {
    "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "ref": "99eeff854ffd345fffs67890",
    "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
    "amount": 1000,
    "autopayout": true,
    "createdAt": "2021-07-01T12:00:00Z",
    "updatedAt": "2021-07-01T12:00:00Z",
    "metadata": {
      "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "orderId": "99854-2345",
      "bankCode": "090267",
      "bankAccountName": "Satoshi Nakamoto",
      "bankAccountNumber": "0123456789",
      "createdAt": "2021-07-01T12:00:00Z",
      "updatedAt": "2021-07-01T12:00:00Z"
    }
  }
}

Changes

    • warning

      added the new USDT enum value to the / response property for the response status

    • warning

      added the new GHS enum value to the / response property for the response status