Skip to main content
POST
/
v1
/
withdraws
curl --request POST \
  --url https://omnipay.page/api/v1/withdraws \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "1000",
  "phone": "01341491353",
  "payment_method": "bkash",
  "merchant_id": "KJKJ22",
  "metadata": {
    "invoice_id": "NSOIENKXNY"
  }
}'

{
  "id": "ettghe0woyn",
  "merchant_id": "KJKJ22",
  "phone": "01341491353",
  "payment_method": "bkash",
  "amount": "1000",
  "status": "succeeded",
  "metadata": {
    "invoice_id": "NSOIENKXNY"
  }
}

​
Body

​
amount
string
required
The amount to withdraw.
​
phone
string
required
The customer’s phone number.
​
payment_method
string
required
The payment method to use for the withdrawal. Valid values are bkash, nagad.
​
merchant_id
string
required
Your unique transaction ID.
​
metadata
JSON
Set of key-value pairs that you can attach to an object.

​
Response

​
id
string
The ID of the withdrawal request.
​
phone
string
The customer’s phone number.
​
payment_method
string
The payment method used for the withdrawal.
​
amount
string
The amount which was requested to be withdrawn.
​
status
string
The status of the withdrawal request.
processing - The withdrawal request has been received by us and is being processed.
succeeded - The withdrawal request has been succeeded and the funds have been transferred.
failed - The withdrawal request has failed.\
​
metadata
JSON
Set of key-value pairs that you had attached to an object.
curl --request POST \
  --url https://omnipay.page/api/v1/withdraws \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "1000",
  "phone": "01341491353",
  "payment_method": "bkash",
  "merchant_id": "KJKJ22",
  "metadata": {
    "invoice_id": "NSOIENKXNY"
  }
}'

{
  "id": "ettghe0woyn",
  "merchant_id": "KJKJ22",
  "phone": "01341491353",
  "payment_method": "bkash",
  "amount": "1000",
  "status": "succeeded",
  "metadata": {
    "invoice_id": "NSOIENKXNY"
  }
}