Deposit information

Deposit information

get

order_id or/and custom_transaction_id parameters must be set.

Authorizations
Query parameters
project_idnumberRequired

Project ID in the A-Pay system

Example: 123
order_idstring · min: 16 · max: 16Optional

Deposit ID in the A-Pay system

Example: 7fa13dbc3b79e05ePattern: ^[0-9a-f]{16}$
custom_transaction_idstring · max: 200Optional

Transaction ID in the client's system

Responses
200

OK

application/json
Responseone of
or
get
GET /Remotes/deposit-info?project_id=1 HTTP/1.1
Host: <domain>
apikey: YOUR_API_KEY
Accept: */*
{
  "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
}

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
}

Last updated