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

Query parameters

project_idnumberrequired

Project ID in the A-Pay system

Example: 123

Body

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, imps_top, upi_link, upi_push, phonepe_fast, upi_fast_vip, imps
BDT	nagad_api_v, bkash_a, apaybdt, upay, bkash_b, nagad_a, nagad_b
PKR	bankalfalah, easypaisa, jazzcash_l, nayapay_l, jazzcash_fast, pkr_w, jazzcash
KES	mpesa
UZS	payme
MMK	wavepay_l
TND	d17_l, flouci
BRL	pix_p2p
MXN	spei_p2p
KHR	wing_l, ababank
NPR	esewa, khalti
LKR	ipay_l
ETB	etb_fast

Example: INR

Available options:

payment_systemstring · enumrequired

Name of the payment system in A-Pay

Example: mpesa

Available options:

custom_transaction_idstring · max: 200optional

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

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

Easypaisa data

Nagad API V

BankAlfalah data

UPI Fast data (empty)

For example: "data": {}

Currency: INR

UPI Fast V data (empty)

For example: "data": {}

Currency: INR

Deposit activation is optional

UPI-p2p data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

UPI Fast QR data (empty)

For example: "data": {}

Currency: INR

PayTM data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

PhonePe data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

ApayBDT data

UPAY data

Payme data

Upi-a data

Deposit activation is optional

UPI Link data (empty)

For example: "data": {}

Currency: INR

Nagad A

Nagad B

Easypaisa-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

UPI Push data

Jazzcash-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

Wavepay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: MMK

D17-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: TND

Pix-p2p data (empty)

For example: "data": {}

Currency: BRL

Spei-p2p data (empty)

For example: "data": {}

Currency: MXN

Phonepe_fast data (empty)

For example: "data": {}

Currency: INR

UPI Fast VIP data (empty)

For example: "data": {}

Currency: INR

Wing-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: KHR

Esewa data

Khalti data

Nayapay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: PKR

Ababank data (empty)

For example: "data": {}

Currency: KHR

Jazzcash fast data

Flouci data

Ipay-l data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: LKR

Imps data (empty)

This deposit requires activation Deposit activation

For example: "data": {}

Currency: INR

Jazzcash data

Etd Fast Data

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<domain>/Remotes/create-deposit?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

200

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

OK

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