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

{
  "id": "ettghe0woyn",
  "merchant_id": "KJKJ22",
  "amount": "1000",
  "payment_method": "bkash",
  "status": "pending",
  "metadata": {
    "invoice_id": "NSOIENKXNY"
  },
  "redirect_url": "https://omnipay.page/api/v1/payments/hk7ppekqfkfj"
}

​
Body

​
amount
string
required
The amount to deposit.
​
payment_method
string
required
The payment method to use for the deposit. Valid values are bkash, nagad.
​
merchant_id
string
required
Your unique transaction ID.
​
redirect_url
string
required
The callback URL of your website to which the customer will be redirected after the deposit with necessary information in the query string.
id, amount, payment_method and status
Example:
id=hk7ppekqfkfj&amount=100&payment_method=bkash&status=succeeded
​
metadata
JSON
Set of key-value pairs that you can attach to an object.

​
Response

​
id
string
The ID of the deposit request.
​
merchant_id
string
Your unique transaction ID.
​
amount
string
The amount which was requested to be deposited.
​
payment_method
string
The payment method used for the deposit.
​
status
string
The status of the deposit request.
pending - The request is pending, the customer has not yet made a payment.
succeeded - Customer has made the payment.
failed - The deposit request has failed.
cancelled - The deposit request has been cancelled by the customer.
expired - The deposit request has expired after 10 minutes.
​
redirect_url
string
The URL to where you will redirect the customer to pay.
​
metadata
JSON
Set of key-value pairs that you had attached to an object.
curl --request POST \
  --url https://omnipay.page/api/v1/deposits/p2c/requests \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "1000",
  "payment_method": "bkash",
  "merchant_id": "KJKJ22",
  "redirect_url": "https://google.com",
  "metadata": {
    "invoice_id": "NSOIENKXNY"
  }
}'

{
  "id": "ettghe0woyn",
  "merchant_id": "KJKJ22",
  "amount": "1000",
  "payment_method": "bkash",
  "status": "pending",
  "metadata": {
    "invoice_id": "NSOIENKXNY"
  },
  "redirect_url": "https://omnipay.page/api/v1/payments/hk7ppekqfkfj"
}