📤Withdrawal

Sequence diagram of the Withdrawal via API integration

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

post

Withdrawal creation.

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

Authorizations

apikey

apikeystringRequired

Query parameters

project_idnumberRequired

Project ID in the A-Pay system

Example: 1234567

Body

application/json

amountone ofRequired

Withdrawal amount

Payment systems support different amount formats. integer or number

Example: 10

integer · enumOptional

Currencies that accept integer type

Possible values:

or

number · enumOptional

Currencies that accept number type

Possible values:

currencystring · enumRequired

Payment system currency

Currency	Payment systems	Decimal places
ARS	cvu_p2p, mercado_ars_p2p	0
BDT	apaybdt, bkash_a, bkash_api_v, bkash_b, bkash_p2p, nagad_a, nagad_api_v, nagad_b, tap_p2p, upay, upay_w	0
BHD	stcpay_p2p	3 e.g. 0.001
BOB	veripagos_fast, yape_bob_p2p	0
BRL	pix_p2p	0
EGP	egp_card, egp_fast, egp_tel	0
ETB	cbebirr_p2p, etb_fast, etb_p2p	0
GNF	orange_gin_p2p	0
INR	imps, imps_top, inr_p2c, inr_p2p, paytm, phonepe, phonepe_fast, upi_a, upi_fast, upi_fast_qr, upi_fast_v, upi_fast_vip, upi_link, upi_p2p, upi_push	0
JMD	lynk_p2p, scotiabank_p2p	0
KES	mpesa	0
KHR	ababank, wing_l	0
LKR	ipay_fast, ipay_l	0
MMK	kbzpay_p2p, wavepay_l	0
MXN	spei_p2p	0
NPR	esewa, esewa_p2p, imepay_l, khalti, khalti_l	0
PEN	yape_pen_p2p	0
PKR	bankalfalah, easypaisa, jazzcash, jazzcash_l, nayapay_l, pkr_w, pkr_w2, raast_p2p	0
PYG	bancard_qr, itau_p2p	0
TND	d17_l, flouci, flouci_l	0
USD	banistmo_p2p, bcgeneral_p2p, yappy_p2p	2 e.g. 0.01
UYU	brou_p2p, mercado_uyu_p2c	0
XOF	moov_mli_p2p, orange_mli_p2p, orange_sen_p2p, wave_mli_p2p, wave_sen_p2p	0

Example: BDTPossible values:

payment_systemstring · enumRequired

Name of the payment system in A-Pay

Example: bkash_bPossible values:

custom_transaction_idstring · max: 200Optional

Transaction ID in the client's system. Must be unique. Optional

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: 7Optional

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

Example: 42798

dataany ofRequired

Data depending on the specific payment system

or

or

or

or

or

or

or

or

or

or

or

object · cbebirr_p2pOptional

Cbebirr P2P Withdrawal Data

or

or

or

or

or

object · egp_cardOptional

Egp-Card Withdrawal data

or

or

or

or

or

object · esewa_p2pOptional

eSewa P2P Withdrawal Data

or

or

or

or

or

or

or

or

or

or

object · ipay_fastOptional

Ipay Fast Withdrawal data

or

or

object · ipay_lOptional

Ipay L Withdrawal data

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

200

OK

application/json

or

400

Error

application/json

post

/Remotes/create-withdrawal

HTTPcURLJavaScriptPython

POST /Remotes/create-withdrawal?project_id=1 HTTP/1.1
Host: <domain>
apikey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "amount": 10,
  "currency": "BDT",
  "payment_system": "bkash_b",
  "custom_transaction_id": "custom123",
  "custom_user_id": "user123",
  "webhook_id": 42798,
  "data": {
    "": null,
    "account_name": "John Doe",
    "account_number": 123456789,
    "bank_name": "Bank"
  }
}

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

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

get

order_id or/and custom_transaction_id parameters must be set.

Authorizations

apikey

apikeystringRequired

Query parameters

project_idnumberRequired

Project ID in the A-Pay system

Example: 1234567

order_idstring · min: 16 · max: 16Optional

Withdrawal ID in the A-Pay system

Example: 7fa13dbc3b79e05ePattern: ^[0-9a-f]{16}$

custom_transaction_idstring · max: 200Optional

Transaction ID in the client's system

Responses

200

OK

application/json

or

400

Error

application/json

get

/Remotes/withdrawal-info

HTTPcURLJavaScriptPython

GET /Remotes/withdrawal-info?project_id=1 HTTP/1.1
Host: <domain>
apikey: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "status": "Success",
  "order_id": "7fa13dbc3b79e05e",
  "amount": 10,
  "currency": "BDT",
  "payment_system": "bkash_b",
  "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"
}