Deposit Activation

Some payment systems also provide activation of deposits. In simple words, 2 more actions are added to the request processing.

Deposit activation

For payment system that require payment activation

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

Authorization

apikey

Query parameters

Body

application/json

payment_system*enum

Name of the payment system in A-Pay

Example: "nagad"

upi_p2pbkash_abkash_bpaymepaytmphonepeeasypaisa_ljazzcash_lwavepay_l

data*one of

Data depending on the specific payment system

bkash_aupi_p2ppaytmphonepepaymebkash_beasypaisa_ljazzcash_lwavepay_l

Response

200400

OK

Body

application/json

one of

SuccessError

Request

JavaScriptCurlPython

const response = await fetch('https://<domain>/Remotes/deposit-activate?project_id=0&order_id=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "payment_system": "nagad",
      "data": {}
    }),
});
const data = await response.json();

Response

200400

{
  "success": true,
  "order_id": "7fa13dbc3b79e05e",
  "data": {
    "verify_otp": true,
    "require_new_otp": false
  }
}

A perfect example of a payment system that provides for activation is upi_p2p. Let's analyze an example of request processing and activation:

1. We see that activation is required for this PS in Request to create a deposit.

2. Here we can see that in this PS A-pay sends the UPI address parameter to the client after processing the request. In this case, it means that A-pay sends the address to which the user needs to transfer money in Responses.

3. After the user has transferred money, he must activate his deposit. It transmits the necessary information to the client server. For upi_p2p this is the Transaction ID (UTR). The client server sends to A-pay an activation request, in which certain data is transmitted. After that, A-pay processes the activation request and responds to the client with success or failure, depending on the situation.

Examples of the responses:

Success

{
  "success": true,
  "order_id": "7fa13dbc3b79e05e",
  "data": {
    "verify_otp": true,
    "require_new_otp": false
  }
}

Error

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