Skip to main content

Step 5: Withdrawal Request

Send funds to the customer's tokenized card.

Endpoint Information

Name: Withdrawal Request
Method: POST
URL: {{base_url}}/api/v1/payment/withdrawal

Description

Process the withdrawal. The system will first attempt to refund any previous deposits (OCT/Refund). If there is a remaining balance or if refunds are not applicable, it will process a payout transaction.

Request Body

Content-Type: application/json

{
"merchantAaccountId": "{{yourMerchantAccountId}}",
"customerToken": "", // Optional, if you have it
"customerReferenceId": "b86c68e5-9a14-4e49-b55e-e7f2285110a9",
"cardToken": "0ec8e87d-5f0c-4748-ba7c-41992d717c2d",
"reference": "BYOCJXEBFR18",
"currency": "USD",
"amount": "125"
}

Key Parameters

ParameterTypeRequiredDescription
cardTokenstringYesThe token retrieved in Step 4
customerReferenceIdstringYesThe customer ID from Step 1
amountstringYesWithdrawal amount

Response

Success Response

{
"success": true,
"message": "success",
"data": []
}