Deposit information

Deposit information

The data are taken from the table deposit by order_id field based on the selected project from the table project

get

/Remotes/deposit-info

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<domain>/Remotes/deposit-info?project_id=1&order_id=text' \
  --header 'apikey: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "order_id": "7fa13dbc3b79e05e",
  "amount": 10,
  "currency": "INR",
  "payment_system": "mpesa",
  "custom_transaction_id": "custom123",
  "custom_user_id": "user123",
  "created_at": 1665135515,
  "status": "Success"
}

OK

Example of the responses:

Success

{
  "success": true,
  "status": "Success",
  "order_id": "7fa13dbc3b79e05e",
  "amount": 10,
  "currency": "INR",
  "payment_system": "mpesa",
  "custom_transaction_id": "custom123",
  "custom_user_id": "user123",
  "created_at": 1665135515
}

Error

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