📤Withdrawal

Request to create a withdrawal

The section is similar to the Request to create a deposit section. Only the data required to create a withdrawal request will change.

All the necessary information can be found in our API documentation.

Example of the responses:

Success

{
  "success": true,
  "status": "Pending",
  "order_id": "7fa13dbc3b79e05e",
  "data": {}
}

Error

{
  "success": false,
  "status": "Failed",
  "message": "Invalid request",
  "code": 400,
  "order_id": "7fa13dbc3b79e05e"
}

Withdrawal information

Examples of the responses:

Success

{
  "success": true,
  "status": "Success",
  "order_id": "7fa13dbc3b79e05e",
  "amount": 10,
  "currency": "INR",
  "payment_system": "mpesa",
  "custom_transaction_id": "custom123",
  "custom_user_id": "user123",
  "created_at": 1665135515
}

Error

{
  "success": false,
  "code": 400,
  "message": "Invalid request"
}

PreviousDeposit information NextTelegram Payments

Last updated 11 days ago

Request to create a withdrawal

Withdrawal creation.

When the withdrawal is confirmed, a callback request will be sent to the client's application handler with the Withdrawal webhook body

post

/Remotes/create-withdrawal

Authorizations

Query parameters

project_idnumberrequired

Project ID in the A-Pay system

Example: 123

Body

amountintegerrequired

Withdrawal amount

Example: 10

currencyCurrencyrequired

<details> <summary>Payment system currency</summary>

Currency	Payment systems
INR	`upi_fast`, `upi_fast_v`, `upi_fast_qr`, `upi_p2p`, `upi_a`, `paytm`, `phonepe`, `imps`, `imps_top`, `upi_link`, `upi_push`, `phonepe_fast`, `upi_fast_vip`
BDT	`nagad_api_v`, `bkash_a`, `apaybdt`, `upay`, `bkash_b`, `nagad_a`, `nagad_b`
PKR	`bankalfalah`, `easypaisa`, `jazzcash_l`, `nayapay_l`, `jazzcash_fast`, `jazzcash_w`
KES	`mpesa`
UZS	`payme`
MMK	`wavepay_l`
TND	`d17_l`, `flouci`
BRL	`pix_p2p`
MXN	`spei_p2p`
KHR	`wing_l`, `ababank`
NPR	`esewa`, `khalti`

</details>

Example: INR

Options: INR, BDT, PKR, KES, UZS, MMK, TND, BRL, MXN, KHR, NPR

payment_systemPayment systemrequired

Name of the payment system in A-Pay

Example: mpesa

Options: mpesa, easypaisa, bankalfalah, upi_fast, upi_fast_v, upi_p2p, bkash_a, apaybdt, upay, nagad_api_v, payme, paytm, phonepe, imps, imps_top, bkash_b, nagad_a, nagad_b, jazzcash_l, wavepay_l, d17_l, pix_p2p, spei_p2p, wing_l, esewa, khalti, nayapay_l, ababank, jazzcash_w, flouci

custom_transaction_idstring · max: 200

Transaction ID in the client's system

Example: custom123

custom_user_idstring · max: 200required

User ID in the client's system. Must be unique for each user

Example: user123

webhook_idstring · min: 7 · max: 7

Id of a webhook that will be used to send a postback. If not filled then default webhook url will be used

Example: 42798

dataone ofrequired

Data depending on the specific payment system

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://<domain>/Remotes/create-withdrawal?project_id=1' \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"amount":10,"currency":"INR","payment_system":"mpesa","custom_transaction_id":"custom123","custom_user_id":"user123","webhook_id":42798,"data":{"phone_number":"254712345678"}}'

200

400

{
  "success": true,
  "order_id": "7fa13dbc3b79e05e",
  "data": {},
  "status": "Pending"
}