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

post

/Remotes/deposit-activate

Authorizations

Query parameters

project_idnumberrequired

Project ID in the A-Pay system

Example: 123

order_idstringrequired

Deposit ID in the A-Pay system

Example: 7fa13dbc3b79e05e

Body

payment_systemstring · enumrequired

Name of the payment system in A-Pay

Example: nagad

Options: upi_p2p, bkash_a, bkash_b, payme, paytm, phonepe, easypaisa_l, jazzcash_l, wavepay_l, d17_l, wing_l, nayapay_l

dataone ofrequired

Data depending on the specific payment system

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<domain>/Remotes/deposit-activate?project_id=1&order_id=text' \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"payment_system":"nagad","data":{}}'

200

400

200

{
  "success": true,
  "order_id": "7fa13dbc3b79e05e",
  "message": "Transaction was already activated",
  "code": 201,
  "data": {
    "verify_otp": true,
    "require_new_otp": false
  }
}

OK

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