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.
Request body
Example request
{
"amount": "100000",
"beneficiary": {
"bankAccountNumber": "0123456789",
"bankAccountName": "JOHN DOE",
"bankCode": "000013",
"bankName": "GTBANK PLC"
}
}Response
Withdraw response
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
USDTenum value to thedata/currencyresponse property for the response status200response-property-enum-value-added
- ●
- ●
added the new
GHSenum value to thedata/currencyresponse property for the response status200response-property-enum-value-added
- ●
- ▲
added the new required request property
beneficiarynew-required-request-property
- ▲
the request property
amountbecame requiredrequest-property-became-required
- ▲
the request property
currencybecame requiredrequest-property-became-required
- ▲
removed the enum value
BTCof the request propertycurrencyrequest-property-enum-value-removed
- ▲
removed the enum value
KESof the request propertycurrencyrequest-property-enum-value-removed
- ▲
removed the enum value
USDof the request propertycurrencyrequest-property-enum-value-removed
- ▲
the
amountrequest property type/format changed fromnumber/numbertostring/request-property-type-changed
- ●
removed the request property
bankAccountNumberrequest-property-removed
- ●
removed the request property
walletIdrequest-property-removed
- ○
the
currencyrequest property type/format was generalized fromstring/stringtostring/request-property-type-generalized
- ▲
- ○
removed the
TRANSFERenum value from thedata/typeresponse property for the response status200response-property-enum-value-removed
- ○
- ●
removed the optional property
data/transactionMetadatafrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
data/metadatato the response with the200statusresponse-optional-property-added
- ●
- ●
removed the optional property
data/transactionMetadata/eProviderReffrom the response with the200statusresponse-optional-property-removed
- ●
added the new
ZARenum value to thedata/currencyresponse property for the response status200response-property-enum-value-added
- ○
removed the
USDenum value from thedata/currencyresponse property for the response status200response-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
- ○