> For the complete documentation index, see [llms.txt](https://docs.a-pay.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.a-pay.one/api-documentation/api-integration/withdrawal.md). # Withdrawal

Sequence diagram of the Withdrawal via API integration

### Request to create a withdrawal The section is similar to the [**Request to create a deposit**](#request-to-create-a-withdrawal) section. Only the data required to create a withdrawal request will change. ## Request to create a withdrawal > Withdrawal creation.\ > \ > When the withdrawal is confirmed, a callback request will be sent to the client's application handler with the \[Withdrawal webhook]\(#operation/WithdrawalWebhook) body ```json {"openapi":"3.0.3","info":{"title":"A-Pay","version":"1.0.0"},"tags":[{"name":"Withdrawal","description":"Withdrawals"}],"servers":[{"url":"https://"}],"security":[{"apikey":[]}],"components":{"securitySchemes":{"apikey":{"type":"apiKey","name":"apikey","in":"header"}},"schemas":{"withdrawal_currency":{"type":"string","title":"Currency","enum":["ARS","BDT","BHD","BOB","BRL","EGP","ETB","GNF","GTQ","INR","JMD","KES","KHR","LKR","MMK","MXN","NIO","NPR","PEN","PKR","PYG","TND","USD","UYU","XOF"],"description":"
\n Payment system currency\n \n | Currency | Payment systems | Decimal places |\n |----------|-----------------|----------------|\n | ARS | `cvu_p2p`, `mercado_ars_p2p` | `0` |\n | BDT | `apaybdt`, `bkash_a`, `bkash_api_v`, `bkash_b`, `bkash_p2p`, `nagad_a`, `nagad_api_v`, `nagad_b`, `tap_p2p`, `upay`, `upay_w` | `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` | `0` |\n | ETB | `cbebirr_p2p`, `etb_fast`, `etb_mpesa_p2p`, `etb_p2p`, `telebirr_fast_p2p` | `0` |\n | GNF | `orange_gin_p2p` | `0` |\n | GTQ | `fri_p2p` | `2` e.g. 0.01 |\n | INR | `imps`, `imps_top`, `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` | `0` |\n | MMK | `kbzpay_p2p`, `wavepay_l` | `0` |\n | MXN | `spei_p2p` | `0` |\n | NIO | `ach_p2p` | `2` e.g. 0.01 |\n | NPR | `esewa`, `esewa_p2p`, `imepay_l`, `khalti`, `khalti_l` | `0` |\n | PEN | `yape_pen_p2p` | `0` |\n | PKR | `bankalfalah`, `easypaisa`, `jazzcash`, `jazzcash_l`, `nayapay_l`, `pkr_w`, `pkr_w2`, `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`, `mercado_uyu_p2c` | `0` |\n | XOF | `moov_mli_p2p`, `orange_mli_p2p`, `orange_sen_p2p`, `wave_mli_p2p`, `wave_sen_p2p` | `0` |\n
"},"ps_withdrawal":{"type":"string","title":"Payment system","enum":["ababank","ach_p2p","apaybdt","bancard_qr","banistmo_p2p","bankalfalah","bcgeneral_p2p","bkash_a","bkash_api_v","bkash_b","bkash_p2p","brou_p2p","cbebirr_p2p","cvu_p2p","d17_l","easypaisa","egp_card","egp_fast","egp_tel","esewa","esewa_p2p","etb_fast","etb_mpesa_p2p","etb_p2p","flouci","flouci_l","fri_p2p","imepay_l","imps","imps_top","inr_p2c","inr_p2p","ipay_fast","ipay_l","itau_p2p","jazzcash","jazzcash_l","kbzpay_p2p","khalti","khalti_l","lynk_p2p","mercado_ars_p2p","mercado_uyu_p2c","moov_mli_p2p","mpesa","nagad_a","nagad_api_v","nagad_b","nayapay_l","orange_gin_p2p","orange_mli_p2p","orange_sen_p2p","paytm","phonepe","phonepe_fast","pix_p2p","pkr_w","pkr_w2","raast_p2p","scotiabank_p2p","spei_p2p","stcpay_p2p","tap_p2p","telebirr_fast_p2p","upay","upay_w","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"},"unauthorized_error":{"title":"Unauthorized","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"type":"string","default":"unauthorized","description":"Invalid credentials"},"code":{"type":"number","description":"Error code in the A-Pay system"}}}}},"paths":{"/Remotes/create-withdrawal":{"post":{"tags":["Withdrawal"],"summary":"Request to create a withdrawal","description":"Withdrawal creation.\n\nWhen the withdrawal is confirmed, a callback request will be sent to the client's application handler with the [Withdrawal webhook](#operation/WithdrawalWebhook) 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":"Withdrawal 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","GTQ","INR","JMD","KES","KHR","LKR","MMK","MXN","NIO","NPR","PEN","PKR","PYG","TND","USD","UYU","XOF"]},{"type":"number","description":"Currencies that accept `number` type","enum":["BHD","GTQ","NIO","USD"]}]},"currency":{"$ref":"#/components/schemas/withdrawal_currency"},"payment_system":{"$ref":"#/components/schemas/ps_withdrawal"},"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","properties":{"":{"description":"Currency: `KHR`","type":"Description:"},"account_name":{"description":"Receiver account name","maximum":50,"type":"string"},"account_number":{"description":"Account number","maximum":13,"minimum":9,"pattern":"^[0-9]{9}$|^[0-9]{13}$","type":"string"},"bank_name":{"description":"Bank name to make a withdrawal. The supported bank names are listed below:\n| № | Bank Name |\n| --- | ------------------------------------------------------------- |\n| 1 | ABA Bank |\n| 2 | ACLEDA Bank |\n| 3 | Agribank (Vietnam Bank for Agriculture and Rural Development) |\n| 4 | Agricultural and Rural Development Bank (ARDB) |\n| 5 | Alpha Commercial Bank |\n| 6 | Asia-Pacific Development Bank |\n| 7 | B.I.C (Cambodia) Bank |\n| 8 | Bangkok Bank |\n| 9 | Bank for Investment and Development of Cambodia (BIDC) |\n| 10 | Bank of China |\n| 11 | Booyoung Khmer Bank |\n| 12 | BRED Bank |\n| 13 | Bridge Bank |\n| 14 | Cambodia Asia Bank |\n| 15 | Cambodia Post Bank |\n| 16 | Cambodian Commercial Bank |\n| 17 | Cambodian Public Bank |\n| 18 | Canadia Bank |\n| 19 | Cathay United Bank |\n| 20 | CCU Commercial Bank |\n| 21 | Chief (Cambodia) Commercial Bank |\n| 22 | Chip Mong Bank |\n| 23 | CIMB Bank |\n| 24 | DGB Bank |\n| 25 | First Commercial Bank |\n| 26 | Foreign Trade Bank of Cambodia (FTB) |\n| 27 | Hattha Bank |\n| 28 | Heng Feng (Cambodia) Bank |\n| 29 | Heng He (Cambodia) Commercial Bank |\n| 30 | Hong Leong Bank |\n| 31 | ICBC |\n| 32 | Industrial Bank of Korea |\n| 33 | J Trust Royal Bank |\n| 34 | Kasikornbank (KBank) |\n| 35 | KB Prasac Bank |\n| 36 | Krung Thai Bank |\n| 37 | Maybank |\n| 38 | MB Bank |\n| 39 | Mega International Commercial Bank |\n| 40 | Mizuho Bank |\n| 41 | Oriental Bank |\n| 42 | Panda Commercial Bank |\n| 43 | Phillip Bank |\n| 44 | Phnom Penh Commercial Bank (PPCBank) |\n| 45 | Prince Bank |\n| 46 | RHB Bank |\n| 47 | Rui Li (Cambodia) Bank |\n| 48 | Sacombank (Cambodia) |\n| 49 | Saigon-Hanoi Bank (SHB) |\n| 50 | Sathapana Bank |\n| 51 | SBI Ly Hour Bank |\n| 52 | Shinhan Bank |\n| 53 | SME Bank of Cambodia |\n| 54 | Taiwan Cooperative Bank |\n| 55 | Union Commercial Bank |\n| 56 | Vattanac Bank |\n| 57 | Wing Bank |\n| 58 | Woori Bank |","maximum":100,"minimum":1,"pattern":"^[a-zA-Z.() -]{1,100}$","type":"string"}},"required":["account_name","account_number","bank_name"],"title":"ababank","type":"object"},{"description":"ACH Lafise P2P data","properties":{"":{"description":"Currency: `NIO`","type":"Description:"},"receiver_full_name":{"description":"The recipient's full name to which the funds will be transferred","maximum":50,"minimum":1,"pattern":"^[A-Za-zÁÉÍÓÚÜÑáéíóúüñ ]{1,50}$","type":"string"},"recipient_account_number":{"description":"The recipient's bank account number for ACH transfer.","maximum":20,"minimum":1,"pattern":"^[0-9]{1,20}$","type":"string"}},"required":["recipient_account_number","receiver_full_name"],"title":"ach_p2p","type":"object"},{"description":"ApayBDT data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_email":{"description":"Receiver account email","maximum":100,"type":"string"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^0[0-9]{11}$","type":"string"}},"required":["account_email","account_number"],"title":"apaybdt","type":"object"},{"description":"Bancard QR Withdrawal data","properties":{"":{"description":"Currency: `PYG`","type":"Description:"},"account_name":{"description":"Recipient's full name (as indicated in the recipient's bank)","maximum":100,"minimum":5,"pattern":"^(?=.{5,100}$)([A-Za-zÁÉÍÓÚáéíóúÑñ]+(?: [A-Za-zÁÉÍÓÚáéíóúÑñ]+){1,7})$","type":"string"},"account_number":{"description":"Recipient's bank account number","maximum":20,"minimum":5,"pattern":"^[0-9]{5,20}$","type":"string"},"bank_name":{"description":"Name of the recipient's bank","maximum":50,"minimum":3,"pattern":"^[A-Za-zÁÉÍÓÚÜáéíóúüÑñ. ]{3,50}$","type":"string"},"ci_number":{"description":"Cedula de identidad paraguaya of the recipient number","maximum":8,"minimum":5,"pattern":"^[0-9]{5,8}$","type":"string"}},"required":["bank_name","account_number","account_name","ci_number"],"title":"bancard_qr","type":"object"},{"description":"Banistmo P2P data","properties":{"":{"description":"Currency: `USD`","type":"Description:"},"receiver_account_number":{"description":"The recipient's account number to which the funds will be transferred.","maximum":10,"minimum":10,"pattern":"^[014]{1}[0-9]{9}$","type":"string"},"receiver_account_type":{"description":"The recipient's account type to which the funds will be transferred","enum":["Cuenta de ahorros","Cuenta corriente"],"pattern":"^(Cuenta de ahorros|Cuenta corriente)$","type":"string"},"receiver_full_name":{"description":"Full name of the recipient to whom the funds will be transferred.","maximum":50,"minimum":1,"pattern":"^[A-Za-zÁÉÍÓÚÜÑÀÈÉÍÏÒÓÚÜÇáéíóúüñàèéíïòóúüç ]{1,50}$","type":"string"}},"required":["receiver_full_name","receiver_account_number","receiver_account_type"],"title":"banistmo_p2p","type":"object"},{"description":"Bankalfalah data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_number":{"description":"Account number","maximum":18,"minimum":6,"pattern":"^[0-9]{6,18}$","type":"string"},"account_title":{"description":"Receiver account name","maximum":50,"type":"string"},"customer_phone":{"description":"Phone number","maximum":11,"minimum":11,"pattern":"^[0-9]{11}$","type":"string"},"iban_number":{"description":"IBAN number","maximum":24,"minimum":24,"pattern":"^PK[A-Za-z0-9]{22}$","type":"string"}},"required":["iban_number","account_title","account_number","customer_phone"],"title":"bankalfalah","type":"object"},{"properties":{"":{"description":"Currency: `USD`","type":"Description:"},"receiver_account_number":{"description":"Recipient's account number in Banco General","maximum":14,"minimum":12,"pattern":"^[0-9]{12,14}$","type":"string"},"receiver_full_name":{"description":"Recipient’s account name in Banco General","maximum":50,"minimum":1,"pattern":"^[A-Za-zÁÉÍÓÚÜÑÀÈÉÍÏÒÓÚÜÇáéíóúüñàèéíïòóúüç ]{1,50}$","type":"string"}},"required":["receiver_full_name","receiver_account_number"],"title":"bcgeneral_p2p","type":"object"},{"description":"BKash_a data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_email":{"description":"Receiver account email","maximum":100,"type":"string"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^0[0-9]{10}$","type":"string"}},"required":["account_number"],"title":"bkash_a","type":"object"},{"description":"Bkash API V","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"}},"required":["account_number"],"title":"bkash_api_v","type":"object"},{"description":"BKash_b data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_email":{"description":"Receiver account email","maximum":100,"type":"string"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"}},"required":["account_number"],"title":"bkash_b","type":"object"},{"description":"BKash P2P data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^01[0-9]{9}$","type":"string"}},"required":["account_number"],"title":"bkash_p2p","type":"object"},{"description":"BROU P2P data","properties":{"":{"description":"Currency: `UYU`","type":"Description:"},"account_name":{"description":"Recipient’s account name in BROU","maximum":50,"minimum":3,"pattern":"^[A-Za-zÁÉÍÓÚÜÑáéíóúüñ ]{3,50}$","type":"string"},"account_number":{"description":"Account number of the recipient","maximum":14,"minimum":14,"pattern":"^[0-9]{14}$","type":"string"}},"required":["account_number","account_name"],"title":"brou_p2p","type":"object"},{"description":"Cbebirr P2P Withdrawal Data","properties":{"":{"description":"Currency: `ETB`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":12,"minimum":12,"pattern":"^2519[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"cbebirr_p2p","type":"object"},{"description":"CVU-p2p Data","properties":{"":{"description":"Currency: `ARS`","type":"Description:"},"account_number":{"description":"Clave virtual uniforme. Account number","maximum":22,"minimum":22,"pattern":"^[0-9]{22}$","type":"string"},"account_title":{"description":"Receiver account name","maximum":50,"type":"string"}},"required":["account_number"],"title":"cvu_p2p","type":"object"},{"description":"d17_l data","properties":{"":{"description":"Currency: `TND`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":8,"minimum":8,"pattern":"^[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"d17_l","type":"object"},{"description":"Easypaisa data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_name":{"description":"Receiver account name","maximum":50,"type":"string"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^[0-9]{11}$","type":"string"},"wallet_type":{"description":"Wallet type","enum":["easypaisa","jazzcash"],"type":"string"}},"required":["wallet_type","account_name","account_number"],"title":"easypaisa","type":"object"},{"description":"Egp-Card Withdrawal data","oneOf":[{"properties":{"":{"description":"Currency: `EGP`","type":"Description:"},"payment_address":{"description":"Payment address","type":"string"},"payment_method":{"description":"Payment method type, must be `instapay` for Instapay payment method","enum":["instapay"],"type":"string"}},"required":["payment_method","payment_address"],"title":"instapay","type":"object"},{"properties":{"":{"description":"Currency: `EGP`","type":"Description:"},"card_number":{"description":"Account name","maximum":16,"minimum":16,"pattern":"^[0-9]{16}$","type":"string"},"payment_method":{"description":"Payment method type, must be `card` for Card payment method","enum":["card"],"type":"string"}},"required":["payment_method","card_number"],"title":"card","type":"object"}],"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":"Esewa data","properties":{"":{"description":"Currency: `NPR`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":10,"minimum":10,"pattern":"^[0-9]{10}$","type":"string"}},"required":["phone_number"],"title":"esewa","type":"object"},{"description":"eSewa P2P Withdrawal Data","oneOf":[{"properties":{"":{"description":"Currency: `NPR`","type":"Description:"},"payment_method":{"description":"Payment method type, must be phone for phone payment method","enum":["phone"],"type":"string"},"phone_number":{"description":"User’s eSewa ID (Mobile Number) to which the transaction will be made","maximum":10,"minimum":10,"pattern":"^[0-9]{10}$","type":"string"}},"required":["payment_method","phone_number"],"title":"phone","type":"object"},{"properties":{"":{"description":"Currency: `NPR`","type":"Description:"},"account_holder_name":{"description":"Recipient’s account name","maximum":50,"minimum":1,"pattern":"^[a-zA-Z\\s]{1,50}$","type":"string"},"account_number":{"description":"Receiver account number","maximum":20,"minimum":9,"pattern":"^[A-Za-z0-9]{9,20}$","type":"string"},"bank_name":{"description":"
\n Bank name to make a withdrawal. The supported bank names are listed below:\n\n |№ |Bank Name |\n |---|-----------------------------------------------------|\n |1 |AGRICULTURAL DEVELOPMENT BANK LTD. |\n |2 |BEST FINANCE COMPANY LTD. |\n |3 |CENTRAL FINANCE LTD. |\n |4 |CITIZENS BANK INTL. LTD |\n |5 |EVEREST BANK LTD. |\n |6 |EXCEL DEVELOPMENT BANK LTD. |\n |7 |GARIMA BIKAS BANK LTD. |\n |8 |GLOBAL IME BANK LTD. |\n |9 |GOODWILL FINANCE LTD. |\n |10 |GREEN DEVELOPMENT BANK LTD. |\n |11 |GUHESWORI MERCHANT BANKING & FINANCE LTD |\n |12 |GURKHAS FINANCE LTD. |\n |13 |HIMALAYAN BANK LTD. |\n |14 |ICFC FINANCE LTD. |\n |15 |JYOTI BIKAS BANK LTD. |\n |16 |KAMANA SEWA BIKAS BANK LTD. |\n |17 |KISAN BAHUUDESHIYA SAHAKARI SANSTHA |\n |18 |KUMARI BANK LTD. |\n |19 |LAXMI SUNRISE BANK LTD. |\n |20 |LUMBINI BIKAS BANK LTD. |\n |21 |MACHHAPUCHCHHRE BANK LTD. |\n |22 |MAHALAXMI BIKAS BANK LTD. |\n |23 |MANJUSHREE FINANCE LTD. |\n |24 |MITERI DEVELOPMENT BANK LTD |\n |25 |MUKTINATH BIKAS BANK LTD. |\n |26 |MULTIPURPOSE FINANCE LIMITED |\n |27 |NABIL BANK LTD. |\n |28 |NARAYANI DEVELOPMENT BANK |\n |29 |NAWAKANTIPUR SAVING & CREDIT CO-OPERATIVE SOCIETY LTD|\n |30 |NEPAL BANK LTD. |\n |31 |NEPAL FINANCE LIMITED |\n |32 |NEPAL INVESTMENT MEGA BANK LTD. |\n |33 |NEPAL SBI BANK LTD. |\n |34 |NIC ASIA BANK LTD. |\n |35 |NMB BANK LTD. |\n |36 |POKHARA FINANCE LTD. |\n |37 |PRABHU BANK LTD. |\n |38 |PRIME COMMERCIAL BANK LTD. |\n |39 |PROGRESSIVE FINANCE LTD. |\n |40 |RASTRIYA BANIJYA BANK LTD. |\n |41 |RELIANCE FINANCE LTD. |\n |42 |SALAPA BIKAS BANK LTD |\n |43 |SANIMA BANK LTD. |\n |44 |SAPTAKOSHI DEVELOPMENT BANK LTD. |\n |45 |SHANGRI-LA DEVELOPMENT BANK LTD. |\n |46 |SHINE RESUNGA DEVELOPMENT BANK LTD. |\n |47 |SHREE INVESTMENT & FINANCE COMPANY LTD |\n |48 |SIDDHARTHA BANK LTD. |\n |49 |SINDHU BIKAS BANK LTD. |\n
","maximum":100,"minimum":1,"pattern":"^[a-zA-Z.& -]{1,100}$","type":"string"},"payment_method":{"description":"Payment method type, must be bank for bank payment method","enum":["bank"],"type":"string"}},"required":["payment_method","phone_number","bank_name"],"title":"bank","type":"object"}],"title":"esewa_p2p","type":"object"},{"description":"Etd Fast Data","properties":{"":{"description":"Currency: `ETB`","type":"Description:"},"account_number":{"description":"Account number","maximum":13,"minimum":10,"pattern":"^[0-9]+$","type":"string"},"bank_name":{"description":"Bank name to make a withdrawal. The supported bank names are listed below:\n| № | Bank Name |\n|-----|---------------------------------------------|\n| 1 | Abay Bank |\n| 2 | Addis International Bank |\n| 3 | Ahadu Bank |\n| 4 | Awash Bank |\n| 5 | Bank of Abyssinia |\n| 6 | Berhan Bank |\n| 7 | CBEBirr |\n| 8 | Commercial Bank of Ethiopia (CBE) |\n| 9 | Coopay-Ebirr |\n| 10 | Dashen Bank |\n| 11 | Enat Bank |\n| 12 | Global Bank Ethiopia |\n| 13 | Hibret Bank |\n| 14 | Lion International Bank |\n| 15 | M-Pesa |\n| 16 | Nib International Bank |\n| 17 | telebirr |\n| 18 | Wegagen Bank |","maximum":36,"minimum":3,"pattern":"^[A-Za-z0-9\\s\\-()'.&]+$","type":"string"}},"required":["account_number","bank_name"],"title":"etb_fast","type":"object"},{"description":"M-PESA ETH P2P Withdrawal Data","oneOf":[{"properties":{"":{"description":"Currency: `ETB`","type":"Description:"},"payment_method":{"description":"Payment method type, must be phone for phone payment method","enum":["phone"],"type":"string"},"phone_number":{"description":"Phone number","maximum":12,"minimum":12,"pattern":"^251[0-9]{9}$","type":"string"}},"required":["payment_method","phone_number"],"title":"phone","type":"object"},{"properties":{"":{"description":"Currency: `ETB`","type":"Description:"},"account_number":{"description":"Account number","maximum":13,"minimum":10,"pattern":"^[0-9]+$","type":"string"},"bank_name":{"description":"
\n Bank name to make a withdrawal. The supported bank names are listed below:\n\n | № | Bank Name |\n |-----|---------------------------------------------|\n | 1 | Abay Bank |\n | 2 | Addis Bank |\n | 3 | Ahadu Bank |\n | 4 | Anbesa Bank |\n | 5 | Awash Bank |\n | 6 | Bank of Abyssinia |\n | 7 | Berhan Bank |\n | 8 | Bunna Bank |\n | 9 | Commercial Bank of Ethiopia |\n | 10 | Cooperative Bank of Ormo |\n | 11 | Dashen Bank |\n | 12 | Enat Bank |\n | 13 | Hibret Bank |\n | 14 | Kacha |\n | 15 | Rammis Bank |\n | 16 | Sidama Bank S.C |\n | 17 | Siingee Bank |\n | 18 | Siket Bank |\n | 19 | Tsehay Bank |\n | 20 | Wegagen bank |\n | 21 | ZamZam Bank |\n | 22 | Zemen Bank |\n
","maximum":36,"minimum":3,"pattern":"^[A-Za-z0-9\\s\\-()'.&]+$","type":"string"},"payment_method":{"description":"Payment method type, must be bank for bank payment method","enum":["bank"],"type":"string"}},"required":["payment_method","account_number","bank_name"],"title":"bank","type":"object"}],"title":"etb_mpesa_p2p","type":"object"},{"description":"ETB P2P Data","properties":{"":{"description":"Currency: `ETB`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":12,"minimum":12,"pattern":"^2519[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"etb_p2p","type":"object"},{"description":"Flouci Withdrawal data","properties":{"":{"description":"Currency: `TND`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":8,"minimum":8,"pattern":"^[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"flouci","type":"object"},{"description":"Flouci L data","properties":{"":{"description":"Currency: `TND`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":8,"minimum":8,"pattern":"^[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"flouci_l","type":"object"},{"description":"FRI p2p Withdrawal data","properties":{"":{"description":"Currency: `GTQ`","type":"Description:"},"phone_number":{"description":"The recipient's phone number linked to a Fri account to which the withdrawal transfer will be sent (with country code). To complete the withdrawal from the payment wallet, the user must approve the request in the 'Pendientes' section.","maximum":11,"minimum":11,"pattern":"^502[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"fri_p2p","type":"object"},{"description":"ImePay L data","properties":{"":{"description":"Currency: `NPR`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":10,"minimum":10,"pattern":"^[0-9]{10}$","type":"string"}},"required":["phone_number"],"title":"imepay_l","type":"object"},{"description":"IMPS data","properties":{"":{"description":"Currency: `INR`","type":"Description:"},"account_name":{"description":"Receiver account name","maximum":50,"pattern":"^[a-zA-Z\\s]{1,50}$","type":"string"},"account_number":{"description":"Receiver account number","pattern":"^[0-9]+$","type":"string"},"bank_code":{"description":"IFSC code bank","maximum":11,"minimum":11,"pattern":"^[A-Z]{4}0[A-Z0-9]{6}$","type":"string"}},"required":["account_name","account_number","bank_code"],"title":"imps","type":"object"},{"description":"IMPS_top data","properties":{"":{"description":"Currency: `INR`","type":"Description:"},"account_name":{"description":"Receiver account name","maximum":30,"pattern":"^[a-zA-Z\\s]{1,30}$","type":"string"},"account_number":{"description":"Receiver account number","pattern":"^[0-9]+$","type":"string"},"bank_code":{"description":"IFSC code bank","maximum":11,"minimum":11,"pattern":"^[A-Z]{4}0[A-Z0-9]{6}$","type":"string"}},"required":["account_name","account_number","bank_code"],"title":"imps_top","type":"object"},{"description":"INR-p2p data","properties":{"":{"description":"Currency: `INR`","type":"Description:"},"account_email":{"description":"Receiver account email","maximum":100,"type":"string"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^0[0-9]{11}$","type":"string"}},"required":["account_email","account_number"],"title":"inr_p2p","type":"object"},{"description":"Ipay Fast Withdrawal data","oneOf":[{"properties":{"":{"description":"Currency: `LKR`","type":"Description:"},"payment_method":{"description":"Payment method type, must be `phone` for phone payment method","enum":["phone"],"type":"string"},"phone_number":{"description":"Phone number","maximum":10,"minimum":10,"pattern":"^[0-9]+$","type":"string"}},"required":["payment_method","phone_number"],"title":"phone","type":"object"},{"properties":{"":{"description":"Currency: `LKR`","type":"Description:"},"account_name":{"description":"Account name","maximum":50,"minimum":1,"pattern":"^[A-Za-z\\\\s]+$","type":"string"},"account_number":{"description":"Account number","maximum":28,"minimum":5,"pattern":"^[0-9]+$","type":"string"},"bank_name":{"description":"
\n Bank name to make a withdrawal. The supported bank names are listed below:\n\n | № | Bank Name |\n |-----|---------------------------------------------|\n | 1 | LOLC Finance PLC |\n | 2 | Amana Bank PLC |\n | 3 | Axis Bank LTD |\n | 4 | Bank of Ceylon |\n | 5 | Cargills Bank |\n | 6 | Central Finance PLC |\n | 7 | CITI Bank N.A. |\n | 8 | Citizen Development Business Finance PLC |\n | 9 | Commercial Bank PLC |\n | 10 | Deutsche Bank (ASIA) |\n | 11 | DFCC Wardhana Bank |\n | 12 | Dialog Finance Plc |\n | 13 | HABIB Bank LTD |\n | 14 | Hatton National Bank PLC |\n | 15 | HDFC Bank |\n | 16 | HSBC |\n | 17 | ICICI Bank LTD |\n | 18 | LB Finance PLC |\n | 19 | Muslim Commercial Bank LTD |\n | 20 | National Development Bank PLC |\n | 21 | National Savings Bank |\n | 22 | Nations Trust Bank |\n | 23 | Pan Asia Bank LTD |\n | 24 | People's Bank |\n | 25 | People's Leasing |\n | 26 | Public Bank Berhard |\n | 27 | Regional Development Bank |\n | 28 | Richard Pieris Finance |\n | 29 | Sampath Bank PLC |\n | 30 | Sanasa Development Bank |\n | 31 | Sarvodaya Development Finance LTD |\n | 32 | Senkadagala Finance PLC |\n | 33 | Seylan Bank LTD |\n | 34 | Singer Finance (Lanka) PLC |\n | 35 | Standard Chartered Bank |\n | 36 | State Bank Of India |\n | 37 | Union Bank of Colombo PLC |\n | 38 | Union Pay International |\n
","maximum":65,"minimum":3,"pattern":"^[A-Za-z\\\\s.,()']+$","type":"string"},"payment_method":{"description":"Payment method type, must be `bank` for bank payment method","enum":["bank"],"type":"string"}},"required":["payment_method","account_name","account_number","bank_name"],"title":"bank","type":"object"}],"title":"ipay_fast","type":"object"},{"description":"Ipay L Withdrawal data","oneOf":[{"properties":{"":{"description":"Currency: `LKR`","type":"Description:"},"payment_method":{"description":"Payment method type, must be `phone` for phone payment method","enum":["phone"],"type":"string"},"phone_number":{"description":"Phone number","maximum":10,"minimum":10,"pattern":"^[0-9]+$","type":"string"}},"required":["payment_method","phone_number"],"title":"phone","type":"object"},{"properties":{"":{"description":"Currency: `LKR`","type":"Description:"},"account_name":{"description":"Account name","maximum":50,"minimum":1,"pattern":"^[A-Za-z\\\\s]+$","type":"string"},"account_number":{"description":"Account number","maximum":28,"minimum":5,"pattern":"^[0-9]+$","type":"string"},"bank_name":{"description":"
\n Bank name to make a withdrawal. The supported bank names are listed below:\n\n | № | Bank Name |\n |-----|---------------------------------------------|\n | 1 | LOLC Finance PLC |\n | 2 | Amana Bank PLC |\n | 3 | Axis Bank LTD |\n | 4 | Bank of Ceylon |\n | 5 | Cargills Bank |\n | 6 | Central Finance PLC |\n | 7 | CITI Bank N.A. |\n | 8 | Citizen Development Business Finance PLC |\n | 9 | Commercial Bank PLC |\n | 10 | Deutsche Bank (ASIA) |\n | 11 | DFCC Wardhana Bank |\n | 12 | Dialog Finance Plc |\n | 13 | HABIB Bank LTD |\n | 14 | Hatton National Bank PLC |\n | 15 | HDFC Bank |\n | 16 | HSBC |\n | 17 | ICICI Bank LTD |\n | 18 | LB Finance PLC |\n | 19 | Muslim Commercial Bank LTD |\n | 20 | National Development Bank PLC |\n | 21 | National Savings Bank |\n | 22 | Nations Trust Bank |\n | 23 | Pan Asia Bank LTD |\n | 24 | People's Bank |\n | 25 | People's Leasing |\n | 26 | Public Bank Berhard |\n | 27 | Regional Development Bank |\n | 28 | Richard Pieris Finance |\n | 29 | Sampath Bank PLC |\n | 30 | Sanasa Development Bank |\n | 31 | Sarvodaya Development Finance LTD |\n | 32 | Senkadagala Finance PLC |\n | 33 | Seylan Bank LTD |\n | 34 | Singer Finance (Lanka) PLC |\n | 35 | Standard Chartered Bank |\n | 36 | State Bank Of India |\n | 37 | Union Bank of Colombo PLC |\n | 38 | Union Pay International |\n
","maximum":65,"minimum":3,"pattern":"^[A-Za-z\\\\s.,()']+$","type":"string"},"payment_method":{"description":"Payment method type, must be `bank` for bank payment method","enum":["bank"],"type":"string"}},"required":["payment_method","account_name","account_number","bank_name"],"title":"bank","type":"object"}],"title":"ipay_l","type":"object"},{"description":"Itau p2p data","properties":{"":{"description":"Currency: `PYG`","type":"Description:"},"account_number":{"description":"The recipient's account number in Itau to which the funds will be transferred","pattern":"^[0-9]{7,9}$","type":"string"},"receiver_name":{"description":"The recipient's account holder name (as registered with the bank)\n\nExample: Juan Perez Gomez","maximum":50,"minimum":1,"pattern":"^[A-Za-zÁÉÍÓÚÜÑáéíóúüñ ]{1,50}$","type":"string"}},"required":["account_number","receiver_name"],"title":"itau_p2p","type":"object"},{"description":"Jazzcash_l data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_name":{"description":"Receiver account name","maximum":50,"type":"string"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^[0-9]{11}$","type":"string"},"cnic_number":{"description":"CNIC number","maximum":13,"minimum":13,"pattern":"^[0-9]{13}$","type":"string"}},"required":["account_name","account_number"],"title":"jazzcash_l","type":"object"},{"description":"KBZpay P2P data","properties":{"":{"description":"Currency: `MMK`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":11,"minimum":11,"pattern":"^0[0-9]{10}$","type":"string"}},"required":["phone_number"],"title":"kbzpay_p2p","type":"object"},{"description":"Khalti data","properties":{"":{"description":"Currency: `NPR`","type":"Description:"},"phone_number":{"description":"Phone number without country code (+977)","maximum":10,"minimum":10,"pattern":"^[0-9]{10}$","type":"string"}},"required":["phone_number"],"title":"khalti","type":"object"},{"description":"Khalti_l Withdrawal data","properties":{"":{"description":"Currency: `NPR`","type":"Description:"},"phone_number":{"description":"Phone number without country code (+977)","maximum":10,"minimum":10,"pattern":"^[0-9]{10}$","type":"string"}},"required":["phone_number"],"title":"khalti_l","type":"object"},{"description":"Lynk P2P data","properties":{"":{"description":"Currency: `JMD`","type":"Description:"},"account_id":{"description":"Receiver Lynk ID","maximum":50,"minimum":1,"pattern":"^@.{1,50}$","type":"string"}},"required":["account_id"],"title":"lynk_p2p","type":"object"},{"properties":{"":{"description":"Currency: `ARS`","type":"Description:"},"receiver_account_number":{"description":"The recipient’s сlave virtual uniforme (CVU) to receive the funds","maximum":22,"minimum":22,"pattern":"^[0-9]{22}$","type":"string"}},"required":["receiver_account_number"],"title":"mercado_ars_p2p","type":"object"},{"description":"Only Mercado Pago account numbers are supported","properties":{"":{"description":"Currency: `UYU`. Only Mercado Pago account numbers are supported","type":"Description:"},"account_name":{"description":"Receiver account name (Titular de la cuenta destino)","maximum":50,"minimum":3,"pattern":"^[A-Za-zÁÉÍÓÚÜÑáéíóúüñ ]{3,50}$","type":"string"},"account_number":{"description":"Account number of the recipient in Mercado Pago (Número de cuenta)","maximum":13,"minimum":13,"pattern":"^[0-9]{13}$","type":"string"}},"required":["account_name","account_number"],"title":"mercado_uyu_p2c","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"},{"description":"Mpesa data","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"],"title":"mpesa","type":"object"},{"description":"Nagad A","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^[0-9]{11,11}$","type":"string"}},"required":["account_number"],"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":"^[0-9]{11,11}$","type":"string"}},"required":["account_number"],"title":"nagad_api_v","type":"object"},{"description":"Nagad B","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^[0-9]{11,11}$","type":"string"}},"required":["account_number"],"title":"nagad_b","type":"object"},{"description":"Nayapay_l data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_name":{"description":"Receiver account name","maximum":50,"type":"string"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^[0-9]{11}$","type":"string"}},"required":["account_name","account_number"],"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:"},"name":{"description":"Receiver name","maximum":35,"minimum":1,"type":"string"},"phone_number":{"description":"Customer phone number","maximum":12,"minimum":12,"pattern":"^221[0-9]{9}$","type":"string"},"surname":{"description":"Receiver surname","maximum":35,"minimum":1,"type":"string"}},"required":["phone_number","name","surname"],"title":"orange_sen_p2p","type":"object"},{"description":"Paytm data","properties":{"":{"description":"Currency: `INR`","type":"Description:"},"account_number":{"description":"Receiver account number","maximum":10,"minimum":10,"pattern":"^[0-9]{10}$","type":"string"}},"required":["account_number"],"title":"paytm","type":"object"},{"description":"Pix-p2p data","properties":{"":{"description":"Currency: `BRL`","type":"Description:"},"account_number":{"description":"Account number","maximum":11,"minimum":11,"pattern":"^[0-9]{11}$","type":"string"}},"required":["account_number"],"title":"pix_p2p","type":"object"},{"description":"Jazzcash Withdrawal data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_number":{"description":"If you wish to make a withdrawal via EasyPaisa or JazzCash, please use the CNIC number without any dashes or spaces. \nFor any other banking method, please refer to the bank account details.","maximum":20,"minimum":9,"pattern":"^[0-9]{9,20}$","type":"string"},"bank_name":{"description":"Bank name to make a withdrawal. The supported bank names are listed below:\n| № | Bank Name |\n|-----|--------------------------------------------|\n| 1 | ABHI FINANCE SERVICES LIMITED |\n| 2 | AFT |\n| 3 | AFT IBFT |\n| 4 | Advans |\n| 5 | Al Meezan Investment Management Limited |\n| 6 | AlHabib |\n| 7 | Albarka |\n| 8 | Alfalah |\n| 9 | Allied |\n| 10 | Apna |\n| 11 | Askari |\n| 12 | BOK |\n| 13 | BYKEA |\n| 14 | BankIslami |\n| 15 | Burj |\n| 16 | Central Directorate of National Savings |\n| 17 | Central Directorate of National Savings (CDNS) |\n| 18 | Central Directorate of National Savings (CDNS) – 1IBFT IMD Addition |\n| 19 | Citi |\n| 20 | DubaiIslamic |\n| 21 | EZ wage |\n| 22 | EasyPaisa |\n| 23 | FINCA |\n| 24 | FINJA |\n| 25 | FWBL |\n| 26 | Faysal |\n| 27 | First Microfinance Bank |\n| 28 | HBL |\n| 29 | HBL ASSET MANAGEMENT |\n| 30 | Habib Metro Bank – Bulk 1IBFT |\n| 31 | HabibMetro |\n| 32 | Humrah Financial Services |\n| 33 | ICBC |\n| 34 | JS |\n| 35 | KASB |\n| 36 | KBL |\n| 37 | KEENU |\n| 38 | KEENU Bank |\n| 39 | KEENU – IMD and 1IBFT Screen Addition |\n| 40 | Keenu1 |\n| 41 | MCB |\n| 42 | MCB-Arif Habib |\n| 43 | MIB |\n| 44 | Meezan |\n| 45 | MobilinkBank Pakistan |\n| 46 | NAYAPAY |\n| 47 | NBP |\n| 48 | NBP Fund Management Limited |\n| 49 | NBP1 |\n| 50 | NIB |\n| 51 | NRSP |\n| 52 | National Bank |\n| 53 | Numbers Private Limited |\n| 54 | PayMax |\n| 55 | PayMax1 |\n| 56 | PunjabBank |\n| 57 | SADAPAY |\n| 58 | SCB |\n| 59 | SEEDCREED Financial Services Limited |\n| 60 | SIMPAISA |\n| 61 | SIND |\n| 62 | Samba |\n| 63 | Silk |\n| 64 | SindhBank |\n| 65 | Soneri |\n| 66 | Summit |\n| 67 | TAG |\n| 68 | TezPAy |\n| 69 | UBL |\n| 70 | UPaisa |\n| 71 | Waseela |\n| 72 | Waseela bank |\n| 73 | ZTBL1 |\n| 74 | Zarai Taraqiati Bank |\n| 75 | JazzCash |\n| 76 | U Bank |\n| 77 | HBL Express |\n| 78 | UBL Omni |","maximum":67,"minimum":2,"pattern":"^[A-Za-z0-9\\\\s)(–-]{2,67}$","type":"string"},"phone_number":{"description":"Account phone number","maximum":11,"minimum":11,"pattern":"^03[0-9]+$","type":"string"}},"required":["account_number","phone_number","bank_name"],"title":"pkr_w","type":"object"},{"description":"PKR_W2 Withdrawal data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"bank_name":{"description":"Bank name to make a withdrawal. The supported bank names are listed below:\n| № | Bank Name |\n|-----|--------------------------------------------|\n| 1 | ABHI FINANCE SERVICES LIMITED |\n| 2 | AFT |\n| 3 | AFT IBFT |\n| 4 | Advans |\n| 5 | Al Meezan Investment Management Limited |\n| 6 | AlHabib |\n| 7 | Albarka |\n| 8 | Alfalah |\n| 9 | Allied |\n| 10 | Apna |\n| 11 | Askari |\n| 12 | BOK |\n| 13 | BYKEA |\n| 14 | BankIslami |\n| 15 | Burj |\n| 16 | Central Directorate of National Savings |\n| 17 | Central Directorate of National Savings (CDNS) |\n| 18 | Central Directorate of National Savings (CDNS) – 1IBFT IMD Addition |\n| 19 | Citi |\n| 20 | DubaiIslamic |\n| 21 | EZ wage |\n| 22 | EasyPaisa |\n| 23 | FINCA |\n| 24 | FINJA |\n| 25 | FWBL |\n| 26 | Faysal |\n| 27 | First Microfinance Bank |\n| 28 | HBL |\n| 29 | HBL ASSET MANAGEMENT |\n| 30 | Habib Metro Bank – Bulk 1IBFT |\n| 31 | HabibMetro |\n| 32 | Humrah Financial Services |\n| 33 | ICBC |\n| 34 | JS |\n| 35 | KASB |\n| 36 | KBL |\n| 37 | KEENU |\n| 38 | KEENU Bank |\n| 39 | KEENU – IMD and 1IBFT Screen Addition |\n| 40 | Keenu1 |\n| 41 | MCB |\n| 42 | MCB-Arif Habib |\n| 43 | MIB |\n| 44 | Meezan |\n| 45 | MobilinkBank Pakistan |\n| 46 | NAYAPAY |\n| 47 | NBP |\n| 48 | NBP Fund Management Limited |\n| 49 | NBP1 |\n| 50 | NIB |\n| 51 | NRSP |\n| 52 | National Bank |\n| 53 | Numbers Private Limited |\n| 54 | PayMax |\n| 55 | PayMax1 |\n| 56 | PunjabBank |\n| 57 | SADAPAY |\n| 58 | SCB |\n| 59 | SEEDCREED Financial Services Limited |\n| 60 | SIMPAISA |\n| 61 | SIND |\n| 62 | Samba |\n| 63 | Silk |\n| 64 | SindhBank |\n| 65 | Soneri |\n| 66 | Summit |\n| 67 | TAG |\n| 68 | TezPAy |\n| 69 | UBL |\n| 70 | UPaisa |\n| 71 | Waseela |\n| 72 | Waseela bank |\n| 73 | ZTBL1 |\n| 74 | Zarai Taraqiati Bank |\n| 75 | JazzCash |\n| 76 | U Bank |\n| 77 | HBL Express |\n| 78 | UBL Omni |","maximum":67,"minimum":2,"pattern":"^[A-Za-z0-9\\\\s)(–-]{2,67}$","type":"string"},"phone_number":{"description":"Account phone number","maximum":11,"minimum":11,"pattern":"^03[0-9]+$","type":"string"}},"required":["phone_number","bank_name"],"title":"pkr_w2","type":"object"},{"description":"Raast P2P Withdrawal Data","properties":{"":{"description":"Currency: `PKR`","type":"Description:"},"account_number":{"description":"If you wish to make a withdrawal via EasyPaisa or JazzCash, please use the CNIC number without any dashes or spaces. \nFor any other banking method, please refer to the bank account details.","maximum":17,"minimum":9,"pattern":"^[0-9]+$","type":"string"},"bank_name":{"description":"Bank name to make a withdrawal. The supported bank names are listed below:\n| № | Bank Name |\n|-----|--------------------------------------------|\n| 1 | ABHI FINANCE SERVICES LIMITED |\n| 2 | AFT |\n| 3 | AFT IBFT |\n| 4 | Advans |\n| 5 | Al Meezan Investment Management Limited |\n| 6 | AlHabib |\n| 7 | Albarka |\n| 8 | Alfalah |\n| 9 | Allied |\n| 10 | Apna |\n| 11 | Askari |\n| 12 | BOK |\n| 13 | BYKEA |\n| 14 | BankIslami |\n| 15 | Burj |\n| 16 | Central Directorate of National Savings |\n| 17 | Central Directorate of National Savings (CDNS) |\n| 18 | Central Directorate of National Savings (CDNS) – 1IBFT IMD Addition |\n| 19 | Citi |\n| 20 | DubaiIslamic |\n| 21 | EZ wage |\n| 22 | EasyPaisa |\n| 23 | FINCA |\n| 24 | FINJA |\n| 25 | FWBL |\n| 26 | Faysal |\n| 27 | First Microfinance Bank |\n| 28 | HBL |\n| 29 | HBL ASSET MANAGEMENT |\n| 30 | Habib Metro Bank – Bulk 1IBFT |\n| 31 | HabibMetro |\n| 32 | Humrah Financial Services |\n| 33 | ICBC |\n| 34 | JS |\n| 35 | KASB |\n| 36 | KBL |\n| 37 | KEENU |\n| 38 | KEENU Bank |\n| 39 | KEENU – IMD and 1IBFT Screen Addition |\n| 40 | Keenu1 |\n| 41 | MCB |\n| 42 | MCB-Arif Habib |\n| 43 | MIB |\n| 44 | Meezan |\n| 45 | MobilinkBank Pakistan |\n| 46 | NAYAPAY |\n| 47 | NBP |\n| 48 | NBP Fund Management Limited |\n| 49 | NBP1 |\n| 50 | NIB |\n| 51 | NRSP |\n| 52 | National Bank |\n| 53 | Numbers Private Limited |\n| 54 | PayMax |\n| 55 | PayMax1 |\n| 56 | PunjabBank |\n| 57 | SADAPAY |\n| 58 | SCB |\n| 59 | SEEDCREED Financial Services Limited |\n| 60 | SIMPAISA |\n| 61 | SIND |\n| 62 | Samba |\n| 63 | Silk |\n| 64 | SindhBank |\n| 65 | Soneri |\n| 66 | Summit |\n| 67 | TAG |\n| 68 | TezPAy |\n| 69 | UBL |\n| 70 | UPaisa |\n| 71 | Waseela |\n| 72 | Waseela bank |\n| 73 | ZTBL1 |\n| 74 | Zarai Taraqiati Bank |\n| 75 | JazzCash |\n| 76 | U Bank |\n| 77 | HBL Express |\n| 78 | UBL Omni |","maximum":67,"minimum":2,"pattern":"^[A-Za-z0-9\\\\s)(–-]{2,67}$","type":"string"},"phone_number":{"description":"Account phone number","maximum":11,"minimum":11,"pattern":"^03[0-9]+$","type":"string"}},"required":["account_number","phone_number","bank_name"],"title":"raast_p2p","type":"object"},{"description":"Scotiabank data","properties":{"":{"description":"Currency: `JMD`","type":"Description:"},"account_number":{"description":"Account number","maximum":9,"minimum":9,"pattern":"^[0-9]{9}$","type":"string"},"transit_number":{"description":"Transit number","maximum":5,"minimum":5,"pattern":"^[0-9]{5}$","type":"string"}},"required":["transit_number","account_number"],"title":"scotiabank_p2p","type":"object"},{"description":"Spei-p2p data","properties":{"":{"description":"Currency: `MXN`","type":"Description:"},"account_number":{"description":"- If the account number is 18 digits long, it means the account type is: CLABE\n- if the account number is 16 digits long, it means: BANK_CARD","maximum":18,"minimum":16,"pattern":"^[0-9]{16,18}$","type":"string"},"bank_name":{"description":"Bank name to make a withdrawal. The supported bank names are listed below:\n|№ |Bank Name |Description |\n|---|---------------|-------------------------------------------------|\n|1 |ABC_CAPITAL |ABC Capital |\n|2 |ACTINVER |Actinver |\n|3 |AFIRME |Banco Afirme |\n|4 |AKALA |Akala |\n|5 |ALBO |ALBO |\n|6 |ALTERNATIVOS |Alternativos |\n|7 |ARCUS |Arcus |\n|8 |ASP_INTEGRA_OPC|ASP Integra OPC |\n|9 |AUTOFIN |Banco Autofin |\n|10 |AZTECA |Banco Azteca |\n|11 |BABIEN |BaBien |\n|12 |BAJIO |Banco del Bajío |\n|13 |BANAMEX |Banco Nacional de México |\n|14 |BANCOMEXT |Banco Nacional de Comercio Exterior |\n|15 |BANCOPPEL |Banco Coppel |\n|16 |BANCREA |Banco Bancrea |\n|17 |BANJERCITO |Banco del Ejército |\n|18 |BANKAOOL |Bankaool |\n|19 |BANOBRAS |Banco Nacional de Obras y Servicios Públicos |\n|20 |BANORTE |Banco Mercantil del Norte |\n|21 |BANREGIO |Banco Regional de Monterrey |\n|22 |BANSEFI |Banco del Ahorro Nacional y Servicios Financieros|\n|23 |BANSI |Banco Bansi |\n|24 |BANXICO |Banco de México |\n|25 |BARCLAYS |Barclays México |\n|26 |BBASE |BBASE |\n|27 |BBVAMX |BBVA México |\n|28 |BMONEX |Banco Monex |\n|29 |BOA_MX |Bank of America México |\n|30 |BOC_MX |Bank of China México |\n|31 |BX+ |Ve por Más |\n|32 |CAJA_POP_MX |Caja Popular Mexicana |\n|33 |CAJA_TELEFONIST|Caja de Ahorro de los Telefonistas |\n|34 |CASHI_CUENTA |CASHI CUENTA |\n|35 |CB_INTERCAM |Intercam Casa de Bolsa |\n|36 |CBOLSA |Multiva Casa de Bolsa |\n|37 |CI_BOLSA |CI Casa de Bolsa |\n|38 |CIBANCO |Cibanco |\n|39 |CITI_MX |CITI MEXICO |\n|40 |CLS |CLS |\n|41 |CODI_VALIDA |CoDi Valida |\n|42 |COMPARTAMOS |Banco Compartamos |\n|43 |CONSUBANCO |Consubanco |\n|44 |COOPDESARROLLO |COOPDESARROLLO |\n|45 |COVALTO |Banco Covalto |\n|46 |CREDICAPITAL |Credicapital |\n|47 |CREDICLUB |Crediclub |\n|48 |CRISTOBAL_COLON|Cristóbal Colón |\n|49 |CS_MX |Credit Suisse México |\n|50 |CUENCA |Cuenca |\n|51 |DEP_PAG_DIG |Dep y Pag Dig |\n|52 |DONDE |Banco Donde |\n|53 |FINAMEX |Finamex |\n|54 |FINCO_PAY |FINCO PAY |\n|55 |FINCOMUN |Fincomún |\n|56 |FINTERRA |Banco Finterra |\n|57 |FINTOC |FINTOC |\n|58 |FIRA |Fondo (FIRA) |\n|59 |FOMPED |Fompred |\n|60 |FONDEADORA |FONDEADORA |\n|61 |GBM |GBM |\n|62 |HEY_BANCO |HEY BANCO |\n|63 |HIPOTECARIA |Sociedad Hipotecaria Federal |\n|64 |HSBC_MX |HSBC México |\n|65 |ICBC_MX |ICBC México |\n|66 |INBURSA |Banco Inbursa |\n|67 |INDEVAL |Indeval |\n|68 |INMOBILIARIO |Banco Inmobiliario Mexicano |\n|69 |INTERCAM |Banco Intercam |\n|70 |INVERCAP |Invercap |\n|71 |INVEX |Banco Invex |\n|72 |JPM_MX |J.P. Morgan México |\n|73 |KLAR |Klar |\n|74 |KUSPIT |Kuspit |\n|75 |LIBERTAD |Libertad |\n|76 |MASARI |Masari |\n|77 |MERCADO_PAGO_W |Mercado Pago W |\n|78 |MEXPAGO |MexPago |\n|79 |MIFEL |Banco Mifel |\n|80 |MIZUHO_MX |Mizuho Bank México |\n|81 |MONEXCB |Monex Casa de Bolsa |\n|82 |MUFG |MUFG Bank México |\n|83 |MULTIVA |Banco Multiva |\n|84 |NAFIN |Nacional Financiera |\n|85 |NU_MX |Nu México |\n|86 |NVIO |Nvio |\n|87 |PAGATODO |Pagatodo |\n|88 |PEIBO |Peibo |\n|89 |PROFUTURO |Profuturo |\n|90 |REFORMA |Reforma |\n|91 |S3 |Banco S3 |\n|92 |SABADELL |Banco Sabadell México |\n|93 |SANTANDER |Banco Santander México |\n|94 |SCOTIABANK |Scotiabank México |\n|95 |SHINHAN_MX |Shinhan Bank México |\n|96 |STP |STP |\n|97 |SWAP |Swap |\n|98 |TESORED |Tesored |\n|99 |TRANSFER |Transfer |\n|100|TRANSFER_DIRECT|TRANSFER DIRECT |\n|101|UALA |Ualá |\n|102|UNAGRA |Unagra |\n|103|VALMEX |Valmex |\n|104|VALUE |Value |\n|105|VECTOR |Vector |\n|106|VOLKSWAGEN |Volkswagen Bank México |","maximum":50,"minimum":1,"type":"string"}},"required":["account_number","bank_name"],"title":"spei_p2p","type":"object"},{"properties":{"":{"description":"Currency: `BHD`","type":"Description:"},"iban_number":{"description":"IBAN number","maximum":22,"minimum":22,"pattern":"^BH[A-Za-z0-9]{20}$","type":"string"}},"required":["iban_number"],"title":"stcpay_p2p","type":"object"},{"description":"Tap P2P Data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":11,"minimum":11,"pattern":"^[0-9]{11}$","type":"string"}},"required":["phone_number"],"title":"tap_p2p","type":"object"},{"description":"Telebirr Fast Data","properties":{"":{"description":"Currency: `ETB`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":12,"minimum":12,"pattern":"^2519[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"telebirr_fast_p2p","type":"object"},{"description":"UPAY data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_email":{"description":"Receiver account email","maximum":100,"type":"string"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^0[0-9]{10}$","type":"string"}},"required":["account_number"],"title":"upay","type":"object"},{"description":"UPAY-W data","properties":{"":{"description":"Currency: `BDT`","type":"Description:"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^[0-9]{11}$","type":"string"}},"required":["account_number"],"title":"upay_w","type":"object"},{"description":"UPI p2p data","properties":{"":{"description":"Currency: `INR`","type":"Description:"},"account_email":{"description":"Receiver account email","maximum":100,"type":"string"},"account_number":{"description":"Receiver account number","maximum":11,"minimum":11,"pattern":"^0[0-9]{11}$","type":"string"}},"required":["account_email","account_number"],"title":"upi_p2p","type":"object"},{"properties":{"":{"description":"Currency: `BOB`","type":"Description:"},"account_name":{"description":"Recipient's full name (as indicated in the recipient's bank)","maximum":50,"minimum":3,"pattern":"^[A-Za-zÁÉÍÓÚÜÑáéíóúüñ ]{3,50}$","type":"string"},"account_number":{"description":"Recipient's bank account number","maximum":14,"minimum":10,"pattern":"^[0-9]{10,14}$","type":"string"},"bank_code":{"description":"Bank code to make a withdrawal. The supported bank codes are listed below:\n\n№ | Code | Bank name |\n---|-------|-----------------------------|\n1 | nabo | Banco Nacional de Bolivia |\n2 | mesc | Banco Mercantil Santa Cruz |\n3 | crbo | Banco de Crédito de Bolivia |\n4 | union | Banco Unión |\n5 | gana | Banco Ganadero |\n6 | econ | Banco Económico |\n7 | bsol | BancoSol |\n8 | bfie | Banco FIE |\n9 | fort | Banco Fortaleza |\n10 | prod | Banco Prodem |\n11 | peco | Banco PyME Ecofuturo |\n12 | bisa | Banco Bisa |","maximum":5,"minimum":4,"pattern":"^[a-z]{4,5}$","type":"string"}},"required":["account_name","account_number","bank_code"],"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:"},"name":{"description":"Receiver name","maximum":35,"type":"string"},"phone_number":{"description":"Customer phone number from the Wave app","maximum":12,"minimum":12,"pattern":"^221[0-9]{9}$","type":"string"},"surname":{"description":"Receiver surname","maximum":35,"type":"string"}},"required":["phone_number","name","surname"],"title":"wave_sen_p2p","type":"object"},{"description":"wavepay_l data","properties":{"":{"description":"Currency: `MMK`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":11,"minimum":9,"pattern":"^0[0-9]{8,10}$","type":"string"}},"required":["phone_number"],"title":"wavepay_l","type":"object"},{"description":"Wing_l data","properties":{"":{"description":"Currency: `KHR`","type":"Description:"},"account_number":{"description":"Account number","maximum":10,"minimum":8,"pattern":"^[0-9]{8,10}$","type":"string"}},"required":["account_number"],"title":"wing_l","type":"object"},{"description":"Yape Bob P2P Data","properties":{"":{"description":"Currency: `BOB`","type":"Description:"},"phone_number":{"description":"The phone number associated with the Yape app","maximum":8,"minimum":8,"pattern":"^[67][0-9]{7}$","type":"string"}},"required":["phone_number"],"title":"yape_bob_p2p","type":"object"},{"description":"Yape Pen P2P data","properties":{"":{"description":"Currency: `PEN`","type":"Description:"},"phone_number":{"description":"Phone number","maximum":12,"minimum":12,"pattern":"^\\+51[0-9]{9}","type":"string"}},"required":["phone_number"],"title":"yape_pen_p2p","type":"object"},{"properties":{"":{"description":"Currency: `USD`","type":"Description:"},"phone_number":{"description":"The recipient’s phone number linked to a Yappy account to which the withdrawal transfer will be sent (with country code)","maximum":11,"minimum":11,"pattern":"^507[0-9]{8}$","type":"string"}},"required":["phone_number"],"title":"yappy_p2p","type":"object"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"title":"Success","required":["success","status","order_id"],"properties":{"success":{"type":"boolean","description":"`true` if there are no errors"},"status":{"type":"string","enum":["Pending"],"description":"Withdrawal status"},"order_id":{"type":"string","description":"Withdrawal ID in the A-Pay system"},"data":{"type":"object","description":"Payment system specific data"}}},{"title":"Error","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"status":{"type":"string","enum":["Failed"],"description":"Withdrawal status"},"message":{"type":"string","description":"Description of error"},"code":{"type":"number","description":"Error code in the A-Pay system"},"order_id":{"type":"string","description":"Withdrawal ID in the A-Pay system"}}}]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"oneOf":[{"title":"amount of withdrawal is out of limits","description":"amount of withdrawal is out of limits","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"Withdrawal amount exceeds the `min_withdrawal` or `max_withdrawal` [limit](#tag/Payment-system/paths/~1Remotes~1payment-systems-info/get)","default":"amount of withdrawal is out of limits"},"status":{"type":"string","enum":["Failed"],"description":"Deposit status"},"code":{"type":"number","description":"Error code in the A-Pay system"}}},{"title":"amount of withdrawal is more than balance sum","description":"amount of withdrawal is more than balance sum","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"Amount of withdrawal is more than balance sum","default":"amount of withdrawal is more than balance sum"},"status":{"type":"string","enum":["Failed"],"description":"Deposit status"},"code":{"type":"number","description":"Error code in the A-Pay system"}}},{"title":"transaction failed","description":"transaction_failed","required":["success","message","code","order_id"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"failed to create transaction","default":"transaction_failed"},"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"}}},{"title":"payment system data is not valid","description":"payment system data is not valid","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"Validation error in field `data`","default":"payment system data is not valid"},"status":{"type":"string","enum":["Failed"],"description":"Deposit status"},"code":{"type":"number","description":"Error code in the A-Pay system"}}},{"title":"required field missing","description":"required field missing","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"Validation error in request body or parameters","default":"required field missing"},"status":{"type":"string","enum":["Failed"],"description":"Deposit status"},"code":{"type":"number","description":"Error code in the A-Pay system"}}},{"title":"no payment system found with such params or payment system is disabled","description":"no payment system found with such params or payment system is disabled","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"Payment system not found or has been disabled","default":"no payment system found with such params or payment system is disabled"},"status":{"type":"string","enum":["Failed"],"description":"Deposit status"},"code":{"type":"number","description":"Error code in the A-Pay system"}}},{"title":"there are no active end accounts","description":"there are no active end accounts","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"Failed to create withdrawal: there are no active end accounts","default":"there are no active end accounts"},"status":{"type":"string","enum":["Failed"],"description":"Deposit status"},"code":{"type":"number","description":"Error code in the A-Pay system"}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unauthorized_error"}}}}}}}}} ``` All the necessary information can be found in our [API documentation](https://api.a-pay.one/#tag/Withdrawal/paths/~1Remotes~1create-withdrawal/post). **Example of the responses:** {% code title="Success" %} ```json { "success": true, "status": "Pending", "order_id": "7fa13dbc3b79e05e", "data": {} } ``` {% endcode %} {% code title="Error" %} ```json { "success": false, "status": "Failed", "message": "Invalid request", "code": 400, "order_id": "7fa13dbc3b79e05e" } ``` {% endcode %} ### Withdrawal information ## Withdrawal information > \`order\_id\` or/and \`custom\_transaction\_id\` parameters must be set. ```json {"openapi":"3.0.3","info":{"title":"A-Pay","version":"1.0.0"},"tags":[{"name":"Withdrawal","description":"Withdrawals"}],"servers":[{"url":"https://"}],"security":[{"apikey":[]}],"components":{"securitySchemes":{"apikey":{"type":"apiKey","name":"apikey","in":"header"}},"schemas":{"withdrawal_currency":{"type":"string","title":"Currency","enum":["ARS","BDT","BHD","BOB","BRL","EGP","ETB","GNF","GTQ","INR","JMD","KES","KHR","LKR","MMK","MXN","NIO","NPR","PEN","PKR","PYG","TND","USD","UYU","XOF"],"description":"
\n Payment system currency\n \n | Currency | Payment systems | Decimal places |\n |----------|-----------------|----------------|\n | ARS | `cvu_p2p`, `mercado_ars_p2p` | `0` |\n | BDT | `apaybdt`, `bkash_a`, `bkash_api_v`, `bkash_b`, `bkash_p2p`, `nagad_a`, `nagad_api_v`, `nagad_b`, `tap_p2p`, `upay`, `upay_w` | `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` | `0` |\n | ETB | `cbebirr_p2p`, `etb_fast`, `etb_mpesa_p2p`, `etb_p2p`, `telebirr_fast_p2p` | `0` |\n | GNF | `orange_gin_p2p` | `0` |\n | GTQ | `fri_p2p` | `2` e.g. 0.01 |\n | INR | `imps`, `imps_top`, `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` | `0` |\n | MMK | `kbzpay_p2p`, `wavepay_l` | `0` |\n | MXN | `spei_p2p` | `0` |\n | NIO | `ach_p2p` | `2` e.g. 0.01 |\n | NPR | `esewa`, `esewa_p2p`, `imepay_l`, `khalti`, `khalti_l` | `0` |\n | PEN | `yape_pen_p2p` | `0` |\n | PKR | `bankalfalah`, `easypaisa`, `jazzcash`, `jazzcash_l`, `nayapay_l`, `pkr_w`, `pkr_w2`, `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`, `mercado_uyu_p2c` | `0` |\n | XOF | `moov_mli_p2p`, `orange_mli_p2p`, `orange_sen_p2p`, `wave_mli_p2p`, `wave_sen_p2p` | `0` |\n
"},"ps_withdrawal":{"type":"string","title":"Payment system","enum":["ababank","ach_p2p","apaybdt","bancard_qr","banistmo_p2p","bankalfalah","bcgeneral_p2p","bkash_a","bkash_api_v","bkash_b","bkash_p2p","brou_p2p","cbebirr_p2p","cvu_p2p","d17_l","easypaisa","egp_card","egp_fast","egp_tel","esewa","esewa_p2p","etb_fast","etb_mpesa_p2p","etb_p2p","flouci","flouci_l","fri_p2p","imepay_l","imps","imps_top","inr_p2c","inr_p2p","ipay_fast","ipay_l","itau_p2p","jazzcash","jazzcash_l","kbzpay_p2p","khalti","khalti_l","lynk_p2p","mercado_ars_p2p","mercado_uyu_p2c","moov_mli_p2p","mpesa","nagad_a","nagad_api_v","nagad_b","nayapay_l","orange_gin_p2p","orange_mli_p2p","orange_sen_p2p","paytm","phonepe","phonepe_fast","pix_p2p","pkr_w","pkr_w2","raast_p2p","scotiabank_p2p","spei_p2p","stcpay_p2p","tap_p2p","telebirr_fast_p2p","upay","upay_w","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"},"unauthorized_error":{"title":"Unauthorized","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"type":"string","default":"unauthorized","description":"Invalid credentials"},"code":{"type":"number","description":"Error code in the A-Pay system"}}}}},"paths":{"/Remotes/withdrawal-info":{"get":{"tags":["Withdrawal"],"summary":"Withdrawal 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":"Withdrawal 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":"Withdrawal status"},"order_id":{"type":"string","description":"Withdrawal ID in the A-Pay system"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"$ref":"#/components/schemas/withdrawal_currency"},"payment_system":{"$ref":"#/components/schemas/ps_withdrawal"},"custom_transaction_id":{"type":"string","maximum":200,"description":"Transaction ID in the client's system"},"custom_user_id":{"type":"string","maximum":200,"description":"User ID in the client's system. Must be unique for each user"},"created_at":{"type":"integer","description":"Withdrawal creation time in timestamp format"}}},{"title":"Error","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"code":{"type":"number","description":"Error code in the A-Pay system"},"message":{"type":"string","description":"Description of error"}}}]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"oneOf":[{"title":"required field missing","description":"required field missing","required":["success","message","code"],"properties":{"success":{"type":"boolean","description":"`false` if an error occurred"},"message":{"description":"Validation error in request body or parameters","default":"required field missing"},"code":{"type":"number","description":"Error code in the A-Pay system"}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unauthorized_error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","title":"Transaction was not found","properties":{"success":{"type":"boolean","default":false},"code":{"type":"integer","default":404},"message":{"type":"string","default":"invalid order","description":"Transaction was not found"}},"required":["code","error","success","message"]}}}}}}}}} ``` **Examples 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, "code": 400, "message": "Invalid request" } ``` {% endcode %}