Cancel a payout request

You can cancel a payout request as long as it has not been processed.

DELETE https://api.ivorypay.io/v1/payout-request/:id

Path Parameters

Name	Type	Description
id*	String	The ID of a payout request

200: OK Success

{
    "success": true,
    "message": "Your request has been cancelled",
    "data": {
        "id": "ac990a1e-93c0-4419-9da7-e3addf9d819a",
        "cryptocurrency": "USDC",
        "localFiat": "NGN",
        "payoutChannel": "ON_CHAIN",
        "amountInCrypto": 0.01,
        "amountInUSD": 0.010000051207247992,
        "amountInLocalFiat": 5.000025603623996,
        "usdToLocalFiatRate": 0,
        "address": "BSTyXVNAz9eTBXV8eMc3iNTSBgXA3wKqamo4FEXzQnfM",
        "bankDetailId": null,
        "withdrawalTxId": null,
        "businessId": "e0353a89-09dc-4304-ac1e-618b6f88f721",
        "userId": "3f795e70-3267-458d-9d45-4d66d01e118d",
        "feeInCrypto": 0.0001,
        "feeInUSD": 0.00010000051207247992,
        "status": "CANCELLED",
        "reasonForDecline": null,
        "cancelledAt": "2022-10-03T18:41:49.208Z",
        "processingAt": null,
        "paidAt": null,
        "processingAgentId": null,
        "declinedAt": null,
        "createdAtDateOnly": "2022-10-03",
        "createdAt": "2022-10-03T18:28:13.873Z",
        "updatedAt": "2022-10-03T18:41:49.152Z"
    }
}

404: Not Found Not Found

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