# Deposit information

## Deposit information

> \`order\_id\` or/and \`custom\_transaction\_id\` parameters must be set.

```json
{"openapi":"3.0.3","info":{"title":"A-Pay","version":"0.0.5"},"tags":[{"name":"Deposit","description":"Deposits"}],"servers":[{"url":"https://<domain>"}],"security":[{"apikey":[]}],"components":{"securitySchemes":{"apikey":{"type":"apiKey","name":"apikey","in":"header"}},"schemas":{"deposit_currency":{"type":"string","title":"Currency","enum":["INR","BDT","PKR","KES","MMK","TND","BRL","MXN","KHR","NPR","LKR","ETB","ARS","JMD","EGP","PEN","PYG","UYU","XOF","GNF","BOB","BHD","USD"],"description":"<details>\n  <summary>Payment system currency</summary>\n  \n  | Currency | Payment systems | Decimal places |\n  |----------|-----------------|----------------|\n  | INR | `upi_fast`, `upi_fast_v`, `upi_fast_qr`, `upi_p2p`, `upi_a`, `paytm`, `phonepe`, `imps`, `upi_link`, `upi_push`, `phonepe_fast`, `upi_fast_vip`, `inr_p2p`, `inr_p2c` |  `0` |\n  | BDT | `nagad_api_v`, `bkash_api_v`, `bkash_a`, `apaybdt`, `upay`, `bkash_b`, `nagad_a`, `nagad_b`, `bkash_p2p`, `tap_p2p`, `nagad_p2p` | `0` |\n  | PKR | `bankalfalah`, `easypaisa`, `jazzcash_l`, `nayapay_l`, `jazzcash_fast`, `jazzcash`, `pkr_w2`, `raast_p2p` | `0` |\n  | KES | `mpesa` | `0` |\n  | MMK | `wavepay_l`, `kbzpay_p2p` | `0` |\n  | TND | `d17_l`, `flouci`, `flouci_l` | `0` |\n  | BRL | `pix_p2p` | `0` |\n  | MXN | `spei_p2p` | `0` |\n  | KHR | `wing_l`, `ababank` | `0` |\n  | NPR | `esewa`, `khalti`, `khalti_l`, `imepay_l`, `esewa_p2p` | `0` |\n  | LKR | `ipay_l`, `ipay_fast`, `paygo_p2p ` | `0` |\n  | ETB | `etb_fast`, `etb_p2p` | `0` |\n  | ARS | `cvu_p2p`, `cvu_fast_p2p` | `0` |\n  | JMD | `scotiabank_p2p`, `lynk_p2p` | `0` |\n  | EGP | `egp_tel`, `egp_card`, `egp_tel_fast`, `egp_fast`| `0` |\n  | PEN | `yape_pen_p2p` | `0` |\n  | PYG | `bancard_qr`, `itau_p2p` | `0` |\n  | UYU | `brou_p2p` | `0` |\n  | PYG | `bancard_qr` | `0` |\n  | BOB | `yape_bob_p2p`, `veripagos_fast` | `0` |\n  | XOF | `orange_sen_p2p`, `orange_mli_p2p`, `wave_sen_p2p`, `wave_mli_p2p` | `0` |\n  | GNF | `orange_gin_p2p` | `0` |\n  | BHD | `stcpay_p2p` | `0` |\n  | USD | `banistmo_p2p`, `yappy_p2p` | `2` e.g. 0.01 |\n</details>"},"ps_deposit":{"type":"string","title":"Payment system","enum":["mpesa","easypaisa","bankalfalah","upi_fast","upi_fast_v","upi_fast_qr","upi_p2p","upi_a","bkash_a","apaybdt","upay","nagad_api_v","bkash_api_v","paytm","phonepe","bkash_b","upi_link","nagad_a","nagad_b","easypaisa_l","upi_push","jazzcash_l","wavepay_l","d17_l","pix_p2p","spei_p2p","phonepe_fast","upi_fast_vip","wing_l","esewa","khalti","nayapay_l","ababank","jazzcash_fast","flouci","ipay_l","imps","jazzcash","etb_fast","flouci_l","khalti_l","imepay_l","bkash_p2p","cvu_p2p","scotiabank_p2p","egp_tel","egp_card","ipay_fast","inr_p2p","inr_p2c","egp_tel_fast","kbzpay_p2p","etb_p2p","lynk_p2p","yape_pen_p2p","bancard_qr","egp_fast","yape_bob_p2p","tap_p2p","esewa_p2p","brou_p2p","itau_p2p","raast_p2p","orange_sen_p2p","orange_gin_p2p","orange_mli_p2p","wave_sen_p2p","wave_mli_p2p","nagad_p2p","paygo_p2p","veripagos_fast","stcpay_p2p","banistmo_p2p","yappy_p2p","cvu_fast_p2p"],"description":"Name of the payment system in A-Pay"}}},"paths":{"/Remotes/deposit-info":{"get":{"tags":["Deposit"],"summary":"Deposit information","description":"`order_id` or/and `custom_transaction_id` parameters must be set.","parameters":[{"in":"query","name":"project_id","schema":{"type":"number"},"description":"Project ID in the A-Pay system","required":true},{"in":"query","name":"order_id","schema":{"type":"string","minimum":16,"maximum":16,"pattern":"^[0-9a-f]{16}$"},"description":"Deposit ID in the A-Pay system"},{"in":"query","name":"custom_transaction_id","schema":{"type":"string","maximum":200},"description":"Transaction ID in the client's system"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"title":"Success","required":["success","status","order_id","amount","currency","payment_system","custom_user_id","created_at"],"properties":{"success":{"type":"boolean","description":"`true` if there are no errors"},"status":{"type":"string","enum":["Pending","Success","Failed","Rejected"],"description":"Deposit status"},"order_id":{"type":"string","description":"Deposit ID in the A-Pay system"},"amount":{"type":"number","description":"Deposit amount"},"currency":{"$ref":"#/components/schemas/deposit_currency"},"payment_system":{"$ref":"#/components/schemas/ps_deposit"},"custom_transaction_id":{"type":"string","minimum":0,"maximum":200,"description":"Transaction ID in the client's system"},"custom_user_id":{"type":"string","minimum":0,"maximum":200,"description":"User ID in the client's system"},"created_at":{"type":"integer","description":"Deposit creation time in timestamp format"}}},{"title":"Error","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"type":"string","description":"Description of error"},"code":{"type":"number","description":"Error code in the A-pay system"}}}]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"title":"Error","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"type":"string","description":"Description of error"},"code":{"type":"number","description":"Error code in the A-pay system"}}}}}}}}}}}
```

**Example of the responses:**

{% code title="Success" %}

```json
{
  "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
}
```

{% endcode %}

{% code title="Error" %}

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

{% endcode %}