Create bank payout request

Ivorypay enables businesses to initiate a payout into a supported local bank account. You can find a list of all the supported banks in the country of your business by using our Fetch banks endpoint.

POST https://api.ivorypay.io/v1/payout-requests/bank

Request Body

Name
Type
Description

amount*

Number

The amount to be withdrawn from your wallet

currency*

String

The currency of the wallet you want to withdraw from.

accountNumber*

String

A valid account number

bankName

String

accountName*

String

The name associated with the account. Use the bank account name resolution endpoint to verify your bank account name.

bankIdentifier

String

A valid bank identifier. You can find the right bank identifier when you fetch a list of banks.

{
    "success": true,
    "message": "Your request has been submitted",
    "data": {
        "baseCurrency": "USDT",
        "amountInBaseCurrency": 2,
        "amountInLocalFiat": 1800,
        "amountInUSD": 2,
        "feeInBaseCurrency": 0.0056,
        "feeInUSD": 0.0056,
        "feeInLocalFiat": 5,
        "reference": "pr_QBkwtBVBB5gCO45aP7bOAOu2sKCf3fxH",
        "localFiat": "NGN",
        "type": "OFF_CHAIN",
        "channel": "BANK",
        "userId": "a4b97a86-fad1-485a-9e2e-87ce49c848a9",
        "businessId": "ee457e14-1331-4dfd-bb9d-2b9c8ba778df",
        "status": "FULFILLED",
        "environment": "TEST",
        "recipient": {
            "accountNumber": "0232835146",
            "accountName": "TOLUWANIMI ELNATHAN AKINDAHUNSI",
            "bankIdentifier": "49B81CAC-E075-4D65-8AE0-8F921402D88C",
            "bankName": "Wema Bank"
        },
        "isAutomated": 1,
        "automatedProcessor": "PAGA",
        "processingAt": "2023-09-13T06:44:01.715Z",
        "withdrawalTxId": "qU62C6s3IIjGvBRN",
        "paidAt": "2023-09-13T06:44:01.715Z",
        "createdAtDateOnly": "2023-09-13",
        "usdToLocalFiatRate": 0,
        "withdrawalTxHash": null,
        "reasonForDecline": null,
        "orderRefundId": null,
        "cancelledAt": null,
        "processingAgentId": null,
        "declinedAt": null,
        "uuid": "96c17c4b-88b0-4dca-987f-feac23dc0f07",
        "createdAt": "2023-09-13T06:44:01.295Z"
    }
}

PreviousCreate on-chain payout requestNextCancel a payout request

Last updated