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

apikey

apikeystringRequired

Query parameters

project_idnumberRequired

Project ID in the A-Pay system

Example: 123

Body

application/json

amountintegerRequired

Deposit amount

Example: 10

currencystring · enumRequired

Currency	Payment systems
INR	upi_fast, upi_fast_v, upi_fast_qr, upi_p2p, upi_a, paytm, phonepe, imps, upi_link, upi_push, phonepe_fast, upi_fast_vip, inr_p2p, inr_p2c
BDT	nagad_api_v, bkash_api_v, bkash_a, apaybdt, upay, bkash_b, nagad_a, nagad_b, bkash_p2p, tap_p2p
PKR	bankalfalah, easypaisa, jazzcash_l, nayapay_l, jazzcash_fast, jazzcash, pkr_w2
KES	mpesa
MMK	wavepay_l, kbzpay_p2p
TND	d17_l, flouci, flouci_l
BRL	pix_p2p
MXN	spei_p2p
KHR	wing_l, ababank
NPR	esewa, khalti, khalti_l, imepay_l, esewa_p2p
LKR	ipay_l, ipay_fast
ETB	etb_fast, etb_p2p
ARS	cvu_p2p
JMD	scotiabank_p2p, lynk_p2p
EGP	egp_tel, egp_card, egp_tel_fast, egp_fast
PEN	yape_pen_p2p
PYG	bancard_qr

Example: KESPossible values:

payment_systemstring · enumRequired

Name of the payment system in A-Pay

Example: mpesaPossible 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

dataone ofRequired

Data depending on the specific payment system

or

or

or

or

object · upi_fastOptional

UPI Fast data (empty)

For example: "data": {}

Currency: INR

or

object · upi_fast_vOptional

UPI Fast V data (empty)

For example: "data": {}

Currency: INR

or

or

object · upi_p2pOptional

UPI-p2p data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

or

object · upi_fast_qrOptional

UPI Fast QR data (empty)

For example: "data": {}

Currency: INR

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

or

or

or

or

object · upi_linkOptional

UPI Link data (empty)

For example: "data": {}

Currency: INR

or

or

or

object · easypaisa_lOptional

Easypaisa-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

or

or

object · jazzcash_lOptional

Jazzcash-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

or

object · wavepay_lOptional

Wavepay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: MMK

or

object · d17_lOptional

D17-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: TND

or

object · pix_p2pOptional

Pix-p2p data (empty)

For example: "data": {}

Currency: BRL

or

object · spei_p2pOptional

Spei-p2p data (empty)

For example: "data": {}

Currency: MXN

or

object · phonepe_fastOptional

Phonepe_fast data (empty)

For example: "data": {}

Currency: INR

or

object · upi_fast_vipOptional

UPI Fast VIP data (empty)

For example: "data": {}

Currency: INR

or

object · wing_lOptional

Wing-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: KHR

or

or

or

object · nayapay_lOptional

Nayapay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

or

object · ababankOptional

Ababank data (empty)

For example: "data": {}

Currency: KHR

or

or

or

object · ipay_lOptional

Ipay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: LKR

or

object · impsOptional

Imps data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

or

or

or

object · flouci_lOptional

Flouci-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: TND

or

or

object · imepay_lOptional

ImePay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: NPR

or

object · khalti_lOptional

Khalti-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: NPR

or

object · bkash_p2pOptional

Bkash P2P data (empty)

For example: "data": {}

Currency: BDT

or

or

object · scotiabank_p2pOptional

Scotiabank data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: JMD

or

or

or

or

object · bancard_qrOptional

Bancard QR data (empty)

For example: "data": {}

Currency: PYG

or

object · inr_p2pOptional

INR-p2p 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

or

object · kbzpay_p2pOptional

KBZpay P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: ММК

or

object · etb_p2pOptional

ETB P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: ETB

or

object · lynk_p2pOptional

Lynk P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: JMD

or

object · yape_pen_p2pOptional

Yape Pen P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PEN

or

or

object · tap_p2pOptional

TAP-p2p data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: BDT

or

object · esewa_p2pOptional

eSewa P2P data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: NPR

Responses

200

OK

application/json

Responseone of

or

400

Error

application/json

post

/Remotes/create-deposit

HTTPcURLJavaScriptPython

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

{
  "amount": 10,
  "currency": "KES",
  "payment_system": "mpesa",
  "custom_transaction_id": "custom123",
  "custom_user_id": "user123",
  "webhook_id": 42798,
  "data": {
    "phone_number": "254712345678"
  }
}

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

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 here

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 here in the response section. In this case, it is a link to the deposit payment

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

Examples of the responses:

Success

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

Error

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