Request to create a deposit

Request to create a deposit

This section provides information on the most popular request - deposit creation request.

Request to create a deposit

post

Deposit creation.

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

Authorizations
apikeystringRequired
Query parameters
project_idnumberRequired

Project ID in the A-Pay system

Example: 1234567
Body
amountone ofRequired

Deposit 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
CurrencyPayment systemsDecimal places
ARScvu_fast_p2p, cvu_p2p0
BDTapaybdt, bkash_a, bkash_api_v, bkash_b, bkash_p2p, nagad_a, nagad_api_v, nagad_b, nagad_p2p, tap_p2p, upay0
BHDstcpay_p2p3 e.g. 0.001
BOBveripagos_fast, yape_bob_p2p0
BRLpix_p2p0
EGPegp_card, egp_fast, egp_tel, egp_tel_fast0
ETBetb_fast, etb_p2p0
GNForange_gin_p2p0
INRimps, 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_push0
JMDlynk_p2p, scotiabank_p2p0
KESmpesa0
KHRababank, wing_l0
LKRipay_fast, ipay_l, paygo_p2p0
MMKkbzpay_p2p, wavepay_l0
MXNspei_p2p0
NPResewa, esewa_p2p, imepay_l, khalti, khalti_l0
PENyape_pen_p2p0
PKRbankalfalah, easypaisa, easypaisa_l, jazzcash, jazzcash_fast, jazzcash_l, nayapay_l, raast_p2p0
PYGbancard_qr, itau_p2p0
TNDd17_l, flouci, flouci_l0
USDbanistmo_p2p, bcgeneral_p2p, yappy_p2p2 e.g. 0.01
UYUbrou_p2p0
XOFmoov_mli_p2p, orange_mli_p2p, orange_sen_p2p, wave_mli_p2p, wave_sen_p2p0
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

object · ababankOptional

Ababank data (empty)

For example: "data": {}

Currency: KHR

or
or
object · bancard_qrOptional

Bancard QR data (empty)

For example: "data": {}

Currency: PYG

or
object · banistmo_p2pOptional

Banistmo P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: USD

or
or
object · bcgeneral_p2pOptional

Bcgeneral P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: USD

or
or
or
or
object · bkash_p2pOptional

Bkash P2P data (empty)

For example: "data": {}

Currency: BDT

or
object · brou_p2pOptional

BROU P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: UYU

or
object · cvu_fast_p2pOptional

CVU Fast P2P data (empty)

For example: "data": {}

Currency: ARS

or
or
object · d17_lOptional

D17-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: TND

or
or
object · easypaisa_lOptional

Easypaisa-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

or
or
or
or
or
or
object · esewa_p2pOptional

eSewa P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: NPR

or
or
object · etb_p2pOptional

ETB P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: ETB

or
or
object · flouci_lOptional

Flouci-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: TND

or
object · imepay_lOptional

ImePay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: NPR

or
object · impsOptional

Imps data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

or
object · inr_p2cOptional

INR-p2c data (empty)

For example: "data": {}

Currency: INR

or
object · inr_p2pOptional

INR-p2p data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

or
or
object · ipay_lOptional

Ipay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: LKR

or
object · itau_p2pOptional

itau-p2p data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PYG

or
or
or
object · jazzcash_lOptional

Jazzcash-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

or
object · kbzpay_p2pOptional

KBZpay P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: ММК

or
or
object · khalti_lOptional

Khalti-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: NPR

or
object · lynk_p2pOptional

Lynk P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: JMD

or
or
or
or
or
or
or
object · nayapay_lOptional

Nayapay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

or
or
or
or
object · paygo_p2pOptional

Pay&Go P2P data (empty)

For example: "data": {}

Currency: LKR

or
object · paytmOptional

PayTM data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

or
object · phonepeOptional

PhonePe data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

or
object · phonepe_fastOptional

Phonepe_fast data (empty)

For example: "data": {}

Currency: INR

or
object · pix_p2pOptional

Pix-p2p data (empty)

For example: "data": {}

Currency: BRL

or
or
object · scotiabank_p2pOptional

Scotiabank data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: JMD

or
object · spei_p2pOptional

Spei-p2p data (empty)

For example: "data": {}

Currency: MXN

or
or
object · tap_p2pOptional

TAP-p2p data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: BDT

or
or
or
object · upi_fastOptional

UPI Fast data (empty)

For example: "data": {}

Currency: INR

or
object · upi_fast_qrOptional

UPI Fast QR data (empty)

For example: "data": {}

Currency: INR

or
object · upi_fast_vOptional

UPI Fast V data (empty)

For example: "data": {}

Currency: INR

or
object · upi_fast_vipOptional

UPI Fast VIP data (empty)

For example: "data": {}

Currency: INR

or
object · upi_linkOptional

UPI Link data (empty)

For example: "data": {}

Currency: INR

or
object · upi_p2pOptional

UPI-p2p data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

or
or
object · veripagos_fastOptional

Veripagos Fast data (empty)

For example: "data": {}

Currency: BOB

or
or
or
object · wavepay_lOptional

Wavepay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: MMK

or
object · wing_lOptional

Wing-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: KHR

or
object · yape_bob_p2pOptional

Yape Bob P2P data (empty)

For example: "data": {}

Currency: BOB

or
object · yape_pen_p2pOptional

Yape Pen P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PEN

or
object · yappy_p2pOptional

Yappy P2P data (empty)

For example: "data": {}

Currency: USD

Responses
chevron-right
200

OK

application/json
or
post
/Remotes/create-deposit

In order for the request to be created correctly, it is necessary to comply with the documentation requirements: all required fields must be present in the request, and field validation must be observed.

In a deposit request, the client must send the following information:

  • project_id - project id in the A-pay platform, the parameter can be found in the projects table next to the project name.

  • amount - deposit amount in integer

  • currency - currency of the payment system

  • payment_system - name of the payment system from A-pay platform

  • custom_transaction_id - unique transaction identifier in the client's system

  • custom_user_id - unique user identifier in the client's system

  • data - additional data depending on the PS. To find out what data should be sent, you should click on data and select the necessary PS. These data will be specified herearrow-up-right

circle-info

Each payment system requires certain information to be sent. Please read our API carefully!

Responses

Below is information about our server's responses to such requests, as well as the data that our server sends to the client in response. The response can be both successful and unsuccessful.

Our server sends the following data to the client in the request:

  • success - a parameter that is responsible for whether the response is successful or not

  • status - status of the deposit creation

  • order_id - our internal unique order, which is assigned to each transaction

  • data - additional data that depends on the PS. To find out what data should be sent, you need to click on data and select the desired PS. This data will be spelled out herearrow-up-right in the response section. In this case, it is a link to the deposit payment

circle-info

Each payment system returns different information to the client. Please read our API carefully!

Examples of the responses:

Last updated