Create withdraw request v2
Withdraw requests can only be initiated by merchants using API key and signature authentication.
When a withdraw request is received, the system verifies the available balance and checks for any pending withdrawals. Pending withdrawals temporarily reserve a portion of the merchant's balance until the request is either approved or rejected.
Note: For BankTransfer withdrawals, each country may require a different type of request to be submitted. The specific requirements for your country can be found in the right-side menu.
Request parameters
Responses
Examples
Bank Transfer Withdrawal
Destination Types by Country
The destinationType object structure varies depending on the destination country. Below are the supported types for each country:
Argentina
Currency Support
ARS (Argentine Peso)
USD (US Dollar)
ALIAS
Full request example
CBU
Full request example
Brazil
Currency Support
BRL (Brazilian Real)
Brazil Account
Full request example
PIX
Full request example
Brazil PIX Keys
When providing documentNumber with PIX, a verification is performed to ensure the document matches the PIX key
Brazil Account Types
CACC: Current Account
SVGS: Savings Account
TRAN: Transfer Account
SLRY: Salary Account
Chile
Currency Support
CLP (Chilean Peso)
Chile Account
Full request example
Mexico
Currency Support
MXN (Mexican Peso)
USD (US Dollar)
Clabe
Full request example
Paraguay
Currency Support
PYG (Paraguayan Guaraní)
Paraguay account
Document number format
If you select RUC, the document number must have a check digit (example 80221430-7), if CI is selected, the document number does not have a check digit (example 6532142).
Full request example
Paraguay Bank Codes
Bank Code | Bank Name |
|---|---|
1 | BANCO CENTRAL DEL PARAGUAY |
2 | BANCO NACIONAL DE FOMENTO |
3 | BANCO DE LA NACION ARGENTINA |
4 | BANCO GNB PARAGUAY S.A. |
5 | BANCO DO BRASIL S.A. |
6 | CITIBANK N.A. |
8 | SUDAMERIS BANK S.A.E.C.A. |
17 | BANCO ITAU PARAGUAY S.A. |
20 | BANCO CONTINENTAL S.A. |
30 | BANCO BASA (ex - Amambay) |
39 | VISION BANCO S.A.E.C.A. |
40 | BANCO RIO S.A.E.C.A. (Ex - Itapua) |
41 | BANCO FAMILIAR S.A.E.C.A. |
42 | BANCO ATLAS |
43 | BANCOP S.A. |
44 | INTERFISA BANCO |
6557 | FINANCIERA UENO S.A.E.C.A. |
6558 | CRISOL Y ENCARNACION FINANCIERA S.A. |
6559 | FINLATINA S.A. DE FINANZAS |
6560 | FINANCIERA PARAGUAYO-JAPONESA S.A.E.C.A. |
6561 | FINANCIERA EXPORTADORA PARAGUAYA S.A. |
6564 | SOLAR S.A. DE AHORRO Y PRESTAMO PARA LA VIVIENDA |
6565 | TU FINANCIERA S.A. |
7079 | FIC S.A. DE FINANZAS |
Peru
Currency Support
PEN (Peruvian Sol)
Peru account
Full request example
Europe
Currency Support
EUR (Euro)
GBP (Pound Sterling)
PLN (Polish Złoty)
Request fields
Destination Types
The destinationType object requires the field type.
Send only one of the following values and provide the required fields for the selected type.
Supported Types
Iban
Bban
SortCode
BankCode
Wallet
Iban
Full request example
Bban
Full request example
SortCode
Full request example
BankCode
Full request example
Wallet
Full request example
Callbacks
The withdraw callback will be sent to the merchant transaction status webhook URL if no
callbackUrlis providedTo specify a different callback destination, include
callbackUrlin the request body
Reference Tables
Currency Codes
Code | Name |
|---|---|
ARS | Argentine Peso |
BRL | Brazilian Real |
CLP | Chilean Peso |
MXN | Mexican Peso |
USD | US Dollar |
PYG | Paraguayan Guarani |
PEN | Peruvian Sol |
EUR | Euro |