Create on-chain payout request

You can make an on-chain payout request to an external wallet address that you provide.

Please note that the address you provide must be a Solana address.

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

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.
address*	String	A valid address generated on the Solana network

201: Created Success

{
    "success": true,
    "message": "Your request has been submitted",
    "data": {
        "baseCurrency": "USDT",
        "amountInBaseCurrency": 2.1,
        "amountInLocalFiat": 1942.0375,
        "amountInUSD": 2.0995,
        "feeInBaseCurrency": 0.0063,
        "feeInUSD": 0.0063,
        "feeInLocalFiat": 5.8261,
        "reference": "pr_0VFxaNLV77C9JY0nRLt6fhPX9Wwju7fy",
        "localFiat": "NGN",
        "type": "ON_CHAIN",
        "channel": "BLOCKCHAIN",
        "userId": "cfbd48a3-0ab6-4550-a1dc-ab6c71191b6c",
        "businessId": "f8da2b67-06f7-4525-a8c0-ad26c9f3f878",
        "environment": "TEST",
        "paidAt": "2023-09-13T05:32:57.965Z",
        "recipient": {
            "address": "BSTyXVNAz9eTBXV8eMc3iNTSBgXA3wKqamo4FEXzQnfM"
        },
        "createdAtDateOnly": "2023-09-13",
        "usdToLocalFiatRate": 0,
        "withdrawalTxId": null,
        "withdrawalTxHash": null,
        "reasonForDecline": null,
        "orderRefundId": null,
        "cancelledAt": null,
        "processingAt": null,
        "processingAgentId": null,
        "declinedAt": null,
        "automatedProcessor": null,
        "uuid": "370f63db-138c-4d7d-9d62-8d707749b128",
        "status": "PENDING",
        "isAutomated": 0,
        "createdAt": "2023-09-13T05:32:57.981Z"
    }
}

400: Bad Request Invalid data

{
    "success": false,
    "message": "Invalid data",
    "statusCode": 400,
    "errors": [],
    "timestamp": "10/2/2022, 9:47:43
}

400: Bad Request Insufficient balance

{
    "success": false,
    "message": "Insufficient balance",
    "statusCode": 400,
    "timestamp": "9/13/2023, 5:34:16 AM",
    "path": "/v1/payout-requests",
    "method": "POST"
}