Withdraw

Withdraw fiat

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 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

Changed in 7 of the 32 revisions of this API.775

    • added the new USDT enum value to the data/currency response property for the response status 200

      response-property-enum-value-added

    • added the new GHS enum value to the data/currency response property for the response status 200

      response-property-enum-value-added

  • 00611066b076721See the full diff
    • added the new required request property beneficiary

      new-required-request-property

    • the request property amount became required

      request-property-became-required

    • the request property currency became required

      request-property-became-required

    • removed the enum value BTC of the request property currency

      request-property-enum-value-removed

    • removed the enum value KES of the request property currency

      request-property-enum-value-removed

    • removed the enum value USD of the request property currency

      request-property-enum-value-removed

    • the amount request property type/format changed from number/number to string/

      request-property-type-changed

    • removed the request property bankAccountNumber

      request-property-removed

    • removed the request property walletId

      request-property-removed

    • the currency request property type/format was generalized from string/string to string/

      request-property-type-generalized

    • removed the TRANSFER enum value from the data/type response property for the response status 200

      response-property-enum-value-removed

    • removed the optional property data/transactionMetadata from the response with the 200 status

      response-optional-property-removed

    • added the optional property data/metadata to the response with the 200 status

      response-optional-property-added

    • removed the optional property data/transactionMetadata/eProviderRef from the response with the 200 status

      response-optional-property-removed

    • added the new ZAR enum value to the data/currency response property for the response status 200

      response-property-enum-value-added

    • removed the USD enum value from the data/currency response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added