A-pay Documentation
  • Documentation
    • โ‡๏ธAbout A-pay Platform
    • ๐Ÿ’ตSupported currencies
  • API Documentation
    • ๐Ÿš€Start Integration
    • ๐ŸˆGetting data about PS
    • ๐Ÿ“ƒPayment Page Integration
      • Payment Gateway
    • ๐Ÿ–ฅ๏ธAPI Integration
      • ๐Ÿ’ฐDeposit
        • Request to create a deposit
        • Deposit Activation
        • Deposit resend OTP
        • Deposit information
      • ๐Ÿ“คWithdrawal
      • ๐Ÿ”Lost transaction
        • Create lost transaction
        • Lost transaction information
    • ๐Ÿ”™Postback
    • ๐Ÿ“ˆSettlement
    • โ—Errors
  • ๐Ÿ‘จโ€๐Ÿ’ปOpenAPI Docs
Powered by GitBook
On this page
  1. API Documentation
  2. API Integration
  3. Deposit

Deposit information

PreviousDeposit resend OTPNextWithdrawal

Last updated 20 days ago

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
}
๐Ÿ–ฅ๏ธ
๐Ÿ’ฐ

Deposit information

get

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

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
200
OK
application/json
Responseone of
or
400
Error
application/json
get
GET /Remotes/deposit-info?project_id=1&order_id=text 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
}