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

Deposit creation.

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

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

Authorization

apikey

Query parameters

Body

application/json

amount*integer

Deposit amount

Example: 10

currency*Currency

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
BDT	nagad_api_v, bkash_a, apaybdt, upay, bkash_b, nagad_a, nagad_b
PKR	bankalfalah, easypaisa, jazzcash_l, nayapay_l, jazzcash_fast, jazzcash_w
KES	mpesa
UZS	payme
MMK	wavepay_l
TND	d17_l, flouci
BRL	pix_p2p
MXN	spei_p2p
KHR	wing_l, ababank
NPR	esewa, khalti

Example: "INR"

INRBDTPKRKESUZSMMKTNDBRLMXNKHRNPR

payment_system*Payment system

Name of the payment system in A-Pay

Example: "mpesa"

mpesaeasypaisabankalfalahupi_fastupi_fast_vupi_fast_qrupi_p2pupi_abkash_aapaybdtupaynagad_api_vpaymepaytmphonepebkash_bupi_linknagad_anagad_beasypaisa_lupi_pushjazzcash_lwavepay_ld17_lpix_p2pspei_p2pphonepe_fastupi_fast_vipwing_lesewakhaltinayapay_lababankjazzcash_fastflouci

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

mpesaeasypaisanagad_api_vbankalfalahupi_fastupi_fast_vbkash_aupi_p2pupi_fast_qrpaytmphonepeapaybdtupaypaymeupi_abkash_bupi_linknagad_anagad_beasypaisa_lupi_pushjazzcash_lwavepay_ld17_lpix_p2pspei_p2pphonepe_fastupi_fast_vipwing_lesewakhaltinayapay_lababankjazzcash_fastflouci

Response

200400

OK

Body

application/json

one of

SuccessError

Request

JavaScriptCurlPython

const response = await fetch('https://<domain>/Remotes/create-deposit?project_id=0', {
    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",
  "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, 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 payment system

• payment_system - name of 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 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"
}