# Request to create a deposit ### Request to create a deposit This section provides information on the most popular request - deposit creation request. ## Request to create a deposit > Deposit creation.\ > \ > When the deposit is confirmed, a callback request will be sent to the client's application handler with the \[Deposit webhook]\(#operation/DepositWebhook) body ```json {"openapi":"3.0.3","info":{"title":"A-Pay","version":"1.0.0"},"tags":[{"name":"Deposit","description":"Deposits"}],"servers":[{"url":"https://"}],"security":[{"apikey":[]}],"components":{"securitySchemes":{"apikey":{"type":"apiKey","name":"apikey","in":"header"}},"schemas":{"deposit_currency":{"type":"string","title":"Currency","enum":["ARS","BDT","BHD","BOB","BRL","EGP","ETB","GNF","INR","JMD","KES","KHR","LKR","MMK","MXN","NPR","PEN","PKR","PYG","TND","USD","UYU","XOF"],"description":"
\n Payment system currency\n \n | Currency | Payment systems | Decimal places |\n |----------|-----------------|----------------|\n | ARS | `cvu_fast_p2p`, `cvu_p2p` | `0` |\n | BDT | `apaybdt`, `bkash_a`, `bkash_api_v`, `bkash_b`, `bkash_p2p`, `nagad_a`, `nagad_api_v`, `nagad_b`, `nagad_p2p`, `tap_p2p`, `upay` | `0` |\n | BHD | `stcpay_p2p` | `3` e.g. 0.001 |\n | BOB | `veripagos_fast`, `yape_bob_p2p` | `0` |\n | BRL | `pix_p2p` | `0` |\n | EGP | `egp_card`, `egp_fast`, `egp_tel`, `egp_tel_fast` | `0` |\n | ETB | `etb_fast`, `etb_p2p` | `0` |\n | GNF | `orange_gin_p2p` | `0` |\n | INR | `imps`, `inr_p2c`, `inr_p2p`, `paytm`, `phonepe`, `phonepe_fast`, `upi_a`, `upi_fast`, `upi_fast_qr`, `upi_fast_v`, `upi_fast_vip`, `upi_link`, `upi_p2p`, `upi_push` | `0` |\n | JMD | `lynk_p2p`, `scotiabank_p2p` | `0` |\n | KES | `mpesa` | `0` |\n | KHR | `ababank`, `wing_l` | `0` |\n | LKR | `ipay_fast`, `ipay_l`, `paygo_p2p` | `0` |\n | MMK | `kbzpay_p2p`, `wavepay_l` | `0` |\n | MXN | `spei_p2p` | `0` |\n | NPR | `esewa`, `esewa_p2p`, `imepay_l`, `khalti`, `khalti_l` | `0` |\n | PEN | `yape_pen_p2p` | `0` |\n | PKR | `bankalfalah`, `easypaisa`, `easypaisa_l`, `jazzcash`, `jazzcash_fast`, `jazzcash_l`, `nayapay_l`, `raast_p2p` | `0` |\n | PYG | `bancard_qr`, `itau_p2p` | `0` |\n | TND | `d17_l`, `flouci`, `flouci_l` | `0` |\n | USD | `banistmo_p2p`, `bcgeneral_p2p`, `yappy_p2p` | `2` e.g. 0.01 |\n | UYU | `brou_p2p` | `0` |\n | XOF | `moov_mli_p2p`, `orange_mli_p2p`, `orange_sen_p2p`, `wave_mli_p2p`, `wave_sen_p2p` | `0` |\n
"},"ps_deposit":{"type":"string","title":"Payment system","enum":["ababank","apaybdt","bancard_qr","banistmo_p2p","bankalfalah","bcgeneral_p2p","bkash_a","bkash_api_v","bkash_b","bkash_p2p","brou_p2p","cvu_fast_p2p","cvu_p2p","d17_l","easypaisa","easypaisa_l","egp_card","egp_fast","egp_tel","egp_tel_fast","esewa","esewa_p2p","etb_fast","etb_p2p","flouci","flouci_l","imepay_l","imps","inr_p2c","inr_p2p","ipay_fast","ipay_l","itau_p2p","jazzcash","jazzcash_fast","jazzcash_l","kbzpay_p2p","khalti","khalti_l","lynk_p2p","moov_mli_p2p","mpesa","nagad_a","nagad_api_v","nagad_b","nagad_p2p","nayapay_l","orange_gin_p2p","orange_mli_p2p","orange_sen_p2p","paygo_p2p","paytm","phonepe","phonepe_fast","pix_p2p","raast_p2p","scotiabank_p2p","spei_p2p","stcpay_p2p","tap_p2p","upay","upi_a","upi_fast","upi_fast_qr","upi_fast_v","upi_fast_vip","upi_link","upi_p2p","upi_push","veripagos_fast","wave_mli_p2p","wave_sen_p2p","wavepay_l","wing_l","yape_bob_p2p","yape_pen_p2p","yappy_p2p"],"description":"Name of the payment system in A-Pay"},"errors":{"oneOf":[{"type":"string","default":"limit of failed requests exceeded","title":"Error: limit of Failed Requests Exceeded","description":"Deposits are blocked after some failed deposit attempts within the same hour, identified by `custom_user_id`"}]}}},"paths":{"/Remotes/create-deposit":{"post":{"tags":["Deposit"],"summary":"Request to create a deposit","description":"Deposit creation.\n\nWhen the deposit is confirmed, a callback request will be sent to the client's application handler with the [Deposit webhook](#operation/DepositWebhook) body","parameters":[{"in":"query","name":"project_id","schema":{"type":"number"},"description":"Project ID in the A-Pay system","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","currency","payment_system","custom_user_id","data"],"properties":{"amount":{"description":"Deposit amount\n\nPayment systems support different amount formats. `integer` or `number`\n","oneOf":[{"type":"integer","description":"Currencies that accept `integer` type","enum":["ARS","BDT","BHD","BOB","BRL","EGP","ETB","GNF","INR","JMD","KES","KHR","LKR","MMK","MXN","NPR","PEN","PKR","PYG","TND","USD","UYU","XOF"]},{"type":"number","description":"Currencies that accept `number` type","enum":["BHD","USD"]}]},"currency":{"$ref":"#/components/schemas/deposit_currency"},"payment_system":{"$ref":"#/components/schemas/ps_deposit"},"custom_transaction_id":{"type":"string","maximum":200,"description":"Transaction ID in the client's system. Must be unique. `Optional`"},"custom_user_id":{"type":"string","maximum":200,"description":"User ID in the client's system. Must be unique for each user"},"webhook_id":{"type":"string","minimum":7,"maximum":7,"description":"Id of a webhook that will be used to send a postback. If not filled then default webhook url will be used. `Optional`"},"data":{"description":"Data depending on the specific payment system","anyOf":[{"description":"Ababank data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `KHR`","title":"ababank","type":"object"},{"description":"ApayBDT data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"cancel_url":{"description":"Return link to the user's shop after the canceled payment","type":"string"},"customer_email":{"description":"Customer email","type":"string"},"customer_name":{"description":"Customer name","maximum":30,"type":"string"},"customer_phone":{"description":"Customer phone","maximum":15,"minimum":6,"pattern":"^[0-9]{6,15}$","type":"string"},"fail_url":{"description":"Return link to the user's shop after the failed payment","type":"string"},"success_url":{"description":"Return link to the user's shop after the successful payment","type":"string"}},"required":["success_url","cancel_url","fail_url","customer_name","customer_email","customer_phone"],"title":"apaybdt","type":"object"},{"description":"Bancard QR data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `PYG`","title":"bancard_qr","type":"object"},{"description":"Banistmo P2P data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `USD`","title":"banistmo_p2p","type":"object"},{"description":"BankAlfalah data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"bankalfalah","type":"object"},{"description":"Bcgeneral P2P data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `USD`","title":"bcgeneral_p2p","type":"object"},{"description":"[Deposit activation](#operation/DepositActivation) is optional","properties":{"":{"description":"[Deposit activation](#operation/DepositActivation) is optional.\n\nCurrency: `BDT`","type":"Description:"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["account_number","return_url"],"title":"bkash_a","type":"object"},{"description":"Currency: `BDT`","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_number":{"description":"User’s bKash account number from which the transfer will be made","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"}},"required":["account_number","return_url"],"title":"bkash_api_v","type":"object"},{"description":"[Deposit activation](#operation/DepositActivation) is optional","properties":{"":{"description":"[Deposit activation](#operation/DepositActivation) is optional.\n\nCurrency: `BDT`","type":"Description:"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["account_number","return_url"],"title":"bkash_b","type":"object"},{"description":"Bkash P2P data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `BDT`","title":"bkash_p2p","type":"object"},{"description":"BROU P2P data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `UYU`","title":"brou_p2p","type":"object"},{"description":"CVU Fast P2P data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `ARS`","title":"cvu_fast_p2p","type":"object"},{"description":"Cvu-p2p data","properties":{"":{"description":"Currency: `ARS`","type":"Description:"},"customer_name":{"description":"Customer name","maximum":50,"minimum":1,"pattern":"^(?=.{1,50}$)(?! )[A-Za-zÁÉÍÓÚÜáéíóúüÑñ'-]+(?: [A-Za-zÁÉÍÓÚÜáéíóúüÑñ'-]+)*$","type":"string"},"customer_surname":{"description":"Customer surname","maximum":50,"minimum":1,"pattern":"^(?=.{1,50}$)(?! )[A-Za-zÁÉÍÓÚÜáéíóúüÑñ'-]+(?: [A-Za-zÁÉÍÓÚÜáéíóúüÑñ'-]+)*$","type":"string"}},"required":["customer_name","customer_surname"],"title":"cvu_p2p","type":"object"},{"description":"D17-l data (empty)\n \nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n \nFor example: `\"data\": {}`\n \nCurrency: `TND`","title":"d17_l","type":"object"},{"description":"Easypaisa data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^03[0-9]{9}$","type":"string"}},"required":["account_number"],"title":"easypaisa","type":"object"},{"description":"Easypaisa-l data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `PKR`","title":"easypaisa_l","type":"object"},{"description":"Egp Card Data","properties":{"":{"description":"Currency: `EGP`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"egp_card","type":"object"},{"description":"Egp Fast Data","properties":{"":{"description":"Currency: `EGP`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"}},"required":["phone_number"],"title":"egp_fast","type":"object"},{"description":"Egp Tel Data","properties":{"":{"description":"Currency: `EGP`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"}},"required":["phone_number"],"title":"egp_tel","type":"object"},{"description":"Egp Tel Fast Data","properties":{"":{"description":"Currency: `EGP`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"egp_tel_fast","type":"object"},{"description":"Esewa data","properties":{"":{"description":"Currency: `NPR`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"esewa","type":"object"},{"description":"eSewa P2P data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `NPR`","title":"esewa_p2p","type":"object"},{"description":"Etd Fast Data","properties":{"":{"description":"Currency: `ETB`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"etb_fast","type":"object"},{"description":"ETB P2P data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `ETB`","title":"etb_p2p","type":"object"},{"description":"Flouci data","properties":{"":{"description":"Currency: `TND`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"flouci","type":"object"},{"description":"Flouci-l data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `TND`","title":"flouci_l","type":"object"},{"description":"ImePay-l data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `NPR`","title":"imepay_l","type":"object"},{"description":"Imps data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"imps","type":"object"},{"description":"INR-p2c data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"inr_p2c","type":"object"},{"description":"INR-p2p data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n \nCurrency: `INR`","title":"inr_p2p","type":"object"},{"description":"Ipay Fast Data","properties":{"":{"description":"Currency: `LKR`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"ipay_fast","type":"object"},{"description":"Ipay-l data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `LKR`","title":"ipay_l","type":"object"},{"description":"itau-p2p data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `PYG`","title":"itau_p2p","type":"object"},{"description":"Jazzcash data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_number":{"description":"Cnic number","maximum":13,"minimum":13,"pattern":"^[0-9]+$'","type":"string"},"phone_number":{"description":"Phone number","maximum":11,"minimum":11,"pattern":"^03[0-9]{9}$","type":"string"}},"required":["phone_number","account_number"],"title":"jazzcash","type":"object"},{"description":"Jazzcash fast data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^03[0-9]{9}$","type":"string"}},"required":["account_number"],"title":"jazzcash_fast","type":"object"},{"description":"Jazzcash-l data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `PKR`","title":"jazzcash_l","type":"object"},{"description":"KBZpay P2P data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `ММК`","title":"kbzpay_p2p","type":"object"},{"description":"Khalti data","properties":{"":{"description":"Currency: `NPR`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"khalti","type":"object"},{"description":"Khalti-l data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `NPR`","title":"khalti_l","type":"object"},{"description":"Lynk P2P data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `JMD`","title":"lynk_p2p","type":"object"},{"properties":{"":{"description":"Currency: `XOF`","type":"Description:"},"phone_number":{"description":"Customer phone number","maximum":11,"minimum":11,"pattern":"^223[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"moov_mli_p2p","type":"object"},{"properties":{"":{"description":"Currency: `KES`","type":"Description:"},"phone_number":{"description":"Phone number Safaricom for money sending. Should consist of 12 digits and start with 254","maximum":12,"minimum":12,"pattern":"^254[0-9]{9}$","type":"string"}},"required":["phone_number"],"summary":"Mpesa data","title":"mpesa","type":"object"},{"description":"Nagad A","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"nagad_a","type":"object"},{"description":"Nagad API V","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"}},"required":["account_number"],"title":"nagad_api_v","type":"object"},{"description":"Nagad B","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"nagad_b","type":"object"},{"description":"Currency: `BDT`","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_number":{"description":"User’s nagad account number from which the transfer will be made","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"}},"required":["account_number"],"title":"nagad_p2p","type":"object"},{"description":"Nayapay-l data (empty)\n \nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n \nFor example: `\"data\": {}`\n \nCurrency: `PKR`","title":"nayapay_l","type":"object"},{"properties":{"":{"description":"Currency: `GNF`","type":"Description:"},"phone_number":{"description":"Customer phone number","maximum":12,"minimum":12,"pattern":"^224[0-9]{9}$","type":"string"}},"required":["phone_number"],"title":"orange_gin_p2p","type":"object"},{"properties":{"":{"description":"Currency: `XOF`","type":"Description:"},"phone_number":{"description":"Customer phone number","maximum":11,"minimum":11,"pattern":"^223[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"orange_mli_p2p","type":"object"},{"properties":{"":{"description":"Currency: `XOF`","type":"Description:"},"phone_number":{"description":"Customer phone number","maximum":12,"minimum":12,"pattern":"^221[0-9]{9}$","type":"string"}},"required":["phone_number"],"title":"orange_sen_p2p","type":"object"},{"description":"Pay&Go P2P data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `LKR`","title":"paygo_p2p","type":"object"},{"description":"PayTM data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"paytm","type":"object"},{"description":"PhonePe data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"phonepe","type":"object"},{"description":"Phonepe_fast data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"phonepe_fast","type":"object"},{"description":"Pix-p2p data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `BRL`","title":"pix_p2p","type":"object"},{"description":"Raast P2P Data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"customer_name":{"description":"Customer full name (Exactly like user's Bank Account Title)","maximum":60,"minimum":3,"pattern":"^(?=(?:\\s*[A-Za-z]){3,60}\\s*$)\\s*[A-Za-z]+(?:\\s+[A-Za-z]+)*\\s*$","type":"string"}},"required":["customer_name"],"title":"raast_p2p","type":"object"},{"description":"Scotiabank data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `JMD`","title":"scotiabank_p2p","type":"object"},{"description":"Spei-p2p data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `MXN`","title":"spei_p2p","type":"object"},{"description":"Currency: `BHD`","properties":{"":{"description":"Currency: `BHD`","type":"Description:"},"phone_number":{"description":"Customer phone number","maximum":11,"minimum":11,"pattern":"^973[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"stcpay_p2p","type":"object"},{"description":"TAP-p2p data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `BDT`","title":"tap_p2p","type":"object"},{"description":"UPAY data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"return_url":{"description":"Return link to the user's shop after the payment page","type":"string"}},"required":["return_url"],"title":"upay","type":"object"},{"description":"Upi-a data","properties":{"":{"description":"Currency: `INR`","type":"Description:"},"email":{"description":"Customer email","maximum":100,"minimum":1,"type":"string"},"name":{"description":"Customer name","maximum":100,"minimum":1,"type":"string"},"phone_number":{"description":"Customer phone number","maximum":12,"minimum":10,"pattern":"^[0-9]{10,12}$","type":"string"}},"required":["name","email","phone_number"],"title":"upi_a","type":"object"},{"description":"UPI Fast data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"upi_fast","type":"object"},{"description":"UPI Fast QR data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"upi_fast_qr","type":"object"},{"description":"UPI Fast V data (empty)\n \nFor example: `\"data\": {}`\n \nCurrency: `INR`","title":"upi_fast_v","type":"object"},{"description":"UPI Fast VIP data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"upi_fast_vip","type":"object"},{"description":"UPI Link data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"upi_link","type":"object"},{"description":"UPI-p2p data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `INR`","title":"upi_p2p","type":"object"},{"description":"UPI Push data","properties":{"":{"description":"Currency: `INR`","type":"Description:"},"upi_address":{"description":"UPI address","type":"string"}},"required":["upi_address"],"title":"upi_push","type":"object"},{"description":"Veripagos Fast data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `BOB`","title":"veripagos_fast","type":"object"},{"properties":{"":{"description":"The request must include an amount that is a multiple of 5. \nIf an amount that is not a multiple of 5 is sent, an error will occur\n\nCurrency: `XOF`","type":"Description:"},"phone_number":{"description":"Customer phone number from the Wave app","maximum":11,"minimum":11,"pattern":"^223[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"wave_mli_p2p","type":"object"},{"properties":{"":{"description":"The request must include an amount that is a multiple of 5. \nIf an amount that is not a multiple of 5 is sent, an error will occur\n\nCurrency: `XOF`","type":"Description:"},"phone_number":{"description":"Customer phone number from the Wave app","maximum":12,"minimum":12,"pattern":"^221[0-9]{9}$","type":"string"}},"required":["phone_number"],"title":"wave_sen_p2p","type":"object"},{"description":"Wavepay-l data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `MMK`","title":"wavepay_l","type":"object"},{"description":"Wing-l data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `KHR`","title":"wing_l","type":"object"},{"description":"Yape Bob P2P data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `BOB`","title":"yape_bob_p2p","type":"object"},{"description":"Yape Pen P2P data (empty)\n\nThis deposit requires activation [Deposit activation](#operation/DepositActivation)\n\nFor example: `\"data\": {}`\n\nCurrency: `PEN`","title":"yape_pen_p2p","type":"object"},{"description":"Yappy P2P data (empty)\n\nFor example: `\"data\": {}`\n\nCurrency: `USD`","title":"yappy_p2p","type":"object"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"title":"Success","required":["success","order_id"],"properties":{"success":{"type":"boolean","description":"`true` if there are no errors"},"status":{"type":"string","enum":["Pending"],"description":"Deposit status"},"order_id":{"type":"string","description":"Deposit ID in the A-Pay system"},"data":{"description":"Data depending on the specific payment system","anyOf":[{"type":"object","description":"Ababank data","title":"ababank","properties":{"qr_code":{"type":"string","description":"Generate the QR with this data and display the code in your interface"},"paymentpage_url":{"type":"string","description":"Ababank payment app deep link"}},"required":["qr_code","paymentpage_url"]},{"type":"object","description":"ApayBDT data","title":"apaybdt","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"Bancard data","title":"bancard_qr","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","title":"banistmo_p2p","description":"Banistmo P2P P2P data","properties":{"receiver_full_name":{"type":"string","description":"The recipient's full name to which user must transfer the funds"},"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"},"receiver_account_type":{"type":"string","description":"The recipient's account type to which user must transfer the funds"}},"required":["receiver_full_name","receiver_account_number","receiver_account_type"]},{"type":"object","description":"BankAlfalah data","title":"bankalfalah","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","title":"bcgeneral_p2p","description":"Bcgeneral P2P data","properties":{"account_name":{"type":"string","description":"Receiver account name"},"account_number":{"type":"string","description":"Receiver account number"}},"required":["account_name","account_number"]},{"type":"object","description":"BKash_a data","title":"bkash_a","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"Bkash API V data","title":"bkash_api_v","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"BKash_b data","title":"bkash_b","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"Bkash P2P data","title":"bkash_p2p","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","title":"brou_p2p","description":"BROU P2P P2P data","properties":{"account_number":{"type":"string","description":"Account number of the recipient"},"account_name":{"type":"string","description":"Recipient’s account name in BROU"}},"required":["account_number","account_name"]},{"type":"object","description":"CVU Fast P2P data","title":"cvu_fast_p2p","properties":{"account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"},"amount_to_pay":{"type":"integer","description":"unique amount for payment"}},"required":["account_number","amount_to_pay"]},{"type":"object","title":"cvu_p2p","description":"CVU-p2p Data","properties":{"account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["account_number"]},{"type":"object","description":"D17_l data","title":"d17_l","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"Easypaisa-l data","title":"easypaisa_l","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"Egp Card Data","title":"egp_card","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","title":"egp_fast","description":"Egp Fast data (empty)\\n\\nFor example: `\"data\": {}`"},{"type":"object","title":"egp_tel","description":"Egp Tel Data","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"Egp Tel Fast data","title":"egp_tel_fast","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"Esewa data","title":"esewa","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","title":"esewa_p2p","description":"eSewa P2P data","properties":{"receiver_account_number":{"type":"string","description":"The eSewa-s id to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","title":"etb_fast","description":"Khalti_l data","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"EGP P2P data","title":"etb_p2p","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","title":"flouci_l","description":"Flouci L Data","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","title":"imepay_l","description":"ImePay L Data","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","title":"imps","description":"Imps data","properties":{"account_number":{"type":"string","description":"Account number"},"account_name":{"type":"string","description":"Account name"},"ifsc_code":{"type":"string","description":"Ifsc code"}},"required":["account_number","account_name","ifsc_code"]},{"type":"object","description":"INR-p2c data","title":"inr_p2c","properties":{"paymentpage_url":{"type":"string","description":"UPI payment app deep link\n\nOur system, using the method Upi_fast, sends a link of the form `upi://`,\nwhich in theory should lead to the opening of the desired application on mobile OS.\nBut, on mobile OSs, there are cases when the universal link doesn't work and opens the wrong application.\nTo fix it you can use the solution on your side:\n[https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android](https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android),\ni.e. for the specified mobile applications write the exact link → replacing `upi://` from the link with the following data for mobile solutions:\n\n- `Paytm` → paytmmp://;\n- `Phonepe` → phonepe://;\n- `GPay` → tez://upi/.\n\nAnd let the user select the desired solution first and then get the link for the specific app.\nUse the payment app links in the mobile version. Use the same links converted to QR in the desktop version."}},"required":["paymentpage_url"]},{"type":"object","description":"INR-p2p data","title":"inr_p2p","properties":{"upi_address":{"type":"string","description":"UPI address"},"paymentpage_url":{"type":"string","description":"UPI deeplink which can be used to generate QR code. `Optional`"}},"required":["upi_address"]},{"type":"object","description":"Ipay Fast data","title":"ipay_fast","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"title":"ipay_l","description":"Ipay-l data","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"Itau p2p data","title":"itau_p2p","properties":{"account_number":{"type":"string","description":"Número de cuenta del beneficiario en Itau"},"account_name":{"type":"string","description":"Nombre de la cuenta del beneficiario en Itau"}},"required":["account_number","account_name"]},{"type":"object","description":"Jazzcash-l data","title":"jazzcash_l","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"KBZpay P2P data","title":"kbzpay_p2p","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"},"qr_code":{"type":"string","description":"Generate the QR with this data and display the code in your interface"}},"required":["receiver_account_number","qr_code"]},{"type":"object","description":"Khalti data","title":"khalti","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","title":"khalti_l","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"Lynk P2P data","title":"lynk_p2p","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account id (Lynk ID) to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","title":"moov_mli_p2p","description":"Moov Money P2P data","properties":{"phone_number":{"type":"string","description":"Receiver phone number"}},"required":["phone_number"]},{"type":"object","description":"Nagad A","title":"nagad_a","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"Nagad API V data","title":"nagad_api_v","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"Nagad B","title":"nagad_b","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"Nagad P2P data","title":"nagad_p2p","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"Nayapay_l data","title":"nayapay_l","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","title":"orange_gin_p2p","description":"Orange Money GIN p2p data","properties":{"phone_number":{"type":"string","description":"Receiver phone number"}},"required":["phone_number"]},{"type":"object","title":"orange_mli_p2p","description":"Orange Money MLI p2p data","properties":{"phone_number":{"type":"string","description":"Receiver phone number"},"paymentpage_url":{"type":"string","description":"Deep link for payment in the Orange Money app"}},"required":["phone_number","paymentpage_url"]},{"type":"object","title":"orange_sen_p2p","description":"Orange Money SEN p2p data","properties":{"phone_number":{"type":"string","description":"Receiver phone number"}},"required":["phone_number"]},{"type":"object","title":"paygo_p2p","description":"Pay&Go P2P data","properties":{"amount_to_pay":{"type":"string","description":"The total amount to be paid by the user"},"qr_code":{"type":"string","description":"Generate the QR with this data and display the code in your interface"}},"required":["amount_to_pay","qr_code"]},{"type":"object","description":"Paytm data","title":"paytm","properties":{"upi_address":{"type":"string","description":"UPI address"},"paymentpage_url":{"type":"string","description":"UPI deeplink which can be used to generate QR code. `Optional`"}},"required":["upi_address"]},{"type":"object","description":"Phonepe data","title":"phonepe","properties":{"upi_address":{"type":"string","description":"UPI address"},"paymentpage_url":{"type":"string","description":"UPI deeplink which can be used to generate QR code. `Optional`"}},"required":["upi_address"]},{"type":"object","description":"Phonepe_fast data","title":"phonepe_fast","properties":{"paymentpage_url":{"type":"string","description":"UPI payment app deep link\n\nOur system, using the method Phonepe_fast, sends a link of the form `upi://`,\nwhich in theory should lead to the opening of the desired application on mobile OS.\nBut, on mobile OSs, there are cases when the universal link doesn't work and opens the wrong application.\nTo fix it you can use the solution on your side:\n[https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android](https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android),\ni.e. for the specified mobile applications write the exact link → replacing `upi://` from the link with the following data for mobile solutions:\n\n- `Phonepe` → phonepe://.\n\nAnd let the user select the desired solution first and then get the link for the specific app.\nUse the payment app links in the mobile version. Use the same links converted to QR in the desktop version."}},"required":["paymentpage_url"]},{"type":"object","description":"Pix-p2p Link data","title":"pix_p2p","properties":{"paymentpage_url":{"type":"string","description":"Payment app deep link"}},"required":["paymentpage_url"]},{"type":"object","description":"Raast P2P data","title":"raast_p2p","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"Scotiabank Link data","title":"scotiabank_p2p","properties":{"receiver_transit_number":{"type":"string","description":"Receiver transit number"},"receiver_account_number":{"type":"string","description":"Receiver account number"}},"required":["receiver_transit_number","receiver_account_number"]},{"type":"object","description":"Spei-p2p Link data","title":"spei_p2p","properties":{"receiver_bank_name":{"type":"string","description":"Receiver bank name"},"receiver_account_number":{"type":"string","description":"Receiver account number"}},"required":["receiver_bank_name","receiver_account_number"]},{"type":"object","description":"Stc Pay P2P data","title":"stcpay_p2p","properties":{"recipient_iban_number":{"type":"string","description":"Receiver IBAN number"}},"required":["recipient_iban_number"]},{"type":"object","description":"Tap P2P data","title":"tap_p2p","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","description":"UPAY data","title":"upay","properties":{"paymentpage_url":{"type":"string","description":"Link to payment page"}},"required":["paymentpage_url"]},{"type":"object","description":"Upi-a data","title":"upi_a","properties":{"paymentpage_url":{"type":"string","description":"UPI payment app deep link\n\nOur system, using the method Upi_fast, sends a link of the form `upi://`,\nwhich in theory should lead to the opening of the desired application on mobile OS.\nBut, on mobile OSs, there are cases when the universal link doesn't work and opens the wrong application.\nTo fix it you can use the solution on your side:\n[https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android](https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android),\ni.e. for the specified mobile applications write the exact link → replacing `upi://` from the link with the following data for mobile solutions:\n\n- `Paytm` → paytmmp://;\n- `Phonepe` → phonepe://;\n- `GPay` → tez://upi/.\n\nAnd let the user select the desired solution first and then get the link for the specific app.\nUse the payment app links in the mobile version. Use the same links converted to QR in the desktop version."}},"required":["paymentpage_url"]},{"type":"object","description":"UPI Fast data","title":"upi_fast","properties":{"paymentpage_url":{"type":"string","description":"UPI payment app deep link\n\nOur system, using the method Upi_fast, sends a link of the form `upi://`,\nwhich in theory should lead to the opening of the desired application on mobile OS.\nBut, on mobile OSs, there are cases when the universal link doesn't work and opens the wrong application.\nTo fix it you can use the solution on your side:\n[https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android](https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android),\ni.e. for the specified mobile applications write the exact link → replacing `upi://` from the link with the following data for mobile solutions:\n\n- `Paytm` → paytmmp://;\n- `Phonepe` → phonepe://;\n- `GPay` → tez://upi/.\n\nAnd let the user select the desired solution first and then get the link for the specific app.\nUse the payment app links in the mobile version. Use the same links converted to QR in the desktop version."}},"required":["paymentpage_url"]},{"type":"object","description":"UPI Fast QR data","title":"upi_fast_qr","properties":{"paymentpage_url":{"type":"string","description":"UPI payment app deep link\n\nOur system, using the method Upi_fast_qr, sends a link of the form `upi://`,\nwhich in theory should lead to the opening of the desired application on mobile OS.\nBut, on mobile OSs, there are cases when the universal link doesn't work and opens the wrong application.\nTo fix it you can use the solution on your side:\n[https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android](https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android),\ni.e. for the specified mobile applications write the exact link → replacing `upi://` from the link with the following data for mobile solutions:\n\n- `Paytm` → paytmmp://;\n- `Phonepe` → phonepe://;\n- `GPay` → tez://upi/.\n\nAnd let the user select the desired solution first and then get the link for the specific app.\nUse this links converted to QR in the desktop and mobile version."}},"required":["paymentpage_url"]},{"type":"object","description":"UPI Fast V data","title":"upi_fast_v","properties":{"paymentpage_url":{"type":"string","description":"UPI payment app deep link\n\nOur system, using the method Upi_fast, sends a link of the form `upi://`,\nwhich in theory should lead to the opening of the desired application on mobile OS.\nBut, on mobile OSs, there are cases when the universal link doesn't work and opens the wrong application.\nTo fix it you can use the solution on your side:\n[https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android](https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android),\ni.e. for the specified mobile applications write the exact link → replacing `upi://` from the link with the following data for mobile solutions:\n\n- `Paytm` → paytmmp://;\n- `Phonepe` → phonepe://;\n- `GPay` → tez://upi/.\n\nAnd let the user select the desired solution first and then get the link for the specific app.\nUse the payment app links in the mobile version. Use the same links converted to QR in the desktop version."}},"required":["paymentpage_url"]},{"type":"object","description":"UPI Fast VIP data","title":"upi_fast_vip","properties":{"paymentpage_url":{"type":"string","description":"UPI payment app deep link\n\nOur system, using the method Upi_fast_vip, sends a link of the form `upi://`,\nwhich in theory should lead to the opening of the desired application on mobile OS.\nBut, on mobile OSs, there are cases when the universal link doesn't work and opens the wrong application.\nTo fix it you can use the solution on your side:\n[https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android](https://stackoverflow.com/questions/65273125/invoking-upi-apps-from-my-react-native-app-works-in-ios-but-not-in-android),\ni.e. for the specified mobile applications write the exact link → replacing `upi://` from the link with the following data for mobile solutions:\n\n- `Paytm` → paytmmp://;\n- `Phonepe` → phonepe://;\n- `GPay` → tez://upi/.\n\nAnd let the user select the desired solution first and then get the link for the specific app.\nUse the payment app links in the mobile version. Use the same links converted to QR in the desktop version."}},"required":["paymentpage_url"]},{"type":"object","description":"UPI Link data","title":"upi_link","properties":{"paymentpage_url":{"type":"string","description":"UPI payment app deep link"}},"required":["paymentpage_url"]},{"type":"object","description":"UPI p2p data","title":"upi_p2p","properties":{"upi_address":{"type":"string","description":"UPI address"},"paymentpage_url":{"type":"string","description":"UPI deeplink which can be used to generate QR code. `Optional`"}},"required":["upi_address"]},{"type":"object","title":"veripagos_fast","description":"Veripagos Fast p2c data","properties":{"qr_code":{"type":"string","description":"QR code image in Base64 (PNG format). Use data:image/png;base64,{value} to display it."}},"required":["qr_code"]},{"type":"object","title":"wave_mli_p2p","description":"Wave Mli p2p data","properties":{"receiver_phone_number":{"type":"string","description":"Receiver phone number"}},"required":["receiver_phone_number"]},{"type":"object","title":"wave_sen_p2p","description":"The request must include an amount that is a multiple of 5. \\nIf an amount that is not a multiple of 5 is sent, an error will occur\\n\\nCurrency: `XOF`","properties":{"receiver_phone_number":{"type":"string","description":"Receiver phone number"},"receiver_account_name":{"type":"string","description":"Receiver account name"}},"required":["receiver_account_name","receiver_phone_number","phone_number"]},{"type":"object","description":"Wavepay_l data","title":"wavepay_l","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"},"qr_code":{"type":"string","description":"Generate the QR with this data and display the code in your interface"}},"required":["receiver_account_number","qr_code"]},{"type":"object","description":"Wing_l data","title":"wing_l","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"},"qr_code":{"type":"string","description":"Generate the QR with this data and display the code in your interface"}},"required":["receiver_account_number","qr_code"]},{"type":"object","description":"Yape Bob P2P data","title":"yape_bob_p2p","properties":{"qr_code":{"type":"string","description":"Generate the QR with this data and display the code in your interface"},"amount_to_pay":{"type":"integer","description":"unique amount for payment"}},"required":["qr_code","amount_to_pay"]},{"type":"object","description":"Yape Pen P2P data","title":"yape_pen_p2p","properties":{"receiver_account_number":{"type":"string","description":"The recipient's account number to which user must transfer the funds"}},"required":["receiver_account_number"]},{"type":"object","title":"yappy_p2p","description":"Yappy P2P data","properties":{"phone_number":{"type":"string","description":"The phone number to which the user must send the transfer in the Yappy app (without country code)"},"qr_code":{"type":"string","description":"Generate the QR with this data and display the code in your interface"}},"required":["qr_code","phone_number"]}]}}},{"title":"Error","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"type":"string","description":"Description of error"},"status":{"type":"string","enum":["Failed"],"description":"Deposit status"},"code":{"type":"number","description":"Error code in the A-Pay system"},"order_id":{"type":"string","description":"Deposit ID 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":{"description":"Description of error","oneOf":[{"type":"string","title":"All","$ref":"#/components/schemas/errors"},{"type":"string","title":"easypaisa","description":"Easypaisa errors","oneOf":[{"type":"string","default":"too many requests","title":"Error: too many requests","description":"No more than two requests per minute allowed per `account number`."},{"type":"string","default":"limit of failed requests exceeded","title":"Error: limit of Failed Requests Exceeded","description":"Deposits are blocked for 24 hours after three failed deposit attempts within the same hour, identified by `account_number`."}]}]},"status":{"type":"string","enum":["Failed"],"description":"Deposit status"},"code":{"type":"number","description":"Error code in the A-Pay system"},"order_id":{"type":"string","description":"Deposit ID in the A-Pay system"}}}}}}}}}}} ``` In order for the request to be created correctly, it is necessary to comply with the documentation requirements: all required fields must be present in the request, and field validation must be observed. In a deposit request, the client must send the following information: * **project\_id** - project id in the A-pay platform, the parameter can be found in the projects table next to the project name. * **amount** - deposit amount in integer * **currency** - currency of the payment system * **payment\_system** - name of the payment system from A-pay platform * **custom\_transaction\_id** - unique transaction identifier in the client's system * **custom\_user\_id** - unique user identifier in the client's system * **data** - additional data depending on the PS[^1]. To find out what data should be sent, you should click on data and select the necessary PS. These data will be specified [here](https://api.a-pay.one/#tag/Deposit/paths/~1Remotes~1create-deposit/post) {% hint style="info" %} Each payment system requires certain information to be sent. Please read our API carefully! {% endhint %} ### Responses Below is information about our server's responses to such requests, as well as the data that our server sends to the client in response. The response can be both successful and unsuccessful. Our server sends the following data to the client in the request: * **success** - a parameter that is responsible for whether the response is successful or not * **status** - status of the deposit creation * **order\_id** - our internal unique order, which is assigned to each transaction * **data** - additional data that depends on the PS. To find out what data should be sent, you need to click on data and select the desired PS. This data will be spelled out [here](https://api.a-pay.one/#tag/Deposit/paths/~1Remotes~1create-deposit/post) in the response section. In this case, it is a link to the deposit payment {% hint style="info" %} Each payment system returns different information to the client. Please read our API carefully! {% endhint %} **Examples of the responses:** {% code title="Success" %} ```json { "success": true, "status": "Pending", "order_id": "7fa13dbc3b79e05e", "data": { "paymentpage_url": "string" } } ``` {% endcode %} {% code title="Error" %} ```json { "success": false, "message": "Invalid request", "status": "Failed", "code": 400, "order_id": "7fa13dbc3b79e05e" } ``` {% endcode %} [^1]: Payment System --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.a-pay.one/api-documentation/api-integration/deposit/request-to-create-a-deposit.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.