📤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.

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

POSThttps://<domain>/Remotes/create-withdrawal

Authorization

apikey

Query parameters

Body

application/json

amount*integer

Withdrawal amount

Example: 10

currency*Currency

Currency	Payment systems
INR	upi_fast, upi_fast_v, upi_fast_qr, upi_p2p, upi_a, paytm, phonepe, imps, upi_link, upi_push
BDT	nagad_api_v, bkash_a, apaybdt, upay, bkash_b, nagad_a, nagad_b
PKR	bankalfalah, easypaisa, jazzcash_l
KES	mpesa
UZS	payme
MMK	wavepay_l

Example: "INR"

INRBDTPKRKESUZSMMK

payment_system*Payment system

Name of the payment system in A-Pay

Example: "mpesa"

mpesaeasypaisabankalfalahupi_fastupi_fast_vupi_p2pbkash_aapaybdtupaynagad_api_vpaymepaytmphonepeimpsbkash_bnagad_anagad_bjazzcash_lwavepay_l

custom_transaction_idstring

Transaction ID in the client's system

Example: "custom123"

custom_user_id*string

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

Example: "user123"

webhook_idstring

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

Example: 42798

data*one of

Data depending on the specific payment system

mpesabankalfalaheasypaisaimpsbkash_aupi_p2papaybdtupaypaymenagad_api_vpaytmbkash_bnagad_anagad_bjazzcash_lwavepay_l

Response

200400

OK

Body

application/json

one of

SuccessError

Request

JavaScriptCurlPython

const response = await fetch('https://<domain>/Remotes/create-withdrawal', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 10,
      "currency": "INR",
      "payment_system": "mpesa",
      "custom_user_id": "user123",
      "data": {
        "phone_number": "254712345678"
      }
    }),
});
const data = await response.json();

Response

200400

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

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

Withdrawal information

GEThttps://<domain>/Remotes/withdrawal-info

Authorization

apikey

Query parameters

Response

200400

OK

Body

application/json

one of

SuccessError

Request

JavaScriptCurlPython

const response = await fetch('https://<domain>/Remotes/withdrawal-info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "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
}

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"
}