# Welcome to PandaBlue
We're excited to introduce our **newly redesigned documentation**, built to help you integrate with PandaBlue more effectively and efficiently.\
Whether you're a onboarding or a long-time merchant, this guide is your central resource for understanding how our platform works.
### How to navigate this Guide
We've structured the guide to follow a logical path from initial setup to advanced features. Based on the main sections in the navigation panel, here’s a quick overview of what you'll find:
* **Getting started**: This is your essential first stop. It covers the basics of starting your onboarding, authentication, environments, and the fundamental concepts you'll need to start making calls.
* **Deposits**: This section covers everything related to receiving payments. You'll find detailed explanations on:
* Our payment method Coverage and available Solutions.
* Step-by-step guides to Create deposits and understanding the payment Status flow.
* Information on Refunding a deposit.
* **Cashouts**: Here you'll learn how to send payouts.
* This section includes guides on Countries validations.
* How to Create cashouts.
* And the Status flow for payouts.
* **Platforms Booster**: For our partners offering platform based services, this section details the
* Onboarding process
* and how to Manage Submerchants payments
We recommend starting with the Getting started section and then moving on to the product you wish to integrate first.
{% hint style="success" %}
#### Navigation tips
Through out this site you will find a lot of Buttons pointing you to useful resources!
{% endhint %}
# Getting started
### Explore our products
**Payments solutions**
Solution
Description
Deposits
This is our solution to help you collect payments, with worldwide coverage and local expertise. Payment methods of all varieties: credit cards, bank transfers, cash vouchers and wallets. You will find different types of integrations and tools to achieve your perfect integration. This technical solutions scopes all sort of deposit flows: one-type payments, subscriptions, card-on-file, and more.
Cashouts
With this solution you will have the capability of generating local cashouts in all our coverage. Payout methods can take shake of bank transfers, cash vouchers and payouts to wallets.
Platforms Booster
This is the solution for clients that have a platform-alike solution and need to create transaction on behalf of Submerchant accounts, acting as technology partner for them.
{% hint style="info" %}
#### Other solutions
Besides payments processing we provide high-value API integrations to fulfill technological and business requirements to safely operate and smoothly incorporate our solutions in your day-to-day.
* [**Know Your Customer API**](https://docs.d24.com/api-reference/know-your-customer-api/security-aspects): very useful to retrieve information about your client.
* [**Reconciliation API**](https://docs.d24.com/api-reference/reconciliation-api/security-aspects): to blend the information accessible from Merchant Panel within your internal systems.
* [**Bank Account Validation API**](https://docs.d24.com/api-reference/cashouts-api/validate-bank-accounts): validate if a bank account exists and check the correct format
{% endhint %}
### Create a merchant account
By filling this Form our Sales team will get in touch with you and guide you through our **onboarding process**.
Meanwhile, our team will create your **merchant account** in order to start your integration on a parallel track.
### Access the Merchant Panel
Once your merchant account is created, you will have access to the Merchant Panel within the Staging environment:
{% hint style="success" %}
#### :e-mail: Activation email
Once your application is approved, we will send an activation email to your registered address.
* From: **`merchants@d24.com`**
* Subject: **Activate your account**
Please click the **activation link** inside this email to set your password and log in for the first time.
🗓️ The email is usually sent within **one business day** of your account approval.
:question:What if I don't receive the email?
1. Check your spam/junk folder
2. Add `merchants@d24.com` to your email contacts to ensure delivery.
3. Get in touch: if you still haven't received it after 48 hours, please reach out to our commercial team.
❗️ **Important security note**: For your protection, only trust emails sent from the `merchants@d24.com` address. We will never ask for your password or financial details via email.
{% endhint %}
Follow this guide to learn our integration concepts and quickstart your integration.
***
## Next steps
# Get your API Keys
### Environments
We will provide access to our **Staging environment** and when your integration is ready, we will grant you access to **Production environment**. \
Still, you will keep your Staging account for you to test whatever you need.
In each environment you will have your own Merchant account. Each with its own set of credentials and Merchant Panel access.
Within the Merchant Panel you will easily distinguish the environments by the page logo.
#### **URLs**
Environment
URL
Staging
https://api-stg.pandablue.com
Production
https://api.pandablue.com
### API Credentials
#### **Deposits**
Application
Name as in the Merchant Panel
API Reference
Deposits API
API Key
X-Login
Deposits API
API Signature
Signature
Fragments SDK
API Public Key
publicKey
Read Only Endpoints
Read Only API Keys
#### **Cashouts**
Application
Name as in the Merchant Panel
API Reference
Cashouts API
API Key
login
Cashouts API
API Passphrase
pass
Cashouts API
API Signature
Payload-Signature
Read Only Endpoints
Read Only API Keys
### Retrieve your credentials
You can access and manage your API Keys within the Staging and Production Merchant Panels.
After logging in, go to ***Settings*** :arrow\_right: ***API access.***
# Important configurations
### Whitelist IPs
Remember to ***include your IPs*** within the correct API's IP list, by simply entering the addresses manually.
{% hint style="success" %}
Pro-tip: you can insert an IP range if needed, like `192.168.1.0/24` and we will whitelist the whole range.
{% endhint %}
### Configure default URLs
Is the section right below, you will find the default URL section. Please configure your default URLs for
URL
Description
Return URL
The Return URL is the address to which the user or system is redirected after completing the payment process in case of being redirected to one of checkout pages.
Refund URL
Whenever the status of a refund changes, we will send you an asynchronous notification to this URL.
Confirm URL
Whenever the status of a deposit changes, we will send you an asynchronous notification to this URL.
Withdrawal URL
Whenever the status of a payout changes, we will send you an asynchronous notification to this URL.
{% hint style="success" %}
Have in mind that this are default URLs and all of them can be overriden with specific URLs that can be included in the JSON request of the transaction. The default URLs will be used if no URL is declared in the API request.
{% endhint %}
# Start testing
### Steps to test a payment
1. Set up authentication headers.
2. Build the API request you want to simulate using test data.
3. Send the request to the Staging endpoint and simulate different responses.
4. Check the response and your webhook notification.
5. Get the transaction status.
### Integration checklist
Make sure to test the following points in order to ensure that your integration is ready.
{% columns %}
{% column %}
Deposits
* [x] Create deposits
* [x] Manually approve and cancel (at least) one deposit from the STG Merchant Panel
* [x] Make sure you are receiving and handling our notifications correctly in your site
* [x] Retrieve the deposit status endpoint accordingly
* [x] Use the Payment Methods endpoint to retrieve payment methods availability
{% endcolumn %}
{% column %}
Cashouts
* [x] Create payouts
* [x] Manually complete and reject (at least) one cashout from the STG Merchant Panel
* [x] Make sure you are receiving and handling our notifications correctly in your site
* [x] Retrieve the cashout status endpoint accordingly
* [x] Use the Cashout Banks endpoint to check the local banks availability
{% endcolumn %}
{% endcolumns %}
#### Testing cards
When testing deposits with credit cards, you can use the following card numbers for testing to match the desired transaction outcome.
Brand
Card Number
Result
Visa
4222222222222220
Card Rejected.
Visa
4000000000000060
Card Expired.
Visa
4444444444444440
Insufficient funds.
Visa
4000000000000110
Card reported as stolen.
Visa
4000000000000040
The card issuer rejected the payment because of their anti-fraud rules.
Mastercard
5454545454545450
Card Rejected.
Mastercard
5555555555554440
Card Expired.
Mastercard
5105105105105100
Insufficient funds.
Mastercard
5451951574925480
Card reported as stolen.
Mastercard
5406251139676600
The card issuer rejected the payment because of their anti-fraud rules.
American Express
340000000000009
Card Rejected.
American Express
373737373737374
Card Expired.
American Express
370000000000002
Insufficient funds.
American Express
343434343434343
Card reported as stolen.
American Express
341111111111111
The card issuer rejected the payment because of their anti-fraud rules.
JCB
3530185156387080
Card Rejected.
JCB
3566002020360500
Card Expired.
JCB
3555555555555552
Insufficient funds.
JCB
3539189698635270
Card reported as stolen.
JCB
3588430314874690
The card issuer rejected the payment because of their anti-fraud rules.
### Manually approve transactions in Staging
In order to test the full flow you can manually change deposits and withdrawals statuses.
Login into the [STG Merchant Panel](https://merchants-stg.pandablue.com/login) and going to Transactions :arrow\_forward: Deposits/Withdrawals and you will be capable of updating the status from the Grid view, or by going into the transaction details!\
\
After performing the status change of the transaction, we will be **sending the respective notification to your `notification_url` after a few minutes**.
# Go live
### Ready to go live?
When your integration is complete, click "**Request go live**" button in the STG Merchant Panel.
It will appear in the Homepage, within the top right corner.
To ensure a seamless launch, our team will then carefully review your test transactions to confirm a correct setup. Once approved, we will promptly email the activation link for your production account.
### Configure your production account
Your account is approved and ready for its final setup. Complete the following technical steps to enable live transaction processing.
* [x] [Configure production domain URL](/getting-started/get-your-api-keys#urls)
* [x] [Retrieve production API Keys](/getting-started/get-your-api-keys#retrieve-your-credentials)
* [x] [Whitelist your production servers IPs](/getting-started/important-configurations#whitelist-ips)
* [x] [Set up default webhook URLs](/getting-started/important-configurations#configure-default-urls)
# Using LLMs with PandaBlue
Leverage LLMs for intelligent PandaBlue API integration.
To help you integrate with PandaBlue more efficiently, we have made our documentation accessible to **Large Language Models (LLMs)** and AI-powered development tools. By providing our content in machine-readable formats, you can easily build, query, and automate tasks using the PandaBlue platform.
This guide covers the resources we provide: a high-level discovery file (**`llms.txt`**), a bulk content file (**`llms-full.txt`**), granular access to our guides in plain text **Markdown** (**`.md`**) and a powerful feature to let you **ask your favorite LLMs** effortless through specific page content.
### **The `llms-full.txt` File**
For efficient bulk ingestion, the `/llms-full.txt` file provides the entire content of our documentation consolidated into a single Markdown file. This is the most effective way to feed all of our documentation into a system at once.
PandaBlue `llms-full.txt` Location:
```
https://docs.PandaBlue.com/llms-full.txt
```
### **Markdown guides**
For direct access to specific pages, every guide in our documentation is available in a raw **Markdown (`.md`)** format. This removes all complex web formatting (HTML, CSS), making it trivial for a script or LLM to parse the text. To retrieve the Markdown source for any guide, simply append `.md` to its URL.
**Example:**
* **Standard URL:** `https://docs.pandablue.com/docs/using-llms-with-pandablue`
* **Markdown URL:** `https://docs.pandablue.com/docs/using-llms-with-pandablue.md`
### Ask your LLM
{% columns %}
{% column width="66.66666666666666%" %}
All pages within the documentation allow users to:
* copy the whole content in Markdown
* view the page in markdown format straight in the web browser
* open a conversation with your favorite LLMs with all the page content, for you to ask, troubleshoot or understand deeper!
You will find this interactive button (shown in the image) in the top right corner of the page.
{% endcolumn %}
{% column width="33.33333333333334%" %}
{% endcolumn %}
{% endcolumns %}
# Overview
Our deposits solution enable merchants to collect payments from their users all around the globe with their favorite and local payment methods.
### Choose the best solution for your needs
Server2Server
Fragments (Lite)
Fragments (all-in-one)
OneShot
Integration effort
+++
+++
++
+
UI customization
Fully customizable
Fully customizable
Highly customizable
Customize branding
Payment flow
Synchronous
Synchronous
Asynchronous
Asynchronous
PCI Compliance
PCI DSS
N/A
N/A
N/A
Subscriptions
Yes
Yes
No
Yes
Installments
Yes
Yes
Yes
Yes
Payment types
Credit cards
Credit cards
Credit cards
Credit cards APMs*
**\***APMs stands for Alternative Payment Methods, they are very popular in emerging markets. These can be bank transfer solutions, wallets, or even cash vouchers.
### Our solutions for collecting deposits
{% hint style="success" %}
Check with your commercial representative regarding other countries and payment methods not in these lists.
{% endhint %}
### Availability
{% columns %}
{% column width="58.333333333333336%" %}
You can retrieve the payment methods your account has enabled by using the Get payment methods endpoint.
On the Merchant Panel you can check what Payment Methods your account has enabled by going to the "Payment Methods" section on the left menu. The Payment Method availability is real time updated on the panel.
{% endcolumn %}
{% column %}
{% endcolumn %}
{% endcolumns %}
{% hint style="success" %}
### Can't find the payment method you are looking for?
No worries, get in touch with you commercial representative and we will enable it right away.
{% endhint %}
### Considerations
1. Notice that not every payment method is available in Staging.
2. Some methods may not be available within an iframe due to our processor's security requirements. In those cases, we will ask the customer to open the payment page on a new window.
3. The checkout sites may differ in styles between Staging and Production.
### Flows
Flow
Description
Embbeded
In the Embbeded flow, you will receive all the details needed to build a payment page on your own website. For example, the Pix's QR Code, digitable line, expiration, amount, payment link, etc.
Redirect
In the Redirect flow, we will respond you with a link you should use to redirect your customers so they can pay.
# Template country page
This is a template page, while copy/pasting please remove all that do not apply.
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
AR
ARS and USD
2
DNI, CUIT, or CUIL
Between 7 to 9, or 11 digits
Yes
### Card features
Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture
true
true
true
true
false
***
### Brands available
{% hint style="success" %}
### `payment_method` code `CC`
As the payers will be capable to input any card in the displayed checkout form ,the OneShot and Fragments all-in-one solution, we recommend using the payment method code **`CC`** in the API requests, which is a generic code.
After the payment is attempted, merchants will be capable to know with which card the user paid.
{% endhint %}
Logo
payment_method
Name
VI
Visa
VD
Visa Debit
MC
Mastercard
MD
Mastercard Debit
AE
American Express
CL
Cabal
EL
Elo
ELD
Elo Debit
JC
JCB
DC
Diners Club
HI
Hipercard
### Alternative Payment Methods available
Logo
payment_method
Name
payment_type
Flows
IX
Pix
BANK_TRANSFER
Embbeded, Redirect
PC
PSE
BANK_TRANSFER
Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
***
### User Interface tips
#### `BANK_TRANSFER`s
Skeleton spei
Skeleton codi
### `VOUCHER`s
Skeleton Oxxo
### Payment flows
#### Transferencias SPEI
The user selects **SPEI** as the payment method. A **CLABE** number (bank account code) appears on the screen. The user copies it, opens their banking app, selects “transfer,” pastes the CLABE, and completes the payment. Once confirmed, the funds are sent in real time.
#### CoDi
After selecting **CoDi**, the user provides basic info, and a **QR code** appears on screen. They open their bank’s mobile app, select the CoDi scan option, upload the code, and confirm the transaction. The payment is completed in seconds.
#### `VOUCHER`s
After choosing **7-Eleven (for example)** as the payment method, the user fills in their personal info and receives a reference number. They take this number to any **7-Eleven** store, give it to the cashier, and pay in cash. The system updates the payment automatically once it’s received.
{% hint style="success" %}
#### `VOUCHER` type payment methods
Note that, even though the example provided is from 7Eleven, the flow described above applies for all the payment methods with type `VOUCHER`.
It applies for Oxxo, Bodega Aurrera, Circulo K, Walmart ... and more.
Cash vouchers are very popular in Mexico.
{% endhint %}
# America
# Argentina
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
AR
ARS and USD
2
DNI or CUIL
Between 7 to 9, or 11 digits
Yes
### Card features
Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture
false
false
true
false
false
***
### Brands available
{% hint style="success" %}
### `payment_method` code `CC`
As the payers will be capable to input any card in the displayed checkout form ,the OneShot and Fragments all-in-one solution, we recommend using the payment method code **`CC`** in the API requests, which is a generic code.
After the payment is attempted, merchants will be capable to know with which card the user paid.
{% endhint %}
Logo
payment_method
Name
VI
Visa
VD
Visa Debit
MC
Mastercard
MD
Mastercard Debit
AE
American Express
CL
Cabal
DC
Diners Club
### Alternative Payment Methods available
Logo
payment_method
Name
payment_type
Allowed Flows
CVU
Transferencia bancaria
BANK_TRANSFER
Embbeded, Redirect
ME
MercadoPago
BANK_TRANSFER
Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
***
### Payment flows
#### Transferencias bancarias
Upon selecting **bank transfer**, a voucher with a **CVU** (bank account number) is displayed. The user copies the CVU, opens their banking app, selects the option to pay by CVU, pastes the number, and confirms. The transaction is finalized in real time.
# Bolivia
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
BO
BOB and USD
2
NIT
Numeric. Length 12
Yes
### Card features
Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture
false
false
false
false
false
***
### Brands available
{% hint style="success" %}
### `payment_method` code `CC`
As the payers will be capable to input any card in the displayed checkout form ,the OneShot and Fragments all-in-one solution, we recommend using the payment method code **`CC`** in the API requests, which is a generic code.
After the payment is attempted, merchants will be capable to know with which card the user paid.
{% endhint %}
Logo
payment_method
Name
VI
Visa
VD
Visa Debit
MC
Mastercard
MD
Mastercard Debit
### Alternative Payment Methods available
Icon
payment_method
Name
Payment Type
Flows
TMO
Tigo
VOUCHER
Redirect, Embbeded
YP
Yape
VOUCHER
Redirect, Embbeded
SMPL
Simple
VOUCHER
Embbeded, Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
***
# Brazil
{% hint style="warning" %}
*Effective December 23, the payment method Boleto is no longer available due to updated Brazilian regulations set to take effect on January 1, 2025. We apologize for any inconvenience and appreciate your understanding.*
{% endhint %}
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
BR
BRL and USD
2
CPF
Numeric.
Length 11
(Validate verifier-digits)
Yes
### Card features
Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture
true
true
true
true
false
***
### Multiplo cards
Some Brazilian bank cards, called "*Multiplo*" cards, can be used for both credit and debit.
#### Server2Server
Within our **Server2Server** integration, by default, we treat them as credit cards.\
However, you can use the **`credit_card.payment_mode`** setting to force a transaction to be **`DEBIT`** or **`CREDIT`**. This lets you give customers a choice, like using debit for a one-time payment or credit to pay in installments.
#### Card-on-file
For cards you have saved:
* If you don't specify the type, it will use the type you originally saved (credit or debit).
* If you use **`credit_card.payment_mode`**, it will use whatever you specify for that single transaction.
### Brands available
{% hint style="success" %}
### `payment_method` code `CC`
As the payers will be capable to input any card in the displayed checkout form ,the OneShot and Fragments all-in-one solution, we recommend using the payment method code **`CC`** in the API requests, which is a generic code.
After the payment is attempted, merchants will be capable to know with which card the user paid.
{% endhint %}
Logo
payment_method
Name
VI
Visa
VD
Visa Debit
MC
Mastercard
MD
Mastercard Debit
AE
American Express
CL
Cabal
EL
Elo
ELD
Elo Debit
DC
Diners Club
HI
Hipercard
### Alternative Payment Methods available
Logo
payment_method
Name
payment_type
Available for test
IX
Pix
BANK_TRANSFER
Embbeded, Redirect
PP
PicPay
VOUCHER
Embbeded, Redirect
BB
Banco do Brasil
BANK_TRANSFER
Embbeded, Redirect
CA
Caixa
BANK_DEPOSIT
Embbeded, Redirect
I
Itaú
BANK_TRANSFER
Embbeded, Redirect
B
Bradesco
BANK_TRANSFER
Embbeded, Redirect
SB
Santander
BANK_DEPOSIT
Embbeded, Redirect
BZ
Banco Original
BANK_DEPOSIT
Embbeded, Redirect
SF
Banco Safra
BANK_DEPOSIT
Embbeded, Redirect
UL
Banrisul
BANK_DEPOSIT
Embbeded, Redirect
NU
Nubank
BANK_TRANSFER
Embbeded, Redirect
ME
MercadoPago
BANK_TRANSFER
Embbeded, Redirect
ICSH
iCash
VOUCHER
Embbeded, Redirect
SUA
SUAPI
WALLET
Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
phone
address[]
Payment method name
document
email
first_name
last_name
phone
address[]
Boleto
Yes
Yes
Yes
Yes
No
Yes
Banco do Brasil
Yes
Yes
Yes
Yes
No
Yes
Itaú
Yes
Yes
Yes
Yes
No
Yes
PicPay
Yes
Yes
Yes
Yes
Yes
No
All the other payment methods
Yes
Yes
Yes
Yes
No
No
#### `address[]` object requirements
Payment Method Name
Required for deposits above
street
city
state
zip_code
Payment method name
Required for deposits above
street
city
state
zip_code
Boleto
USD 3000
Yes
Yes
Yes
Yes
Banco do Brasil
USD 200
Yes
Yes
Yes
Yes
Itaú
USD 200
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
***
### Payment flows
#### Pix
The user selects **Pix** and chooses the option “**Copia e Cola**.” A payment code is generated, which they copy and paste into their bank app under the Pix section. After confirming the transaction, the payment is completed instantly.
# Chile
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
CL
CLP and USD
2
ID, RUN or RUT
Length 8 or 9
Yes
### Card features
Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture
false
false
true
false
false
***
### Brands available
{% hint style="success" %}
### `payment_method` code `CC`
As the payers will be capable to input any card in the displayed checkout form ,the OneShot and Fragments all-in-one solution, we recommend using the payment method code **`CC`** in the API requests, which is a generic code.
After the payment is attempted, merchants will be capable to know with which card the user paid.
{% endhint %}
Logo
payment_method
Name
VI
Visa
VD
Visa Debit
MC
Mastercard
MD
Mastercard Debit
AE
American Express
DC
Diners Club
### Alternative Payment Methods available
Icon
payment_method
Name
payment_type
Flows
WP
WebPay
CREDIT_CARD*
Redirect
BE
Banco Estado
BANK_DEPOSIT
Redirect
BX
Banco de Chile
BANK_DEPOSIT
Redirect
CI
Banco BCI
BANK_DEPOSIT
Redirect
LE
Banco CrediChile
BANK_DEPOSIT
Redirect
LL
Banco Falabella
BANK_DEPOSIT
Redirect
IA
Itaú
BANK_DEPOSIT
Redirect
SC
Banco Santander
BANK_DEPOSIT
Redirect
ST
Scotiabank
BANK_DEPOSIT
Redirect
MAC
Mach
WALLET
Redirect
KH
Khipu
WALLET
Redirect
TAPP
Tapp
WALLET
Redirect
**\*** Even though WebPay is a `CREDIT_CARD` type solution, it must be used with the regular Create deposit endpoint as it requires to redirect the user.
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
***
# Canada
{% hint style="danger" %}
Please be aware that our service is currently unavailable in this Country. We are working to restore service as quickly as possible. Thank you for your patience.
{% endhint %}
## Country specifications
country code
currency code
amount decimals
document name
document format
document required?
CA
CAD and USD
2
DL (Drivers Licence)
Numeric. Length between 6 and 9 inclusive,
Or alphanumeric between 10 and 15 inclusive
Yes
***
### Alternative Payment Methods available
Logo
payment_method
Name
payment_type
Flows
IF
Interac Etransfer
VOUCHER
Redirect
IR
Interac Online
BANK_TRANSFER
Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
# Colombia
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
CO
COP and USD
2
NIT
Numeric. Length between 8 and 15.
Yes
### Card features
Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture
false
false
true
false
false
***
### Brands available
{% hint style="success" %}
### `payment_method` code `CC`
As the payers will be capable to input any card in the displayed checkout form ,the OneShot and Fragments all-in-one solution, we recommend using the payment method code **`CC`** in the API requests, which is a generic code.
After the payment is attempted, merchants will be capable to know with which card the user paid.
{% endhint %}
Logo
payment_method
Name
VI
Visa
VD
Visa Debit
MC
Mastercard
MD
Mastercard Debit
AE
American Express
CL
Cabal
DC
Diners Club
### Alternative Payment Methods available
Logo
payment_method
Name
Payment Type
Flows
BREB
BREB
BANK_TRANSFER
Redirect, Embbeded
ME
MercadoPago
WALLET
Redirect
EY
Efecty
VOUCHER
Embbeded, Redirect
PC
PSE
BANK_DEPOSIT
Redirect
NQ
Nequi
BANK_DEPOSIT
Embbeded, Redirect
JE
JER
VOUCHER
Redirect
CX
Su Chance
VOUCHER
Embbeded, Redirect
XU
Con Suerte
VOUCHER
Embbeded, Redirect
XC
Coopenessa
VOUCHER
Embbeded, Redirect
DQ
Edeq
VOUCHER
Embbeded, Redirect
DX
Dimonex
VOUCHER
Embbeded, Redirect
FG
FullCarga
VOUCHER
Embbeded, Redirect
MR
Moviired
VOUCHER
Embbeded, Redirect
SR
Su Suerte
VOUCHER
Embbeded, Redirect
SZ
Surti Mayorista
VOUCHER
Embbeded, Redirect
RD
Su Red
VOUCHER
Embbeded, Redirect
TRYA
TransFiYa
VOUCHER
Embbeded, Redirect
TP
TPAGA
WALLET
Embbeded, Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
***
### Payment flows
#### PSE
After choosing **PSE**, the user completes a basic form and **selects their bank****\*** from a list. They are securely **redirected** to their online banking environment to review and authorize the payment. Once confirmed, the transaction is processed immediately.
**\*** Merchants can avoid the first redirection to our checkout where the user needs to select their bank. \
In order to do so, merchants should display on their checkout a dropdown/scrollable list for the users to select their bank and afterwards add the **`sub_payment_method`** field to the deposit request to use this flow. \
Below you will find the list of banks:
PSE sub_payment_method bank list and codes.
Bank name
sub_payment_method
Rappipay
RPP
Bancamia
BMI
Banco de Bogotá
BDB
Banco Popular
BPC
Banco GNB Sudameris
GNB
Banco Caja Social
BCJ
Banco Agrario
AGR
Banco Davivienda
BDA
Bancolombia
BN
Banco AV Villas
BAV
Bancoomeva
BCM
Banco Finandina
BFB
Banco Cooperativo Coopcentral
BCC
Banco Santander Colombia
SC
Banco Serfinanza
BSF
BBVA Colombia
AV
Lulo Bank
BLU
Dale
DAL
CFA Cooperativa Financiera
CFA
Citibank
CK
Cotrafa
COT
Coofinep Cooperativa Financiera
CCF
Confiar Cooperativa Financiera
CON
Banco Union antes giros
BUG
Coltefinanciera
COL
Daviplata
DVP
Falabella
LL
BAN100 (formerly Banco Credifinanciera)
BCR
Itau
I
Iris
IRS
Movii S.A.
MR
Nequi
NQ
Banco de occidente
OC
Pichincha
IX
Scotiabank Colpatria
ST
#### Nequi
The user selects **Nequi**, enters required personal information, and a **QR code** is generated. They download or scan it using their Nequi app, confirm the transaction within the app, and the payment is instantly processed.
# Costa Rica
Check the list of Payment Methods available on Costa Rica
{% hint style="warning" %}
*PayPal is currently down due to operational issues. We’re working to resolve this and appreciate your patience.*
{% endhint %}
## Payment Methods
| Icon | payment\_method | Name | Flow | Payment Type | Available for test | Supports iFrame |
| :-------------------------------------------------------------: | :-------------: | -------------- | :----------------------------------------------------: | :-----------: | :----------------: | :-------------: |
| | `PPL` | PayPal |
REDIRECT ONE\_SHOT
| VOUCHER | Yes | Yes |
| | `PTH` | Punto Hey | `REDIRECT` | VOUCHER | Yes | Yes |
| | `BNA` | Banco Nacional | `REDIRECT` | BANK\_DEPOSIT | Yes | Yes |
{% hint style="success" %}
Use the [Payment Methods Endpoint](broken://pages/-M7hYgDIPRyR1p3XGmws) to retrieve the Payment Methods' types, logos and more details.
{% endhint %}
### Fields required for the [OneShot Experience](broken://pages/-M7hYU7T42-pbXYXjrnh#oneshot-experience)
| Payment Method Name | country | amount | payer\[] | payment\_method |
| ------------------- | :-----: | :----: | :------: | :-------------: |
| All | Yes | Yes | Yes | Yes |
###
### Payer object requirements
| Payment Method Name | document | email | first\_name | last\_name |
| ------------------- | :------: | :---: | :---------: | :--------: |
| All | Yes | Yes | Yes | Yes |
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
# Dominican Republic
Check the list of Payment Methods available on Dominican Republic
### Payment Methods
| Icon | payment\_method | Name | Flow | Payment Type | Available for test | Iframe supported |
| ------------------------------------------------------------------- | --------------- | ------------- | -------- | ------------- | ------------------ | ---------------- |
| | BPRD | Banco Popular | REDIRECT | BANK\_DEPOSIT | Yes | Yes |
{% hint style="success" %}
Use the [Payment Methods Endpoint](broken://pages/-M7hYgDIPRyR1p3XGmws) to retrieve the Payment Methods' types, logos and more details.
{% endhint %}
### Fields required for the [OneShot Experience](broken://pages/-M7hYU7T42-pbXYXjrnh#oneshot-experience)
| Payment Method Name | country | amount | payer\[] | payment\_method |
| ------------------- | :-----: | :----: | :------: | :-------------: |
| All | Yes | Yes | Yes | Yes |
###
### Payer object requirements
| Payment Method Name | document | email | first\_name | last\_name |
| ------------------- | :------: | :---: | :---------: | :--------: |
| All | Yes | Yes | Yes | Yes |
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
# Ecuador
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
EC
USD
2
CC
Numeric. Length between 9 and 10 inclusive
Yes
### Alternative Payment Methods available
Logo
payment_method
Name
payment_type
Flows
FO
Facilito
VOUCHER
Embbeded, Redirect
GB
Banco Guayaquil
BANK_DEPOSIT
Redirect
PX
Banco Pichincha
BANK_DEPOSIT
Redirect
MV
Pichincha MiVecino
VOUCHER
Redirect
PJ
Pago Ágil
VOUCHER
Embbeded, Redirect
ES
ServiPagos
VOUCHER
Embbeded, Redirect
BR
Banco Del Barrio
VOUCHER
Embbeded, Redirect
BBO
Banco Bolivariano
BANK_DEPOSIT
Redirect
TE
Tia
VOUCHER
Embbeded, Redirect
AW
Activa WesternUnion
VOUCHER
Embbeded, Redirect
IE
Banco Internacional
BANK_DEPOSIT
Redirect
WU
Western Union
VOUCHER
Embbeded, Redirect
FD
Farmacias911
VOUCHER
Embbeded, Redirect
PPH
Payphone
WALLET
Embbeded, Redirect
DU
De Una!
VOUCHER
Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
# El Salvador
Check the list of Payment Methods available on El Salvador
{% hint style="warning" %}
*PayPal is currently down due to operational issues. We’re working to resolve this and appreciate your patience.*
{% endhint %}
## Payment Methods
| Icon | Payment Method | Name | Flow | Available for testing | Supports iFrame |
| --------------------------------------------------------------- | -------------- | ------ | ------------------- | --------------------- | --------------- |
| | `PPL` | PayPal | `REDIRECT ONE_SHOT` | Yes | Yes |
{% hint style="success" %}
Use the [Payment Methods Endpoint](broken://pages/-M7hYgDIPRyR1p3XGmws) to retrieve the Payment Methods' types, logos and more details.
{% endhint %}
### Fields required for the [OneShot Experience](broken://pages/-M7hYU7T42-pbXYXjrnh#oneshot-experience)
| Payment Method Name | country | amount | payer\[] | payment\_method |
| ------------------- | :-----: | :----: | :------: | :-------------: |
| All | Yes | Yes | Yes | Yes |
###
### Payer object requirements
| Payment Method Name | document | email | first\_name | last\_name |
| ------------------- | :------: | :---: | :---------: | :--------: |
| All | Yes | Yes | Yes | Yes |
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
# Guatemala
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
GT
GTQ and USD
2
DPI
Length between 6 and 18 inclusive
Yes
### Alternative Payment Methods available
Logo
payment_method
Name
Payment Type
Flows
AH
Akisipuedo
VOUCHER
Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
# Honduras
Check the list of Payment Methods available on Honduras
{% hint style="warning" %}
*At the moment, the payment methods listed for Honduras are only available for certain industries. Please contact your Account Manager to learn more about eligibility and available options for your business.*\
\
*Additionally, please note that PayPal is currently down due to operational issues. We’re working to resolve this and appreciate your patience.*
{% endhint %}
## Payment Methods
Icon
payment_method
Name
Flow
payment_type
Available for test
iFrame supported
PPL
PayPal
REDIRECT ONE_SHOT
VOUCHER
Yes
Yes
TMO
Tigo Money
REDIRECT
WALLET
Yes
Yes
FIC
Ficohsa
REDIRECT
VOUCHER
Yes
Yes
{% hint style="success" %}
Use the [Payment Methods Endpoint](broken://pages/-M7hYgDIPRyR1p3XGmws) to retrieve the Payment Methods' types, logos and more details.
{% endhint %}
### Fields required for the OneShot Experience
| Payment Method Name | country | amount | payer\[] | payment\_method |
| ------------------- | :-----: | :----: | :------: | :-------------: |
| All | Yes | Yes | Yes | Yes |
###
### Payer object requirements
| Payment Method Name | document | email | first\_name | last\_name |
| ------------------- | :------: | :---: | :---------: | :--------: |
| All | Yes | Yes | Yes | Yes |
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
# Mexico
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
MX
MXN and USD
2
CURP
Alphanumeric.
Length between 7 and 18 inclusive
Yes
### Card features
Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture
true
true
true
true
false
***
### Brands available
{% hint style="success" %}
### `payment_method` code `CC`
As the payers will be capable to input any card in the displayed checkout form ,the OneShot and Fragments all-in-one solution, we recommend using the payment method code **`CC`** in the API requests, which is a generic code.
After the payment is attempted, merchants will be capable to know with which card the user paid.
{% endhint %}
Logo
payment_method
Name
VI
Visa
VD
Visa Debit
MC
Mastercard
MD
Mastercard Debit
AE
American Express
CL
Cabal
DC
Diners Club
### Alternative Payment Methods available
Logo
payment_method
Name
payment_type
Flows
ME
MercadoPago
WALLET
Redirect
SE
Spei
BANK_TRANSFER
Embbeded, Redirect
OX
OXXO
VOUCHER
Embbeded, Redirect
OXP
OXXOPay
VOUCHER
Embbeded, Redirect
COD
CoDi
BANK_TRANSFER
Embbeded, Redirect
AZ
Banco Azteca
BANK_TRANSFER
Embbeded, Redirect
BV
BBVA Bancomer
VOUCHER
Embbeded, Redirect
BM
Banamex
BANK_TRANSFER
Embbeded, Redirect
STS
Santander SuperNet
BANK_TRANSFER
Embbeded, Redirect
SM
Santander
BANK_DEPOSIT
Embbeded, Redirect
AF
Afirme online banking
BANK_TRANSFER
Embbeded, Redirect
TC
Todito
WALLET
Embbeded, Redirect
PN
PayNet
VOUCHER
Embbeded, Redirect
FA
Farmacia del Ahorro
VOUCHER
Embbeded, Redirect
EA
Extra
VOUCHER
Embbeded, Redirect
CLX
Calimax
VOUCHER
Embbeded, Redirect
BW
Bodega Aurrera
VOUCHER
Embbeded, Redirect
CU
Circulo K
VOUCHER
Embbeded, Redirect
EN
7 Eleven
VOUCHER
Embbeded, Redirect
FL
Farmacia la mas barata
VOUCHER
Embbeded, Redirect
RO
Roma
VOUCHER
Embbeded, Redirect
SQ
Soriana
VOUCHER
Embbeded, Redirect
WE
Walmart Express
VOUCHER
Embbeded, Redirect
WA
Walmart
VOUCHER
Embbeded, Redirect
BQL
Banorte online banking
BANK_TRANSFER
Embbeded, Redirect
SW
SuperCity
VOUCHER
Embbeded, Redirect
SS
Sams Club
VOUCHER
Embbeded, Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
***
### Payment flows
#### Transferencias SPEI
The user selects **SPEI** as the payment method. A **CLABE** number (bank account code) appears on the screen. The user copies it, opens their banking app, selects “transfer,” pastes the CLABE, and completes the payment. Once confirmed, the funds are sent in real time.
{% hint style="success" %}
#### SPEI Offline
Additionally to the standard SPEI flow described above, we offer a different way in processing SPEI deposits.\
To learn more about this flow, please visit SPEI Offline
{% endhint %}
:art:**User interface tips**
If you are using our **`payment_info[]`** object to display the checkout natively in your website, follow this tips to boost conversion rates!
#### CoDi
After selecting **CoDi**, the user provides basic info, and a **QR code** appears on screen. They open their bank’s mobile app, select the CoDi scan option, upload the code, and confirm the transaction. The payment is completed in seconds.
#### `VOUCHER`s
After choosing **7-Eleven (for example)** as the payment method, the user fills in their personal info and receives a reference number. They take this number to any **7-Eleven** store, give it to the cashier, and pay in cash. The system updates the payment automatically once it’s received.
{% hint style="success" %}
#### `VOUCHER` type payment methods
Note that, even though the example provided is from 7Eleven, the flow described above applies for all the payment methods with type `VOUCHER`.
It applies for Oxxo, Bodega Aurrera, Circulo K, Walmart ... and more.
Cash vouchers are very popular in Mexico.
{% endhint %}
# Nicaragua
Check the list of Payment Methods available on Nicaragua
{% hint style="warning" %}
*PayPal is currently down due to operational issues. We’re working to resolve this and appreciate your patience.*
{% endhint %}
## Payment Methods
| Icon | Payment Method | Name | Flow | Available for testing | Supports iFrame |
| --------------------------------------------------------------- | -------------- | ------ | ------------------- | --------------------- | --------------- |
| | `PPL` | PayPal | `REDIRECT ONE_SHOT` | Yes | Yes |
{% hint style="success" %}
Use the [Payment Methods Endpoint](broken://pages/-M7hYgDIPRyR1p3XGmws) to retrieve the Payment Methods' types, logos and more details.
{% endhint %}
### Fields required for the [OneShot Experience](broken://pages/-M7hYU7T42-pbXYXjrnh#oneshot-experience)
| Payment Method Name | country | amount | payer\[] | payment\_method |
| ------------------- | :-----: | :----: | :------: | :-------------: |
| All | Yes | Yes | Yes | Yes |
###
### Payer object requirements
| Payment Method Name | document | email | first\_name | last\_name |
| ------------------- | :------: | :---: | :---------: | :--------: |
| All | Yes | Yes | Yes | Yes |
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
# Panama
Check the list of Payment Methods available on Panama
## Payment Methods
| Icon | payment\_method | Name | Flow | Payment Type | Available for Test | Iframe supported |
| ------------------------------------------------------------------- | --------------- | ---------- | -------- | ------------ | ------------------ | ---------------- |
| | PTP | Punto Pago | REDIRECT | VOUCHER | Yes | Yes |
{% hint style="success" %}
Use the [Payment Methods Endpoint](broken://pages/-M7hYgDIPRyR1p3XGmws) to retrieve the Payment Methods' types, logos and more details.
{% endhint %}
## Fields required for the [OneShot Experience](broken://pages/-M7hYU7T42-pbXYXjrnh#oneshot-experience)
| Payment Method Name | country | amount | payer\[] | payment\_method |
| ------------------- | :-----: | :----: | :------: | :-------------: |
| All | Yes | Yes | Yes | Yes |
###
### Payer object requirements
| Payment Method Name | document | email | first\_name | last\_name |
| ------------------- | :------: | :---: | :---------: | :--------: |
| All | Yes | Yes | Yes | Yes |
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
# Paraguay
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
PY
PYG and USD
2
CIC
Length between 6 to 8 characters
Yes
***
### Payment Methods available
Logo
payment_method
Name
Payment Type
Flows
VI
Visa
CREDIT_CARD
VD
Visa Debito
DEBIT_CARD
MC
Mastercard
CREDIT_CARD
MD
Mastercard Debito
DEBIT_CARD
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
# Peru
### Country specifications
country code
currency code
amount decimals
document name
document format
document required?
PE
PEN and USD
2
CE and CPP
Numeric. Length 9.
Yes
### Card features
Card-on-file
Subscriptions
3DS
Installments
Authorization and Capture
false
false
true
false
false
***
### Brands available
{% hint style="success" %}
### `payment_method` code `CC`
As the payers will be capable to input any card in the displayed checkout form ,the OneShot and Fragments all-in-one solution, we recommend using the payment method code **`CC`** in the API requests, which is a generic code.
After the payment is attempted, merchants will be capable to know with which card the user paid.
{% endhint %}
Logo
payment_method
Name
VI
Visa
VD
Visa Debit
MC
Mastercard
MD
Mastercard Debit
AE
American Express
DC
Diners Club
***
### Alternative Payment Methods available
Logo
payment_method
Name
payment_type
Flows
XA
Tupay
VOUCHER
Embbeded, Redirect
XAQR
Tupay QR
VOUCHER
Embbeded, Redirect
XABT
Tupay Bank Transfers
VOUCHER
Embbeded, Redirect
XACC
Credit Cards by Tupay
VOUCHER
Embbeded, Redirect
EF
Pago Efectivo
VOUCHER
Redirect
YP
Yape
WALLET
Embbeded, Redirect
IB
Interbank
BANK_DEPOSIT
Redirect
BC
BCP
BANK_DEPOSIT
Embbeded, Redirect
ST
Scotia
BANK_DEPOSIT
Redirect
BAB
Banbif
BANK_DEPOSIT
Embbeded, Redirect
RY
Banco Ripley
BANK_DEPOSIT
Redirect
NAG
Niubiz Agents Payment
VOUCHER
Embbeded, Redirect
RDP
Red Digital
VOUCHER
Redirect
WU
Western Union
VOUCHER
Redirect
BP
BBVA
BANK_DEPOSIT
Redirect
KE
Kasnet
VOUCHER
Embbeded, Redirect
TM
Tambo
VOUCHER
Redirect
HC
Caja Huancayo
VOUCHER
Redirect
US
Caja Cusco
VOUCHER
Redirect
JA
Caja Arequipa
VOUCHER
Redirect
JI
Caja ICA
VOUCHER
Redirect
JP
Caja Piura
VOUCHER
Redirect
JT
Caja Tacna
VOUCHER
Redirect
#### Fields required for the [OneShot](/deposits/solutions/oneshot) solution
Payment Method Name
country
amount
payer[]
payment_method
Payment method name
country
amount
payer[]
payment_method
All
Yes
Yes
Yes
Yes
#### `payer[]` object requirements
Payment Method Name
document
email
first_name
last_name
Payment method name
document
email
first_name
last_name
All
Yes
Yes
Yes
Yes
{% hint style="success" %}
Other fields not in these lists are optional.
{% endhint %}
{% hint style="info" %}
### If any of the required fields are missing the `HOSTED` flow will be triggered
In that case you will receive the `HOSTED` value in the `checkout_type` parameter.\
You will have to redirect the user to the `redirect_url`
{% endhint %}
### Tupay methods description
Tupay is peruvian payment solution that allow users to pay with their all their preffered local solutions, within a single checkout.
Merchants can opt to use the payment methods contained within Tupay as standalone by itself, different payment methods include:
Tupay voucher
XA
The payment method Tupay, includes all the payment methods available via this channel, including digital wallets, bank transfers, credit cards, and cash methods.
The customer can choose whatever method they want to complete the transaction.
This payment method includes both Yape and Plin, which are the most used digital wallets in Peru, together with other smaller digital wallets. The QR code within can be used to pay with any of these digital wallets.
Tupay Bank Transfers lets the final customer utilize whatever bank that they have, in order to make a bank transfer as a payment.
Tupay Credit Cards
XACC
This allows customers to pay with a credit card, Visa or MasterCard. Also, it can include debit cards.
# Africa
### Countries available
{% columns %}
{% column width="50%" %}
🇧🇯 Benin
🇧🇼 Botswana
🇨🇲 Cameroon
🇨🇬 Congo Brazzaville
🇨🇩 Congo DRC
🇪🇬 Egypt
🇬🇦 Gabon
🇬🇭 Ghana
🇨🇮 Ivory Coast
{% endcolumn %}
{% column width="50%" %}
🇰🇪 Kenya
🇳🇬 Nigeria
🇲🇼 Malawi
🇲🇱 Mali
🇷🇼 Rwanda
🇿🇦 South Africa
🇹🇬 Togo
🇺🇬 Uganda
🇿🇲 Zambia
{% endcolumn %}
{% endcolumns %}
{% hint style="success" %}
#### Interested in expanding to :earth\_africa: Africa?
Please get in touch with your commercial representative, we can guide you through!
{% endhint %}
# Asia
### Countries available
{% columns %}
{% column %}
🇧🇩 Bangladesh
🇨🇳 China
🇭🇰 Hong Kong
🇮🇳 India
🇮🇩 Indonesia
🇯🇵 Japan
{% endcolumn %}
{% column %}
🇲🇾 Malaysia
🇵🇰 Pakistan
🇹🇭 Thailand
🇹🇷 Turkey
🇻🇳 Vietnam
{% endcolumn %}
{% endcolumns %}
{% hint style="success" %}
#### Interested in expanding to :earth\_asia: Asia?
Please get in touch with your commercial representative, we can guide you through!
{% endhint %}
# Solutions
# Server2Server
{% hint style="info" %}
#### PCI DSS Compliance
A direct API integration places the responsibility of handling cardholder data on your servers. Therefore, achieving and maintaining compliance with the **Payment Card Industry Data Security Standard (PCI DSS)** is mandatory. This ensures that sensitive payment information is protected according to the highest industry security standards.
For detailed requirements, please consult the official PCI Security Standards Council documentation.
{% endhint %}
## Design your payment experience
Our Server-to-Server API empowers you to process card payments directly on your website or application. This solution provides maximum control, allowing you to design a fully integrated and seamless checkout experience that lives entirely within your platform.
## Core advantages
A direct API integration offers several key benefits:
* **Total brand control:** Craft a payment journey that perfectly mirrors your brand. You control the entire user experience, ensuring a consistent and personalized interaction from start to finish.
* **Enhanced customer trust:** Maintain customer confidence by keeping users on your site throughout the payment process. A familiar environment assures customers that their sensitive data is being handled securely by a brand they trust.
* **Optimized for conversion:** Take full ownership of your checkout flow. By removing redirects and controlling every step, you can minimize friction and optimize your way to higher conversion rates.
### Build the solution
Cover image
Guide
Follow detailed, step-by-step instructions and use our code examples to launch your integration with ease.
# Fragments (SDK)
Fragments is our ultimate toolkit to enable merchants to offer world-class credit card checkout experience.
### Fragments all-in-one
you can use our Fragments all-in-one version to display your checkout directly in your website with very low effort required. Fragments will handle the whole experience with all the possible scenarios: displaying installments, handling 3DS challenges, remembering payer's card and performing card validations.
Additionally, you can highly customize the frontend elements to math your site's styles, blending our frontend component naturally in your website.\
All this perks will remaining a fully PCI compliant integration.
### Fragments Lite
In case you want to **build your own credit card checkout components in the frontend**, but without being PCI Compliant you can still opt for our Fragments SDK.
You will need to send to our frontend component the card details in order to generate a token.
That token will contain encrypted information about the credit card that only our side can decrypt.\
You should use the token to charge that deposit.
{% hint style="info" %}
## `card_token` expiration
Please note that the token created by the Fragments SDK will expire after 10 minutes.
{% endhint %}
# Fragments (Lite)
Simplify your PCI compliance by using our headless JavaScript SDK. It securely captures credit card details within your application and exchanges them for a safe, single-use token. You then use this token to process payments via our backend API, ensuring sensitive data never transits or is stored on your servers.
{% stepper %}
{% step %}
### Installation
Before you can use the SDK, you need to add it to your project. You have two options:
**Using npm (Recommended for modern web development)**
If you are using a package manager like npm or yarn, you can add the SDK to your project's dependencies.
```sh
npm install @pandablue/sdk-minimal
```
**Or you can perform a manual script installation**
For simpler projects or direct HTML integration, you can include the SDK using a `
```
{% endcode %}
{% hint style="success" %}
#### Ensure to install the latest version in this [link](https://www.npmjs.com/package/@d24/sdk-minimal)!
{% endhint %}
{% endstep %}
{% step %}
### Initializing the SDK
Once installed, you must initialize the SDK with your unique public key and specify the environment you are working in. This step is mandatory and must be completed before you can call any other methods.
You will receive your public key from PandaBlue. The environment should be set to **`'stg'`** for testing and development, and **`'prod'`** for your live application.
**If you installed via npm:**
```javascript
import SDK from '@pandablue/sdk-minimal';
// Initialize the SDK once when your application loads.
new SDK('YOUR_PUBLIC_KEY', { environment: 'stg' });
```
**If you are using the manual script:**
```javascript
// The SDK will be available on the global window object.
new window.pandablue.SDK('YOUR_PUBLIC_KEY', { environment: 'stg' });
```
> **Important:** The SDK is designed to be a singleton, meaning it should only be instantiated once during your application's lifecycle. Attempting to initialize it more than once will result in an error.
> {% endstep %}
{% step %}
### Generate a secure card token
The primary purpose of this SDK is to convert raw credit card data into a single-use, secure token.
You will first collect the card information from your user through a form on your application. Then, you pass this data to the **`generateToken`** method. The SDK will validate the data and communicate with PandaBlue servers to create the token.
The **`creditCard[]`** object requires the following fields:
* **`number`**: The credit card number.
* **`holder`**: The cardholder's full name.
* **`cvv`**: The 3 or 4-digit security code.
* **`expirationMonth`**: The two-digit expiration month (e.g., '05').
* **`expirationYear`**: The two-digit expiration year (e.g., '28').
Here is how you generate a token:
```javascript
// This is an asynchronous function, so you'll need to use async/await or .then()
async function processPayment(cardDetails) {
try {
// Assuming 'cardDetails' is an object with the required card fields
const response = await window.pandablue.generateToken({ card: cardDetails });
// The secure token
const token = response.token;
// Now, send this token to your backend server to make the API call
// to finalize the deposit.
console.log('Token created:', token);
// sendTokenToServer(token);
} catch (error) {
// Handle any validation or network errors
console.error('Error generating token:', error.message);
}
}
// Example usage:
const myCardInfo = {
number: '4509953566233704',
holder: 'Juan Perez',
cvv: '123',
expirationMonth: '11',
expirationYear: '25',
};
processPayment(myCardInfo);
```
{% endstep %}
{% endstepper %}
### Build the solution
Cover image
Guide
Follow detailed, step-by-step instructions and use our code examples to launch your integration with ease.
# Fragments (all-in-one)
This guide will provide you with everything you need to integrate our powerful, all-in-one payment solution into your application for a seamless native checkout experience.
### Getting Started
Integrating the Fragments SDK is a straightforward process.\
Follow these initial steps to get up and running.
{% stepper %}
{% step %}
### Installation
You can add the PandaBlue SDK to your project in two ways:
**Using NPM (Recommended)**
For projects using a package manager, install the SDK from the npm public registry.
```sh
npm install @pandablue/sdk
```
**Or you can perform a manual script installation**
Alternatively, you can add the PandaBlue.js module directly to your HTML file. Place this script tag in the `` of your document.
```html
```
{% hint style="success" %}
#### Ensure to install the latest version on this [link](https://www.npmjs.com/package/@d24/sdk)!
{% endhint %}
{% endstep %}
{% step %}
### Initialization
Before you can use any of the SDK's features, you must instantiate it. This step configures the SDK for your specific account and environment.
**Important:** The SDK should only be instantiated once when your application loads.
To instantiate, you'll need your `publicKey` and the desired `environment`.
{% hint style="info" %}
## **How to find your `publicKey`**
1. Log into your **Merchant Panel**.
2. Navigate to **Settings > API Access**.
3. Under **Read Only Credentials**, you will find your **API Public key**.
{% endhint %}
Here’s how to instantiate the SDK in your code:
**If you used NPM:**
{% code overflow="wrap" %}
```javascript
import SDK from '@pandablue/sdk';
// Instantiate the SDK
const pandablue = new SDK('YOUR_PUBLIC_KEY', { environment: 'stg', locale: 'en' });
```
{% endcode %}
**If you used the manual script:**
{% code overflow="wrap" %}
```javascript
// Instantiate the SDK from the global window object
const pandablue = new window.pandablue.SDK('YOUR_PUBLIC_KEY', { environment: 'stg', locale: 'en' });
```
{% endcode %}
**Environments:**
* `stg`: Use for testing and development (Staging).
* `prod`: Use for your live application (Production).
{% endstep %}
{% step %}
### Implementing the Credit Card Form
Once the SDK is instantiated, you can render the `CreditCardForm` component. This component handles the entire card input and payment submission process securely.
The component requires a few key properties to function:
* `authToken`: A unique token generated from your backend by the Deposit Creation Endpoint.
* `country`: The two-letter country iso-code (e.g., "BR").
* Callback functions to handle different outcomes of the payment process.
#### Basic Example
Here is a simple example of how to render the form:
```javascript
// Make sure you have instantiated the SDK before this step
```
{% endstep %}
{% step %}
### Handling Callbacks
Callbacks are essential for managing the payment flow and providing feedback to your users.
**`onSuccess`**
This function is called when a payment is completed successfully.
```javascript
function handlePaymentSuccess() {
console.log('Payment was successful!');
// e.g., Redirect to a success page or show a success message
}
```
**`onError`**
This function is called if an error occurs during the payment process.
```javascript
function handlePaymentError(error) {
console.error('Payment failed:', error);
// e.g., Display an error message to the user
}
```
**`onBack`**
This function is executed when the user clicks the "Go Back" button within the form.
```javascript
function handleGoBack() {
console.log('User clicked go back.');
// e.g., Navigate to the previous step in your checkout flow
}
```
**`onTokenGenerationError`**
This function is called if there's an issue with generating the secure token before the payment is attempted.
```javascript
function handleTokenError(error) {
console.error('Could not generate token:', error);
// This is often a configuration or setup issue.
}
```
{% endstep %}
{% step %}
### Message customization
You can customize the messages displayed on the final payment screens using the `messages` property.
#### Example
```javascript
```
This concludes the API Guide.\
For a detailed list of all parameters, properties, and error codes, please consult the **API Reference** document :arrow\_right: Fragments (all-in-one)
{% endstep %}
{% step %}
### Customize the look and feel
You fully customize the credit card form to match you website's user interface!\
Visit the API Reference to learn how to setup the **`colorSchema`**`[]` :arrow\_right: Customize the UI
{% endstep %}
{% endstepper %}
### Build the solution
Cover image
Guide
Follow detailed, step-by-step instructions and use our code examples to launch your integration with ease.
# OneShot
Our OneShot solution will enable you to redirect the user to our checkout page where the user will see all the details for completing the deposit, and also will enable you to render the checkout page on your website (in the case of using Alternative Payment Methods).
### Alternative Payment Methods world-class integration
Our OneShot integration allows you to render the checkout information on your website.
We will always send you the **`redirect_url`** parameter with the checkout hosted in our end.
But if you are looking for the best user experience, you can display the checkout in your site with your own custom design.\
You will receive in the response the required information in the **`metadata[]`** object within the **`payment_info[]`**, such as QR codes, bar codes, banking copy/paste addresses, bank transfer details and more!
{% tabs %}
{% tab title="Example of a Pix deposit" %}
{% endtab %}
{% endtabs %}
### **Hosted checkout**
{% hint style="warning" %}
Hosted flow is ***never*** recommended as a main deposit flow as it can impact directly on conversion rates.
{% endhint %}
In the event that **not all mandatory data is sent** in the initial API call, the system will automatically trigger an intermediate flow known as the **Hosted flow**. This ensures the payment can still be completed.
* **What happens:** The API will return the parameter **`checkout_type`** with value **`HOSTED`** and a **`redirect_url`**.
* **Required action:** You must redirect the user to that URL. On our hosted page, we will collect the missing information from the user before presenting them with the final checkout instructions in the same tab.
### Build the solution
Cover image
Guide
Follow detailed, step-by-step instructions and use our code examples to launch your integration with ease.
# Plugins
# Shopify
Integrate D24 into your store to accept payments from your users.
## Description
This application allows you to connect D24 as a payment method in your Shopify. With the following documentation, you will get the necessary information to install and configure D24.
## Next steps
Click in the cards below to see the details in how to install and configure the app.
# Installation
First of all, in order to install D24, you must enter the following link:
[➡️ https://apps.shopify.com/d24](https://apps.shopify.com/d24)
Log with your Shopify credentials.
Or in case you don't have credentials, you can register at Shopify to access the D24 app.
Once you have successfully logged in, you will be prompted to select your Shopify store.
After selecting the store, you will be able to open the D24 app, and you will be redirected to the onboarding page.
# Onboarding
In this section you will have to configure D24 in your Shopify in a simple way.
1\. On this screen you must click on the 'LOG IN' button. If you do not have an account, you can create one by clicking on the 'Create it here' button.
***
2\. In the next screen you must enter the Api Key, and Api Signature. Do not forget to upload the logo!
After uploading the credentials, press the 'LOGIN' button.
3\. If they are wrong or incorrect, you will see the corresponding validation message.
***
4\. If they are correct, a success message will be displayed and you will enter the administrative panel of your store.
5\. It is important that you activate the payment methods you wish to use in order to operate with D24.
In this same screen you can activate the test mode if you want to simulate transactions before making real transactions.
***
6\. Once you have finished the configuration, press the 'Activate D24' button. Done! The configuration process will have finished successfully and you will be offering D24 as a means of payment to your customers.
# Customer flow
In just a few steps, your customers will be able to pay with D24 in your store. In the following quick guide we show you how:
When adding products to the cart and going to checkout, the consumer will see D24 as a payment option.
Clicking it will allow you to make a payment with D24.
Select which payment institution you want to pay with D24.
Enter the data correctly.
Upon successful payment, you will return to Shopify to see the status of your order.
# Admin Flow
### Order and detail view
From the Shopify admin menu select 'Orders'.
And then you will be able to see all the received orders.
By clicking on the number of the order you want to see, you will be able to see the order details.
Once you enter the order details, at the bottom of this screen you will see the payment method used to pay for the order, in this case D24.
***
### Transaction view from D24
From the D24 dashboard you will be able to view the transactions made from your store, by clicking on the 'Transactions' menu you will be able to view the detail of the payment made.
# Tutorials
### How to find your credentials in D24 account
In this video we show you how you can obtain the necessary credentials for the integration from your D24 account.
{% embed url="" %}
### Installation and onboarding
In the following video we will show you how you can easily install and onboard the app to integrate D24 to your Shopify store.
{% embed url="" %}
### Purchase by paying with D24
In this video we will detail the steps that your customers must follow to make their purchases in your store paying with D24.
{% embed url="" %}
### Exploring orders, refunds and deposits with D24
In the following videos we show you how you can view paid orders with D24 from your store's administrative panel, how to make returns if necessary and how to view deposits from your D24 account.
{% embed url="" %}
{% embed url="" %}
# FAQ
### Why is D24 not shown as a payment method in my store?
The credentials used in the setup process are not correct. Although it is very difficult for this to happen since there are the corresponding validations, it is a possibility that you should keep in mind, if it happens, verify that all steps have been completed correctly. If the problem persists, contact support.
### How can I visualize more information about my transactions?
From the [D24 panel](https://merchants.d24.com/login), you will be able to get more details about your transactions.
### Can I refund transactions?
From your Shopify store, in the order detail, you will have the **Refund** option with which you can return a transaction to your customer when required.
### Is the status of the payment made through D24 updated in Shopify?
If the payment is in status: **pending**, **approved** or **canceled**, this status will be updated in your store.
### Can I stop offering D24 as a payment method?
If you no longer wish to offer D24 as a means of payment in your store, go to **Applications** from Shopify and in the D24 app select the **Uninstall** option. Remember that when you want to offer the payment method again, you just have to reinstall the app.
# WooCommerce
Here you will find all the information and resources needed in order to install our WooCommerce plugin!
Details
**Contributors:** directa24\
**Requires at least:** 7.0 \
**Tested up to:** 7.4.0 \
**Stable tag:** 1.0.0 \
**License:** GPLv3 \
**License URI:**
## Description
This plugin adds D24 Payment Gateway to your WooCommerce store, allowing customers to pay with multiple local payment methods:
### **We support:**
💳
Credit and Debit cards
🏦
Online bank transfers
💵
Cash methods
### Translations
🇬🇧
English
🇧🇷
Portuguese
🇪🇸
Español
## Download
{% file src="/files/N3KI3IKLE5MHjlp7Vc7o" %}
v 1.0.0
{% endfile %}
## Next steps
Click in the cards below to see the details in how to install and configure the plugin.
### Changelog
* 1.0.0 (2023-03-01): Initial plugin release
# Installation
## **Minimum Requirements**
* WooCommerce 7.0 or greater
## Manual installation uploading files to the server
Extract the zip file and just drop the contents in the wp-content/plugins/ directory of your WordPress installation and then activate the Plugin from Plugins page.
## Manual installation uploading zip file from WordPress Admin
1. Sign in to your **WordPress Admin.**\
2. In the left-hand menu, select: **Plugins** > **Add New**.\
3. Select **Upload Plugin**.\
4. Select **Choose File**.\
5. Locate and select the plugin .zip file on your local computer and then select **Open**.
6. Select **Install Now**.\
7. *Optional*: Select Activate Plugin if you want the plugin to be active after the installation. If not, you can always activate it later.
# Configuration
If you have installed the plugin, follow this steps and tips to have it up and running!
#### Brief explanation
In D24 we provide two environments to our clients, **Staging** and **Production**. Each one with its own set of credentials.
* With your **Staging** credentials you will be able to test the different payment methods and flows with mocked information that simulates real payments, risk free.
* With your **Production** credentials, you will be using real-life gateways and payment information, therefore users will be capable to pay!
## Step-by-step
1. In the left-hand menu go to **Woocommerce** > **Settings**.\
2. Then go to **Payments** and you will see **Directa24 Checkout** on the method list. Click it to configure :smile:
3. In the plugin configuration you will find four sections: ***Environment selection***, ***Staging credentials***, ***Production credentials*** and ***Configuration.***
* ***Environment selection:*** in this section you will be capable to select which environment you want to use at your checkout.\
:warning:Please use Staging for testing purposes ***only***.
* ***Staging credentials***: this are your Staging environment keys, you can fetch them by logging into the [STG Merchant Panel](https://merchants-stg.directa24.com/), and going into **Settings** >**API Access** > **Deposit credentials** \
:information\_source:*Make sure to whitelist the IPs in which your WooCommerce site is hosted. You can do so by adding the IPs in the list that is below the credentials.*
* ***Production credentials***: instructions are the same as for *Staging credentials* but in our production environment.
* ***Configuration***: finally in this section you get to choose if you want to enable/disable the plugins and the auto-complete functionality.
4. Lastly, make sure to **Save changes** and yo are good to start using D24's plugin! :rocket:
# Create deposits
# Credit cards
{% columns %}
{% column width="66.66666666666666%" %}
## Processing card payments
This documentation is structured to guide you through our payment system step-by-step. \
We will begin with the most **basic deposit** flows and then introduce additional features as separate components.\
This approach ensures you can build a solid foundation first and add more complex functionality only as it is needed.
{% endcolumn %}
{% column %}
{% endcolumn %}
{% endcolumns %}
### Basic deposit
All payment integrations begin with a Basic deposit. This guide covers a simple, one-time charge, which is the core of our payment processing system.
We recommend completing this guide first, as all other features are built on top of this primary transaction.
### Add features to your integration
After you are familiar with the basic deposit, you can incorporate additional capabilities into your integration.
Each feature is explained in its own dedicated guide.
# Basic deposits
# Server2Server
### **Deposit with card information (Server2Server)**
{% stepper %}
{% step %}
#### Create a deposit request to our PCI endpoint
The deposit request must include the **`credit_card[]`** object containing all the card details.
Note that the default response of this endpoint in synchronous.
{% tabs %}
{% tab title="Example request" %}
{% endtab %}
{% tab title="Example response" %}
```json
{
"deposit_id": 300604089,
"user_id": "80000001",
"merchant_invoice_id": "800000001",
"payment_info": {
"type": "CREDIT_CARD",
"result": "SUCCESS",
"payment_method": "VI",
"payment_method_name": "Visa",
"amount": 1000,
"currency": "BRL",
"created_at": "2025-07-15T12:57:14.936Z"
}
}
```
{% endtab %}
{% endtabs %}
{% endstep %}
{% step %}
#### Retrieve the Deposit final status
Even though that this endpoint is mostly synchronous, we may eventually send webhooks to notify changes within a deposit.
These webhook notifications contain the **`deposit_id`** for you to retrieve the status.
```json
{
"deposit_id": 300604089
}
```
{% hint style="info" %}
### For more information on this point visit Notifications.
{% endhint %}
{% endstep %}
{% endstepper %}
# Fragments Lite
### **Deposit with Fragments Lite**
{% stepper %}
{% step %}
#### Create a deposit request to our PCI endpoint
The deposit request must include the **`card_token[]`** object containing all the card details.
Note that the default response of this endpoint in synchronous.
{% tabs %}
{% tab title="Example request" %}
{% endtab %}
{% tab title="Example response" %}
```json
{
"deposit_id": 300604089,
"user_id": "80000001",
"merchant_invoice_id": "test766106146",
"payment_info": {
"type": "CREDIT_CARD",
"result": "SUCCESS",
"payment_method": "VI",
"payment_method_name": "Visa",
"amount": 505.95,
"currency": "MXN",
"created_at": "2021-02-05T22:10:45Z"
}
}
```
{% endtab %}
{% endtabs %}
{% endstep %}
{% step %}
#### Retrieve the Deposit final status
Even though that this endpoint is mostly synchronous, we may eventually send webhooks to notify changes within a deposit.
These webhook notifications contain the **`deposit_id`** for you to retrieve the status.
```json
{
"deposit_id": 300604089
}
```
{% hint style="info" %}
### For more information on this point visit Notifications.
{% endhint %}
{% endstep %}
{% endstepper %}
# Fragments all-in-one
### Deposits with Fragments all-in-one
{% stepper %}
{% step %}
#### Create a deposit request
You will need to create a deposit request to our OneShot API, taking into care the following considerations:
* [x] sending all the mandatory payer information
* [x] indicating that is a credit/debit card payment by sending `CC` as `payment_method`
* [x] send the parameter **`token_requested`** with value **`true` .**
{% tabs %}
{% tab title="Example Request" %}
{% endtab %}
{% endtabs %}
In the response you will receive the **`checkout_token`** associated to the transaction that was just generated.
{% endstep %}
{% step %}
#### Instantiate Fragments SDK
At this point you have to instantiate Fragments, which you already have installed in your site.\
For more information about instantiation go to this [link](/deposits/solutions/fragments-sdk/fragments-all-in-one#build-the-solution).\
Remember to retrieve your **`publicKey`** from the Merchant Panel, and define the proper **`environment`**.
{% endstep %}
{% step %}
#### Render Fragments all-in-one component
Now you can display the **CreditCardForm**.\
The component requires a few key properties to function:
* `authToken`: A unique token generated from your backend by the Deposit Creation Endpoint.
* `country`: The two-letter country iso-code (e.g., "BR").
* Callback functions to handle different outcomes of the payment process.
**Basic example**
Here is a simple example of how to render the form:
```html
```
And Fragments will be displayed.
{% endstep %}
{% step %}
#### Retrieve the Deposit final status
Everytime that the deposit changes it's status, you will receive a webhook notification with the **`deposit_id`** for you to retrieve the status.
```json
{
"deposit_id": 301623200
}
```
Once the user clicks in the Complete button, we will process the transaction and you will receive such webhook.
{% hint style="info" %}
### For more information on this point visit Notifications.
{% endhint %}
{% endstep %}
{% endstepper %}
# OneShot
### Deposit with OneShot redirect
{% stepper %}
{% step %}
#### Create a deposit request
You will need to create a deposit request to our OneShot API, taking into care the following considerations:
* [x] sending all the mandatory payer information
* [x] indicating that is a credit/debit card payment by sending **`CC`** as `payment_method`
{% tabs %}
{% tab title="Example request" %}
```sh
curl -L \
--request POST \
--url 'https://api-stg.pandablue.com/v3/deposits' \
--header 'Content-Type: application/json' \
--header 'X-Date: 2025-07-17T13:13:15.442Z' \
--header 'X-Login: text' \
--header 'Authorization: text' \
--data '{
"invoice_id" : "1000000001",
"amount": "1000",
"country": "MX",
"currency": "MXN",
"payer": {
"id": "11",
"document": "CURP4321TEST",
"first_name": "Ricardo",
"last_name": "Carlos",
"email": "juanCarlos@hotmail.com"
},
"payment_method": "CC",
"client_ip": "123.123.123.123",
"back_url": "https://www.mercahnt.com/deposit_cancelled",
"success_url": "https://www.merchant.com/deposit_completed",
"error_url": "https://www.merchant.com/deposit_error",
"notification_url": "https://www.pandablue.com/pandablue/notify"
"logo": "https://www.merchant.com/merchant-logo.png",
}'
```
{% endtab %}
{% tab title="Example response" %}
{% endtab %}
{% endtabs %}
{% endstep %}
{% step %}
#### Open the `redirect_url` in a new tab
In the response you will receive the redirect\_url where the user should be sent in order to visualize the credit card checkout hosted on our systems.
{% hint style="success" %}
### Note that you can include your brand logo in our checkout!
You can either send it via API or define it statically within the Merchant Panel.
{% endhint %}
{% endstep %}
{% step %}
#### Retrieve the Deposit final status
Everytime that the deposit changes it's status, you will receive a webhook notification with the **`deposit_id`** for you to retrieve the status.
```json
{
"deposit_id": 301623200
}
```
{% hint style="info" %}
### For more information on this point visit Notifications.
{% endhint %}
{% endstep %}
{% endstepper %}
# 3DS
3DS in Server2Server solution
The Deposits that are subject to the 3DS Authentication flow, will receive as Response of the PCI Deposit Endpoint a **`payment_info.result`** with value **`PENDING_AUTHENTICATION`**.
{% hint style="success" %}
Deposits that are **not** subject to 3DS Authentication are synchronically approved or rejected with **`payment_info.result`** with values **`SUCCESS`** and **`REJECTED`**.
{% endhint %}
#### Example response
### `authentication_url`
This parameter contains a URL with the 3DS Authentication challenge to be displayed to the end-user. In order to do so, you can:
#### Open the `authentication_url` within an iframe
The challenge can be displayed within an iframe in the case you want to keep the user on the same webpage.
The iframe can be opened with a JavaScript method `EventListener` that will communicate whenever the iframe can be closed and the result of the transaction.
**JavaScript** **Method**
```javascript
window.addEventListener('message', handler);
```
Additionally the EventListener will include whether the transaction was successful or error within the `payment_result` object.
```json
{ "payment_result": "success"}
```
```json
{ "payment_result": "error"}
```
#### Or, you can redirect the user into a new tab
The `authentication_url` can also be opened in a new tab to the end-user. In case of opting for this flow, please make sure of including the following parameters in the Deposit request:
Parameter
Format
Description
back_url
URL
URL to redirect the user in case of willing to withdraw from the payment flow.
success_url
URL
URL to redirect the user after the Deposit flow came to an end.
error_url
URL
URL to redirect the user in case that an error occur.
### Webhooks
As you may notice, if a 3DS challenge is needed on your Server2Server integration, the response **will not be synchronous**. \
Therefore, after the authentication and payment processing, a webhook notification will be sent in order to check the deposit and retrieve the status of the transaction.
:information\_source: For more information regarding webhooks please go to the [API Reference](broken://spaces/VNE8t2FopKfzgQzTjlBb/pages/282oVrSIyWM7W7ecKR7T).
Third party 3DS Server2Server
It is possible to create a deposit submitting information from a third-party 3DS provider.
{% hint style="success" %}
Please check regional availability with your account manager as not all countries may scope this functionality :earth\_americas:
{% endhint %}
In order to do so, you need to include the **`three_domain_secure[]`** Object in the Server2Server integration request.
### `three_domain_secure[]` Object
```json
"three_domain_secure":{
"cavv": "3q4+33t+ur5erb7vyv53vv\/\/\/\/9=",
"eci": "05",
"transaction_id": "HMUzFWRzOTcwOKG7PzY3Rw==",
"specification_version": "2.0.0"
}
```
Field
Format
Description
cavv
String
The cardholder authentication value for the 3D Secure authentication session. The returned value is a base64-encoded 20-byte array.
eci
String
The electronic commerce indicator.
transaction_id
String
The transaction identifier assigned by the 3DS Server for v2 authentication (36 characters, commonly in UUID format).
specification_version
String
The 3DS Authentication version. Accepted from 2.0.0 onwards.
#### Allowed `eci` codes for Third Party 3DS flow, are:
* 01 and 02 for Mastercard
* 05 and 06 for Visa and Amex.
#### Example PCI Deposit Creation request with third-party 3DS
```json
{
"invoice_id": "800000001",
"amount": 1000,
"country": "BR",
"currency": "BRL",
"payer": {
"id": "11111",
"document": "84932568207",
"document_type": "CPF",
"email": "johnSmith12@hotmail.com",
"first_name": "John",
"last_name": "Smith",
"phone": "+233852662222",
"birth_date": "19880910",
"address": {
"street": "Calle 13",
"city": "bahia",
"state": "SP",
"zip_code": "12345-678"
}
},
"credit_card": {
"cvv": "123",
"card_number": "4111111111111111",
"expiration_month": "10",
"expiration_year": "25",
"holder_name": "JOHN SMITH"
},
"three_domain_secure":{
"cavv": "AJkBARglcgAAAAPohABHdQAAAAA=",
"eci": "05",
"transaction_id": "7e76d057-100a-4d0d-9683-5eb0ce0ee3a4",
"specification_version": "2.0.0"
},
"description": "Test transaction",
"client_ip": "123.123.123.123",
"device_id": "knakvuejffkiebyab",
"fee_on_payer": false
}
```
Fragments Lite
Our Fragments Lite integration can scope both scenarios described above:
1. Using PandaBlue's 3DS challenge.
2. You can also send the output of your 3DS MPI (`three_domain_secure[]` object)
#### Using PandaBlue's 3DS challenge
The only difference with the Server2Server 3DS flow is that **instead** of sending the `credit_card[]` object, you will be sending the **`card_token`** generated with the SDK.
From there, the flow is the same: you will receive the **`PENDING_AUTHENTICATION`** response with the **`authentication_url`** containing the 3DS challenge.
#### Using a third party 3DS
The only difference with the Server2Server 3DS flow is that instead of sending the `credit_card[]` object, you will be sending the **`card_token`** generated with the SDK.
In the request you should also include the **`three_domain_secure[]`** object.
Fragments all-in-one
The Fragments all-in-one integration will take care of handling the 3DS Challenge within your website.\
You won't need to make any adjustments on those terms.
OneShot redirect
As the OneShot credit card integration consist in you redirecting the user to our card form checkout, we will handle the challenge experience from there.\
No changes from your end are required.
# Installments
{% hint style="success" %}
Please check-in with your Sales contact for the corresponding configuration and eligibility of this functionality.
{% endhint %}
Server2Server
To create a deposit with installments through our Server2Server solution, the parameter **`installments`** should be sent in the request with a valid amount of installments.
The deposit will be synchronously processed, and charged with installments to the cardholder with the amount detailed in the **`installments`** parameter.
Fragments Lite
Fragments Lite is similar to our Server2Server solution in regards of charging deposits with Installments.\
Remember, that in this solution you should send the **`card_token`** instead of the `credit_card[]` object alongside with **`installments`** parameter.
Fragments all-in-oneOneShot
# Card-on-file
Server2Server with additional card-on-file integration
PCI Compliant merchants willing to stored their client´s cards on PandaBlue´s vault, have to generate a request to our API for storing cards.
> Visit the API Reference for more information on card-on-file API. Saving card\
> Card-on-file API allows merchants to create, retrieve and delete card tokens. form PandaBlue Vault.
{% hint style="info" %}
#### `micro_deposit_enabled` parameter
This parameter allows you to create a small amount transaction on the card (which is immediately refunded) prior storing it. This can be a done as a mechanism for only storing valid cards.\
Note that if the microdeposit fails, the card won't be stored.
{% endhint %}
Server2Server saving the card used in the deposit
Merchants using our Server2Server solution can opt to save the card used within the deposit request.
In order to do so, they can send the parameter **`tokenize_card`** with value **`true`** in the deposit request.
Fragments Lite
Merchants using our Fragments Lite solution can opt to save the card used within the deposit request.
In order to do so, they can send the parameter **`tokenize_card`** with value **`true`** in the deposit request.\
In the response they will receive the **`card_identifier`** which can be used for creating subsequent charges on that user's card.
Fragments all-in-one
To implement card-on-file with the Fragments all-in-one, follow the same client-side flow as described for the **OneShot solution below**. The distinction for card-on-file is handled on the backend.
OneShot
Merchants willing to use our OneShot solution can also make use of card-on-file for generating deposits on their clients' cards.
The parameter **`tokenize_card`** should be sent in the deposit request as **`true`**.
After the deposit is completed by the user you will receive a webhook notifying that the deposit status changed.\
When retrieving the deposit status you will obtain the **`card_identifier`**.
The **`card_identifier`** :
* is the token associated to the card that the user selected to pay.
* it can be used unlimited times, until the card expires.
For creating deposits with the **`card_identifier`**, you just need to include it in the deposit request.
As a response you will directly receive the final status of the payment. You can also retrieve the additional details by using the deposit status endpoint.
{% code title="Example response OneShot with card\_identifier" %}
```json
{
"deposit_id": 1324874939,
"payment_status": "APPROVED",
"success": true
}
```
{% endcode %}
# Subscriptions
Server2Server
{% hint style="success" %}
The endpoints described in this solution are restricted for usage of PCI compliant merchants that can securely handle credit card information.
{% endhint %}
#### Subscription creation
The Server2Server solution can handle subscriptions, the integration should scope the endpoint **`v3/subscriptions`** and sending the subscription details within the **`subscription[]`** object such as:
* **`start_date`** for when the charges should start (e.g.: 2025-07-23)
* Note that when the `start_date` is within the same day that the subscription is being created, the first charge will be created immediately.
* **`plan`** indicating the frequency with which the charges shoud occur (e.g.: **`MONTHLY`**)
* **`plan_unit`**" indicating how many times the **`plan`** should be charged (e.g: **`3`**)
* **`auto_renewal`** indicating if the subscription should autorenew when it finishes.
You will receive the identifier of the created subscription (**`subscription_id`**) as a response.
{% code title="Response of the Server2Server subscription endpoint" %}
```json
{
"subscription_id": 358
}
```
{% endcode %}
We will take care of doing all the subsequent charges based on the **`subscription[]`** information provided.
You will receive webhook notifications each time that a deposit was charged in concept of a subscription, in order for you to retrieve the status and matching it to the **`subscription_id` :**
{% code title="Example webhook notification" %}
```json
{
"deposit_id": 3000000001
}
```
{% endcode %}
> For more information regarding webhooks, visit the [API Reference](/deposits/create-deposits/notifications).
#### Retrieve the deposit status
When you retrieve the status of a deposit, you will know to which **`subscription_id`** correspond.
> For more information regarding deposit status retrieval, visit the [API Reference](https://docs.d24.com/api-reference/deposits-api/manage-payments/get-deposit-status).
#### Retrieve the Subscription details
You can then retrieve the status of the subscription with the **`subscription_id`** for further details.
```json
{
"id": 219,
"status": "PENDING",
"start_date": "2025-07-23",
"end_date": "2025-10-23",
"last_renovation_date": null,
"creation_date": "2025-07-23T13:15:37.54",
"subscription_plan": "MONTHLY",
"plan_unit": 3,
"amount": 70,
"auto_renewal": false,
"last_modified_date": "2025-07-23T13:15:37.54",
"renewals": 0,
"cancellation_date": null,
"currency": "BRL",
"last_charge_date": "2020-10-03",
"payment_method": "VI",
"invoice_id": "INV123456",
"error_url": "https://example.com/error",
"success_url": "https://example.com/success",
"back_url": "https://example.com/back",
"description": "Premium Subscription",
"country": "BR",
"deposits": [
{
"deposit_id": "3000000001",
"status": "COMPLETED"
}
]
}
```
> For more information regarding the Subscription details endpoint, visit the [API Reference](https://docs.d24.com/api-reference/deposits-api/manage-subscriptions/get-a-subscription).
#### Reattempts logic
Note that if by any means, a deposit within a subscription fails, in the spirit of maximizing the success scenario we will reattempt the transaction **twice**.\
One attempt each subsequent day will be performed.
Server2Server with an external billing engine
{% hint style="success" %}
The endpoints described in this solution are restricted for usage of PCI compliant merchants that can securely handle credit card information.
{% endhint %}
#### Tokenize the customer's card
Our card-on-file API lets you securely store customer payment information and charge recurring payments without handling sensitive card data after the initial tokenization.
1. Collect the customer's card information securely via your PCI-compliant form
2. Call our [card-on-file API](https://docs.d24.com/api-reference/deposits-api/saving-cards-card-on-file) to store the card
3. Receive a **`card_identifier`** token that represents the stored card
#### Create a subscription
1. Associate the **`card_identifier`** with your internal subscription record
2. Generate a unique **`external_subscription_id`** in your system
3. Store both identifiers for future transactions
#### Process recurring charges
When it's time to charge the customer:
1. Call our Server2Server deposit endpoint
2. Instead of sending full card details, send:
* The **`card_identifier`** token
* Your **`external_subscription_id`**
{% hint style="info" %}
#### Subscription endpoints
Note that as this solution handles all the subscription on the merchant's end, no subscription entity is created on our end. Therefore the subscription endpoints should be used.
{% endhint %}
OneShot with card-on-file
#### Subscription creation
The OneShot solution can create subscriptions in cards that were previously stored on file.
{% hint style="success" %}
Note that this subscription flow has a pre-requisite to have a card stored on file.\
Please visit [Card-on-file](/deposits/create-deposits/credit-cards/card-on-file) section to explore the ways in which this can be done.
{% endhint %}
The integration should scope the endpoint **`v3/subscriptions`** , while sending the **`card_identifier`** and the subscription details within the **`subscription[]`** object such as:
* **`start_date`** for when the charges should start (e.g.: 2025-07-23)
* Note that when the `start_date` is within the same day that the subscription is being created, the first charge will be created immediately.
* **`plan`** indicating the frequency with which the charges shoud occur (e.g.: **`MONTHLY`**)
* **`plan_unit`**" indicating how many times the **`plan`** should be charged (e.g: **`3`**)
* **`auto_renewal`** indicating if the subscription should autorenew when it finishes.
You will receive the identifier of the created subscription (**`subscription_id`**) as a response.
{% code title="Response of the Server2Server subscription endpoint" %}
```json
{
"subscription_id": 358
}
```
{% endcode %}
We will take care of doing all the subsequent charges based on the **`subscription[]`** information provided.
You will receive webhook notifications each time that a deposit was charged in concept of a subscription, in order for you to retrieve the status and matching it to the **`subscription_id` :**
{% code title="Example webhook notification" %}
```json
{
"deposit_id": 3000000001
}
```
{% endcode %}
> For more information regarding webhooks, visit the [API Reference](/deposits/create-deposits/notifications).
#### Retrieve the deposit status
When you retrieve the status of a deposit, you will know to which **`subscription_id`** correspond.
> For more information regarding deposit status retrieval, visit the [API Reference](https://docs.d24.com/api-reference/deposits-api/manage-payments/get-deposit-status).
#### Retrieve the Subscription details
You can then retrieve the status of the subscription with the **`subscription_id`** for further details.
> For more information regarding the Subscription details endpoint, visit the [API Reference](https://docs.d24.com/api-reference/deposits-api/manage-subscriptions/get-a-subscription).
#### Reattempts logic
Note that if by any means, a deposit within a subscription fails, in the spirit of maximizing the success scenario we will reattempt the transaction **twice**.\
One attempt each subsequent day will be performed.
OneShot with redirect
#### Subscription creation
The OneShot solution can handle subscriptions, the integration should scope the endpoint **`v3/subscriptions`** and sending the subscription details within the **`subscription[]`** object such as:
* **`start_date`** for when the charges should start (e.g.: 2025-07-23)
* Note that when the `start_date` is within the same day that the subscription is being created, the first charge will be created immediately.
* **`plan`** indicating the frequency with which the charges shoud occur (e.g.: **`MONTHLY`**)
* **`plan_unit`**" indicating how many times the **`plan`** should be charged (e.g: **`3`**)
* **`auto_renewal`** indicating if the subscription should auto-renew when it finishes.
We will take care of doing all the subsequent charges based on the **`subscription[]`** information provided.
In the response you will receive:
* the **`subscription_id`**
* the **`redirect_url`** containing the credit card form for the user to input their card details.
{% hint style="success" %}
Note that we will perform micro deposit charges to the card prior accepting it as. payment method for the subscription billing.
{% endhint %}
Webhook notifications will be sent each time that changes occured within a deposit, such as status changes to completed, in order for you to retrieve the status and matching it to the **`subscription_id` :**
{% code title="Example webhook notification" %}
```json
{
"deposit_id": 3000000001
}
```
{% endcode %}
> For more information regarding webhooks, visit the [API Reference](broken://spaces/VNE8t2FopKfzgQzTjlBb/pages/282oVrSIyWM7W7ecKR7T).
#### Retrieve the deposit status
When you retrieve the status of a deposit, you will know to which **`subscription_id`** correspond.
> For more information regarding deposit status retrieval, visit the [API Reference](https://docs.d24.com/api-reference/deposits-api/manage-payments/get-deposit-status).
#### Retrieve the Subscription details
You can then retrieve the status of the subscription with the **`subscription_id`** for further details.
```json
{
"id": 219,
"status": "PENDING",
"start_date": "2025-07-23",
"end_date": "2025-10-23",
"last_renovation_date": null,
"creation_date": "2025-07-23T13:15:37.54",
"subscription_plan": "MONTHLY",
"plan_unit": 3,
"amount": 70,
"auto_renewal": false,
"last_modified_date": "2025-07-23T13:15:37.54",
"renewals": 0,
"cancellation_date": null,
"currency": "BRL",
"last_charge_date": "2020-10-03",
"payment_method": "VI",
"invoice_id": "INV123456",
"error_url": "https://example.com/error",
"success_url": "https://example.com/success",
"back_url": "https://example.com/back",
"description": "Premium Subscription",
"country": "BR",
"deposits": [
{
"deposit_id": "3000000001",
"status": "COMPLETED"
}
]
}
```
> For more information regarding the Subscription details endpoint, visit the [API Reference](https://docs.d24.com/api-reference/deposits-api/manage-subscriptions/get-a-subscription).
#### Reattempts logic
Note that if by any means, a deposit within a subscription fails, in the spirit of maximizing the success scenario we will reattempt the transaction **twice**.\
One attempt each subsequent day will be performed.
# Authorization and capture
# Bank transfers and cash vouchers
To generate deposits for an **Alternative Payment Method** (e.g., bank transfer, cash voucher), your first step is to make a request to the OneShot endpoint with all **mandatory information**.
> For technical details of the OneShot integration please visit the API ReferenceCreate deposit
{% hint style="success" %}
### Payment methods
For available payment methods and its respective codes please check out our [Coverage](/deposits/payment-methods) section.
{% endhint %}
{% tabs %}
{% tab title="Example request" %}
This is a deposit request for a **Spei** bank transfer in :flag\_mx: Mexico.
{% endtab %}
{% endtabs %}
Once the deposit is successfully generated, the subsequent checkout process will depend on the payment method chosen and the data you provide.
There are **two** primary flows:
* Embedded checkout (recommended)
* Redirect checkout
***
### **Embedded checkout (recommended)**
For a superior and more integrated user experience, you can build the checkout instructions directly into your site. This is ideal for payment methods that don't require leaving your page, such as displaying a reference number, QR codes or bar codes for an in-store cash payment.
* **How it works:** you will need interpret the **`metadata`** object from the API response. This object contains the necessary details (e.g., a voucher code, bank details) for you to render the next steps directly on your page.
* **Advantages:** This offers a seamless, frictionless flow that keeps the user on your website.
* **Important:** While this is the highly recommended option, its availability is **dependent on the specific payment method**. Not all methods support a fully embedded experience.
{% columns %}
{% column width="33.33333333333333%" %}
{% endcolumn %}
{% column %}
{% endcolumn %}
{% endcolumns %}
### **Redirect Checkout**
This is the ideal flow if you prefer a integration without building a custom checkout UI. It's also the required process for payment methods that need user action on a third-party site (e.g., logging into a bank portal to authorize a transfer).
* **How it works:** Use the **`redirect_url`** returned in the API response to forward the user to the necessary page. This should be done in a new browser tab for the best experience.
* **User Experience:** The user is taken to a secure, external page (like their bank's website or a payment provider's portal) to complete the payment steps. At all times the user can decide to return to your site. Also right after the payment process ends, the user will be redirected to your site.
***
### **Hosted checkout**
{% hint style="warning" %}
Hosted flow is ***never*** recommended as a main deposit flow as it can impact directly on conversion rates.
{% endhint %}
In the event that **not all mandatory data is sent** in the initial API call, the system will automatically trigger an intermediate flow known as the **Hosted Flow**. This ensures the payment can still be completed.
* **What happens:** The API will return the parameter **`checkout_type`** with value **`HOSTED`** and a **`redirect_url`**.
* **Required action:** You must redirect the user to that URL. On our hosted page, we will collect the missing information from the user before presenting them with the final checkout instructions in the same tab.
# Notifications
Every time a deposit changes its status, we will send you an asynchronous notification containing the ID of the deposit.\
The webhooks are sent to:
1. the **`notification_url`** you sent in the request, or
2. to the one you have configured under the section: ***Settings*** :arrow\_right: ***API Access*** :arrow\_right: ***Confirm URL.***
**Once received the notification, you should check its new status with the** Get deposit status **endpoint** **and update it on your end accordingly.**
{% hint style="success" %}
### Firewall configurations
Bear in mind we will only connect through ports 80 and 443. \
Make sure your **`notification_url`** has one of those ports open accepting connections from us.
{% endhint %}
#### Example notification
```javascript
{
"deposit_id": 3000000001
}
```
### Testing notification in Staging
Receiving notifications accordingly is part of our [integration requirements checklist](/getting-started/start-testing#integration-checklist).
In the **Staging** environment, in order to test the full flow you can manually set a deposit to **COMPLETED** or **CANCELLED** status by: Logging in into the [STG Merchant Panel](https://merchants-stg.d24.com/login) :arrow\_right: Transactions :arrow\_right: Deposits.
Those options will change the status of the deposit, therefore **sending the respective notification to your `notification_url` after a few minutes**.
 
## Retry logic
Every time a deposit changes its status, we will send you a notification so you can check its status back.
In case that for some reason your server was unable to handle our notification and you returned an HTTP code different than **2XX**, we will retry the notification **up to 5 more times** **or until you respond with HTTP 2XX**, whatever comes first.
{% hint style="success" %}
In case of errors while handling the notification, make sure you will answer with an HTTP code distinct than 2XX, that way we will retry the notification.
{% endhint %}
The time between each of the 5 notifications attempts will be exponential: **5, 25, 125 and 625 minutes** accordingly.
When a notification failed to be sent, it will be shown like this in our Merchant Panel:
If you see the errors from the screenshot above, it means the payment was successfully completed and the money was credited to your account but suddenly **were not properly received**. Keep reading to know how to resend the notifications.
#### Resend Notifications
In case your system was unable to handle the notification in any of the 5 attempts, you can always check its status with the Get deposit status endpoint.
If you need to trigger the check status by receiving our notification, once the issue preventing you from receiving our notifications was fixed, you can go to the Merchant Panel, locate the deposit (Transactions :arrow\_right: Deposits) and click on the three dotted button under the section and then "**Resend notification**" to force a new notification to be sent.
{% hint style="success" %}
:clock1: **It can take up to 1 minute for the notification to be resent.**
{% endhint %}
# Status flow
### Understanding the deposit lifecycle
Hosted checkout status flow
Note that the Hosted flow **does not create deposits in PENDING** status as required payer information is missing in the request.
#### Status diagram explanation
Status
Description
DECLINED
The DECLINED status is not a status by itself. It means the transaction couldn't be created because of an error with the data, the customer or the merchant configuration. No transaction will change its status from DECLINED.
PENDING
Once the deposit is in PENDING status, it means it was successfully created and we are waiting for the user to complete the transaction.
FOR_REVIEW
FOR REVIEW is a transient status we use to specify that the deposit is under revision.
EARLY_RELEASED
EARLYRELEASED will only be used if you specified it in the deposit request
EXPIRED
The deposit reached it's expiration date and the user did not pay, then the status will change to EXPIRED.*
CANCELLED
If the user doesn't pays, the transaction will be marked as EXPIRED. After 7 days the status will change to CANCELLED. Final status.*
COMPLETED
If the deposit was successfully completed, its status will be set to COMPLETED. Final status.
**\*** There are cases in which the users pays after the deposit expired, or paid an incorrect amount and the deposit gets expired. When that happens manual intervention is required to approve the deposit hence a deposit could change its status from EXPIRED or CANCELLED to COMPLETED.
## Deposits status Codes
The **`status`** of the deposits are separated into different and very specific categories for you to better handle and know the behavior of your customers.
Status
Description
The deposit is created but the customer hasn't opened the link yet.
The deposit is created and the customer has opened the link but he/she didn't complete the payment flow (select payment method, complete personal details, confirm details) or the provider was unable to process the request.
The deposit is created with all the information required and it is awaiting on customer's payment. It has been marked by you to release it earlier. Please note that the customer hasn't paid yet and the money won't be credited to your balance until the customer's payment is detected.
The deposit is created with all the information required and it is awaiting on customer's payment.
The deposit didn't pass our anti-fraud systems and will be retained until manual review.
The deposit has reached its expiration time and the user didn't pay.
The deposit has been cancelled by the customer or it has been 7 days after the expiration.
The deposit has been completed and the money was credited to your account or to the payer's crypto wallet.
> Learn more about how to correctly retrieve deposit status in the API Reference Get deposit status
# Countries specialization
# SPEI Offline
### What is SPEI Offline?
The **SPEI Offline** feature offers a streamlined deposit process for your customers in Mexico. It allows them to make payments by directly transferring funds to a previously used unique CLABE account, completely bypassing the standard checkout flow.
When a customer makes a transfer, our system is instantly notified. We then analyze the transaction details to create a formal deposit record, which is sent to you for approval or rejection. This provides a faster, more convenient payment experience for repeat customers.
### How It Works
1. A customer transfers money to their unique CLABE account number.
2. We receive a notification of the incoming transfer.
3. We send a `POST` request to a webhook URL that you provide, containing all the transaction details.
4. Your system receives the request and returns a response to either **approve** or **reject** the deposit.
### Getting started
{% stepper %}
{% step %}
#### Contact your account manager
To enable this feature, please reach out to your designated Account Manager or Technical Account Manager.
{% endstep %}
{% step %}
#### Provide a webhook URL
You must provide us with a secure URL endpoint that can accept `POST` requests from our system. This URL will be used to notify you of every new SPEI Offline transaction.
When we detect a new deposit, we will send a `POST` request to your URL with the following JSON body:
```json
{
"deposit_id": 123456789,
"payer_account_number": "123456789123456789",
"country": "MX",
"document": "84932568207",
"full_name": "John Doe",
"date_of_birth": "19871027",
"address": "Ruta 13, Mexico",
"email": "jon.doe@example.com",
"amount": 200,
"currency": "MXN",
"payment_method": "SEOF"
}
```
Field
Type
Description
deposit_id
Integer
Our unique identifier for the payment deposit.
payer_account_number
String
The CLABE of the customer who made the payment.
country
String
The country of the transaction. Always "MX".
document
String
The identification document of the payer.
full_name
String
The full name of the payer.
date_of_birth
String
The payer's date of birth in YYYYMMDD format.
address
String
The address of the payer.
email
String
The email address of the payer.
amount
Number
The transaction amount.
currency
String
The currency of the payment. Always "MXN".
payment_method
String
The payment method used. Always "SEOF" for SPEI Offline.
{% endstep %}
{% step %}
#### Handle deposit notifications
Your webhook URL must be configured to handle our requests and send back a response indicating your decision.
**Approving or rejecting a deposit**
Your system's response determines the status of the payment:
* **To Approve:** Return an **HTTP**** ****`200`** status code.
* **To Reject:** Return an **HTTP**** ****`400`** status code.
{% hint style="danger" %}
*Any other HTTP status code will be treated as a rejection.*
{% endhint %}
{% endstep %}
{% step %}
***(Optional)***** Overriding default information**
By default, we generate a random **`invoice_id`** and use your account's default notification URL for these deposits. However, you can override these values by including them in the body of your `200` (Approve) response.
If you wish to provide your own identifiers, your response body should look like this:
```json
{
"invoice_id" : "YOUR_CUSTOM_INVOICE_ID",
"notification_url" : "https://merchant.com/notifications/deposit/YOUR_ID"
}
```
If this body is returned, we will use the `invoice_id` and `notification_url` you provide instead of our defaults.
{% endstep %}
{% endstepper %}
# Quickpay
**Quickpay** is a powerful feature designed to streamline user onboarding through a single, simple transaction. It allows you to create a deposit and sign up a new customer without collecting their personal details upfront.
The merchant initiate a payment with minimal information, and once the user pays, their full details (like name and document number) can be obtained via API.
{% hint style="success" %}
### Quickpay coverage
This product is currently only available for:
* Transferencias **SPEI** in Mexico
* **Pix** bank transfers in Brazil
{% endhint %}
***
### How It Works
{% stepper %}
{% step %}
#### **Create a deposit**
You send a request to our standard **`POST`** **`/deposits`** endpoint.\
The key difference is that you provide minimal or no information in the **`payer[]`** object.
> For more information regarding the deposit creation endpoint, please visit the API Reference Create deposit
{% tabs %}
{% tab title="Example request" %}
```json
{
"invoice_id" : "1000000001",
"amount": "10",
"country": "BR",
"currency": "BRL",
"payment_method": "IX",
"description": "test description",
"client_ip": "123.123.123.123",
"device_id": "00000000-00000000-01234567-89ABCDEF",
"notification_url": "https://www.merchant.com/pandablue/notify",
"test": false,
"mobile": true,
"language": "pt"
}
```
{% endtab %}
{% tab title="Example response" %}
```json
{
"checkout_type": "ONE_SHOT",
"redirect_url": "https://checkout-stg.pandablue.com/v1/gateway/show?id_payment=56578849&signature=fff0e0a6a98066c19caf",
"deposit_id": 300000025,
"user_id": "11",
"merchant_invoice_id": "1000000001",
"payment_info\"": {
"type": "BANK_TRANSFER",
"payment_method": "IX",
"payment_method_name": "Pix",
"amount": 10,
"currency": "BRL",
"expiration_date": "2020-06-17T07:04:16Z",
"created_at": "2020-06-16T19:04:16Z",
"metadata": {
"digitable_line": "00190.00009 03141.056030 01870.806179 8 83180000016564",
"qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9AQAAAACn+1GIAAACMUlEQVR4Xt3UMZKsIBAGYEjkCkOCV1sTuQIkioleQRK4miRyhSahH6Uzr2qRucASflXa0Pw0wd8LyJ8CIEKwUwentKFNSGi3tLlu3haf2rB4mHqjlAw7/wI2Rsc9HvIreKeoefFz/gZozWC9Rev/7+M3AOH2vT5nqQAxMyD9TtF++lEBUMOSIZ0gapRNSOeQGYZohui+AV9fMwjphLq3XgOuetmyXHaJRjcBRtEJac+Rm942IW0Jo5tGnuW77AOMGLJMIVMzXT99AIZDdUInM2fShpQp/NC4uaG0uwlZSfRYKsu4XmWfwFYdfHTzTtT10wckGF9TJ0HJ8122BhjsVgLjSlz80oaXUorazI9J3DdXQzI0hJKEg+7vKjVgSE6R3hpp4Qske+rFrtOPttfxH5BsCuvst/1Hw132ASVTYiQMLdDUBOgz3UI49Bbyffwa0kpI+UT0dqV32RowphDdi3nM9/EfUK4y4WYk8O0O3RPW+RyFtscM7wTVkBXzaZ8YmmG5yj4A95F0E7U263zvowbQPqZVsQhjx5uQ1ZCnjsJwknFuAhpmSxzwLB26y9ZQHnqnSKcYzD62YXr1B3caBLsHyhNYeX8h2kPC9I52BdCbrowtloeD+iaUMcM39Isv2brKPqCMLScm7oHbe/Q9IKEbbPJliCYY2rDYQ0jDYgB6PY8WlAbJoz+0+XzygKU0aSzZxWvrT8BdSY/p4NHd+agByEsMRskYYrqfaQ2/19+GfwmGnDkcom5PAAAAAElFTkSuQmCC"
}
}
}
```
{% endtab %}
{% endtabs %}
{% endstep %}
{% step %}
#### **User completes the payment**
Your customer uses the generated payment instructions (e.g., a PIX QR code or SPEI transfer details) to complete the transaction
{% endstep %}
{% step %}
#### Obtain payer information
Once the payment is confirmed, you'll receive a webhook notification to your **`notification_url`**.
> For more information on this point, please visit Notifications
This notification is your signal to query the deposit status endpoint .\
The response from this endpoint will be enriched with the payer's full details (name, document number, etc.).
> For more information on retrieving deposit status please visit the API Reference Get deposit status
You can then use this data to create or update their account in your system.
{% endstep %}
{% endstepper %}
***
### **Country specific requirements**
* **Pix** ( :flag\_br: Brazil): The **`payer`** object is not required and should be completely omitted from the request body.
* **SPEI** (🇲🇽 Mexico): The **`payer`** object is required, but it only needs one field: **`payer.id`**.\
This `id` must be a unique reference for the user within your system, not the customer's official document number (e.g., CURP).
#### Example requests
{% tabs %}
{% tab title="PIx (Brazil)" %}
```json
{
"invoice_id": "1000000001",
"amount": "10.00",
"country": "BR",
"currency": "BRL",
"payment_method": "IX",
"description": "Onboarding deposit",
"client_ip": "123.123.123.123",
"device_id": "00000000-00000000-01234567-89ABCDEF",
"notification_url": "https://your-domain.com/notifications",
"test": false
}
```
{% endtab %}
{% tab title="SPEI (Mexico)" %}
{% endtab %}
{% endtabs %}
# Biometric Pix
# Automatic Pix
# Refund a deposit
This service enables you to issue and view refunds for completed payments.
* For **card deposits**: The original charge is reversed, returning funds to the cardholder.
* For **alternative payment methods**: The customer receives a refund via a bank transfer.
Please note, a processing fee may apply to refunds.
***
> For technical details please visit the API Reference Create refunds
### Card deposits
{% tabs %}
{% tab title="Example request" %}
#### Total refund
```json
curl -L \
--request POST \
--url 'https://api-stg.pandablue.com/v3/refunds' \
--header 'Content-Type: application/json' \
--header 'X-Date: 2025-07-25T13:13:08.220Z' \
--header 'X-Login: text' \
--header 'Authorization: text' \
--data '{
"deposit_id": 300533647,
"invoice_id": "newIUnit45328732",
"comments": "Test refund",
"notification_url": "https://merchant.com/webhooks/d24/refunds"
}'
```
#### Partial refund
{% endtab %}
{% tab title="Example response" %}
```json
{
"deposit_id": 80000001,
"merchant_invoice_id": "newIUnit45328732",
"status": "COMPLETED",
"amount": 505.95
}
```
{% endtab %}
{% endtabs %}
> For technical details regarding refunds status retrieval, please visit the **API Reference** Get refund status
# Status flow
## Understanding the refund lifecycle
#### Status diagram explanation
Status
Description
DECLINED
DECLINED is not a status by itself. It means the refund failed to be created.
PENDING
As soon as the refund request is created, its status will be PENDING.
INCORRECT_DETAILS
In case we need more information to complete the request or any of the details were incorrect, we will change the status to INCORRECT_DETAILS and you will need to provide the correct details. Once the details have been provided, its status will be PENDING again.
CANCELLED
The status CANCELLED means the refund was manually cancelled by you. Only refunds in PENDING or INCORRECT_DETAILS can be cancelled. Final status.
DELIVERED
If everything is fine we will send the refund for processing and the status will be marked as DELIVERED. It can't be cancelled at this point.
REJECTED
As soon as the processor/bank confirms the refund, it will be marked as COMPLETED or REJECTED (by the bank)*
COMPLETED
As soon as the processor/bank confirms the refund, it will be marked as COMPLETED or REJECTED (by the bank) *
**\*** There are some **corner cases** in which the receiver's bank tell us that the refund was completed but days after it gets rejected. In those cases the status changes from COMPLETED to REJECTED.
### Refunds Status Codes
Status
Description
The refund is created and is pending to be processed. It can still be cancelled.
The refund is pending for you to provide more information. It can still be cancelled.
The refund has been sent to the bank for processing. It can't be cancelled anymore.
The refund has been manually cancelled. Final status.
The refund has been rejected by the bank. Final status.
The refund has been completed. Final status.
> For technical details regarding refunds status retrieval, please visit the **API Reference** Get refund status
# Chargebacks
# Overview
Our cashouts solution enable merchants to disperse payments to their users all around the globe.
### Regular cashout process
{% stepper %}
{% step %}
#### Top up your account
Ensure your merchant account has sufficient balance to cover the payouts you want to issue.\
You can either collect deposits or top-up your account.
{% endstep %}
{% step %}
#### Create a payout request
Instruct PandaBlue to send money by creating a payout request via our API **or** through the Merchant Dashboard.
{% endstep %}
{% step %}
#### Users get paid
PandaBlue processes the instruction and moves the funds from your merchant account to the end-user's bank account.
{% endstep %}
{% step %}
#### Merchant gets notified
We send a webhook notification to your system as soon as the payout is confirmed as `COMPLETED` or `REJECTED`, giving you the final status.
{% endstep %}
{% endstepper %}
### Manage cashouts
# America
Learn about the cashouts validations of the American countries
# Argentina
Check the requirements and validations made over the cashouts on Argentina
{% hint style="success" %}
**New Feature** (May 2025): \
\
**Cashouts in Argentina** now **support** both **CBU** (traditional bank accounts) and **CVU** (virtual accounts)
{% endhint %}
### Required fields
| Field | Format | Description |
| ---------------------- | ---------------------------------------------------------------------- | --------------------------------------------------- |
| `login` | String | Cashouts login |
| `pass` | String | Cashouts pass |
| `external_id` | String (max length: 100) | Transaction's ID on your end |
| `document_id` | See [document validations](#document_type-and-document_id-validations) | Beneficiary's document ID |
| `country` | `AR` | The country codes are in ISO 3166-1 alpha-2 format. |
| `currency` | `ARS` / `USD` | The currencies are in ISO 4217 format. |
| `amount` | Number with up to 2 decimals | Cashout amount |
| `bank_account` | See [bank accounts validations](#bank-account-validations) | Beneficiary's bank account |
| `beneficiary_name` | String (max length: 100) | Beneficiary's name |
| `beneficiary_lastname` | String (max length: 100) | Beneficiary's last name |
### `bank_account` validations
Use the Regex below to validate the bank accounts on your end.
#### CBU Validation Algorithm
Since the first three digits of the CBU are the bank code, it is not mandatory to send the bank\_code field.
```java
public class Validations {
static Integer CBU_LENGTH = 22;
public static Boolean verifyCBU(String cbu) {
return cbuLengthValidation(cbu) && bankCodeValidation(cbu) && accountValidation(cbu);
}
public static Boolean cbuLengthValidation(String cbu) {
return cbu.length() == 22 && ValidationsUtils.validateOnlyNumbers(cbu);
}
public static Boolean bankCodeValidation(String cbu) {
if (cbu.length() == CBU_LENGTH && ValidationsUtils.validateOnlyNumbers(cbu)) {
String shortCbu = StringUtils.left(cbu, 8);
String bankCode = shortCbu.substring(0, 3);
String branchCode = shortCbu.substring(4, 7);
int firstCheckDigit = charToInt(shortCbu.toCharArray()[3]);
int secondCheckDigit = charToInt(shortCbu.toCharArray()[7]);
int sum = charToInt(bankCode.charAt(0)) * 7 + charToInt(bankCode.charAt(1)) * 1 + charToInt(bankCode.charAt(2)) * 3 + firstCheckDigit * 9 + charToInt(branchCode.charAt(0)) * 7 + charToInt(branchCode.charAt(1)) * 1 + charToInt(branchCode.charAt(2)) * 3;
int diference = (10 - sum % 10) % 10;
return diference == secondCheckDigit;
} else {
return false;
}
}
public static Boolean accountValidation(String cbu) {
String account = cbu.substring(8, 22);
int sum = 0;
int j = 0;
int[] weighter = new int[]{3, 9, 7, 1};
char[] arrayAccount = account.toCharArray();
int checkDigit = charToInt(account.toCharArray()[13]);
for(int i = 0; i < 13; ++i) {
sum += charToInt(arrayAccount[i]) * weighter[j % 4];
++j;
}
int diference = (10 - sum % 10) % 10;
return diference == checkDigit;
}
private static int charToInt(char ch) {
return Integer.parseInt(String.valueOf(ch));
}
}
```
### `document_type` and `document_id` validations
document_type
document_id format
DNI
Numeric. Length 7-9
CUIL
Numeric. Length between 7 and 9 inclusive or equal to 11
### Example request
```json
{
"login": "xxxxxxxx",
"pass": "xxxxxxxx",
"external_id": "30000000001",
"country": "AR",
"currency": "ARS",
"amount": 10000,
"document_id": "5676586998",
"bank_account": "0000003100000098476521",
"email": "johnSmith@gmail.com",
"beneficiary_name": "John",
"beneficiary_lastname": "Smith",
"notification_url": "https://webhook.site/url",
"type": "json"
}
```
{% hint style="success" %}
Notice that the bank code is not mandatory for Argentina as it's part of the bank account.
{% endhint %}
### Bank codes
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
| Bank Name | Code |
| ---------------------------------------------- | ---- |
| A.B.N Amro Bank | 005 |
| Banco de Galicia Y Buenos Aires | 007 |
| Lloyds Tsb Bank | 010 |
| Banco de La Nación Argentina | 011 |
| Banco de La Provincia de Buenos Aires | 014 |
| Industrial and Commercial Bank of China (ICBC) | 015 |
| Citibank | 016 |
| BBVA Banco Frances | 017 |
| The Bank Of Tokyo - Mitsubishi | 018 |
| Banco de La Provincia de Cordoba | 020 |
| Superville Bank | 027 |
| Banco de La Ciudad de Buenos Aires | 029 |
| Banco Patagonia Sudameris | 034 |
| Banco Hipotecario | 044 |
| Banco de San Juan | 045 |
| Banco Do Brasil | 046 |
| Banco Del Tucuman | 060 |
| Banco Municipal de Rosario | 065 |
| Santander Río | 072 |
| Banco Regional de Cuyo | 079 |
| Banco Del Chubut | 083 |
| Banco de Santa Cruz | 086 |
| Banco de La Pampa | 093 |
| Banco de Corrientes | 094 |
| Banco Provincia Del Neuquen | 097 |
| Banco Empresario de Tucuman Coop. | 137 |
| Banco B. I. Creditanstalt | 147 |
| HSBC Bank Argentina | 150 |
| J P Morgan Chase Bank Sucursal Buenos Aires | 165 |
| Banco Credicoop Coop. | 191 |
| Banco de Valores | 198 |
| Banco Roela | 247 |
| Banco Mariva | 254 |
| Banco Itau Buen Ayre | 259 |
| Bank Of America | 262 |
| Banca Nazionale Del Lavoro | 265 |
| Bnp Paribas | 266 |
| Banco Provincia de Tierra Del Fuego | 268 |
| Banco de La República Oriental Del Uruguay | 269 |
| Banco Saenz | 277 |
| Banco Meridian | 281 |
| Banco Macro Bansud | 285 |
| Banco Mercurio | 293 |
| Ing Bank | 294 |
| American Express Bank Ltd. | 295 |
| Banco Banex | 297 |
| Banco Comafi | 299 |
| Banco de Inversión Y Comercio Exterior | 300 |
| Banco Piano | 301 |
| Banco Finansur | 303 |
| Banco Julio | 305 |
| Banco Privado de Inversiones | 306 |
| Nuevo Banco de La Rioja | 309 |
| Banco Del Sol | 310 |
| Nuevo Banco Del Chaco | 311 |
| M. B. A. Banco de Inversiones | 312 |
| Banco de Formosa | 315 |
| Banco CMF | 319 |
| Banco de Santiago Del Estero | 321 |
| Nuevo Banco Industrial de Azul | 322 |
| Deutsche Bank | 325 |
| Nuevo Banco de Santa Fe | 330 |
| Banco Cetelem Argentina | 331 |
| Banco de Servicios Financieros | 332 |
| Banco Cofidis | 335 |
| Banco Bradesco Argentina | 336 |
| Banco de Servicios Y Transacciones | 338 |
| Rci Ba | 339 |
| Bacs Banco de Crédito Y Securitización | 340 |
| Nuevo Banco de Entre Rios | 386 |
| Nuevo Banco Suquia | 387 |
| Nuevo Banco Bisel | 388 |
| Banco Columbia | 389 |
| Mercado Pago | 031 |
# Bolivia
Check the requirements and validations made over the cashouts on Bolivia
### Required fields
### `bank_account` validations
Use the Regex below to validate the bank accounts on your end.
| Bank name | Format | Regex | Example |
| --------- | ------------------------------------- | ------------ | ---------- |
| All | Numeric. Between 4 and 30 characters. | `^\d{4,30}$` | 1234567890 |
### `account_type`
The `account_type` is specified with only one character described below.
| account\_type | Description |
| :-----------: | ----------------- |
| **`C`** | Checkings account |
| **`S`** | Savings account |
### `document_type` and `document_id` validations
document_type
document_id format
CI
Numeric. Length: 7
CIE
Alphanumeric. One character followed by 8 digits
NIT
Alphanumeric. One character followed by 6 digits
PASS
Numeric. Length: 12
### Example request
```java
{
"login": "xxxxxxx",
"pass": "xxxxxxx",
"external_id": "30000000001",
"country": "BO",
"currency": "BOB",
"amount": 100,
"document_type": "PASS",
"document_id": "B225255",
"beneficiary_name": "User",
"bank_account": "1234567890",
"bank_code": "001",
"account_type": "C",
"notification_url": "https://webhook.site/url",
"type": "json"
}
```
### Bank codes
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
| Bank | Code |
| ---------------------------------------------------- | ---- |
| Banco Nacional de Bolivia S.A. | 001 |
| Banco PYME Ecofuturo S.A. | 002 |
| Banco Mercantil Santa Cruz S.A. | 003 |
| Almacenes Internacionales S.A. | 004 |
| Banco de Crédito de Bolivia S.A. | 005 |
| Warrant Mercantil Santa Cruz S.A. | 006 |
| Banco de la Nación Argentina S. A. | 007 |
| Banco Do Brasil S.A.- Sucursal Bolivia | 008 |
| Banco BISA S.A. | 009 |
| E-fectivo ESPM S.A. | 010 |
| Banco Unión S.A. | 014 |
| Banco Económico S.A. | 016 |
| Banco Solidario S.A. | 017 |
| Banco Ganadero S.A. | 018 |
| Banco PYME de la Comunidad S.A. | 032 |
| Banco para el Fomento a Iniciativas Económicas S.A. | 033 |
| Banco Fortaleza S.A. | 034 |
| Banco Fassil S.A. | 035 |
| Banco Prodem S.A. | 036 |
# Brazil
Check the requirements and validations made over the cashouts on Brazil
### Required fields
| Field | Format | Description |
| ------------------ | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `login` | String | Cashouts login |
| `pass` | String | Cashouts pass |
| `external_id` | String (max length: 100) | Transaction's ID on your end |
| `document_id` | Numeric. Length 11 (Validate verifier-digits) | Beneficiary's CPF. |
| `country` | `BR` | The country codes are in ISO 3166-1 alpha-2 format. |
| `currency` | `BRL` / `USD` | The currencies are in ISO 4217 format. |
| `amount` | Number with up to 2 decimals | Cashout amount |
| `bank_code` | See [bank codes](/cashouts/countries-validations/american-countries/brazil#bank-codes) | Code specifying the beneficiary's bank |
| `bank_account` | See [validations below](/cashouts/countries-validations/american-countries/brazil#bank-account-validations) | Beneficiary's bank account |
| `bank_branch` | See [validations below](#bank-branch-validations) | Beneficiary's bank branch |
| `account_type` | See [account type codes](/cashouts/countries-validations/american-countries/brazil#account-types) | Beneficiary's bank account type |
| `beneficiary_name` | String (max length: 100) | Beneficiary's name |
| `phone` | String (max length: 20 characters - up to 15 digits) | Beneficiary's phone - Optional unless using PIX key phone. |
| `email` | String (max length: 100) | Beneficiary's email - Optional unless using PIX key email. |
### `bank_account` validations
Use the Regex below to validate the bank accounts on your end.
Bank name
Bank code
Format
Regex
Example
Banco do Brasil
001
Format: DDDDDDDDD-X or DDDDDDDDDX where D are digits and X is a digit or the letter 'X'. The number of digits may change, but can't exceed 10 digits
^\d{1,9}(-)?[\dxX]$
1234567890, 123456789-0, 123456789-X, 123456789X
Santander
033
Format: DDDDDDDDD, DDDDDDDDDD, DDDDDDDDD-D, DDDDDDDDD-D where D are digits. The number of digits has to be from 9 to 10
^\d{7,10} (-)?[\d]$
12345678, 12345678-9
Banrisul
041
Format: DDDDDDDDD-D or DDDDDDDDDD where D are digits. The number of digits has to be 10
^\d{9}(-)?[\d]$
1234567890, 123456789-0
Caixa
104
Format: DDDDDDDDD-D or DDDDDDDDDDDDDD-D where D are digits. The number of digits has to be between 1 and 15
^\d{1,14}(-)?[\d]$
1234567890,
123456789-0, 12345678901234-5
Bradesco
237
Format: DDDDDDD-D or DDDDDDDD where D are digits. The number of digits may change, but can't exceed 8 digits
^\d{1,7}(-)?[\d]$
12345678, 1234567-8
Mercado Pago
323
Format: DDDDDDDDDD-D or DDDDDDDDDDD where D are digits. The number of digits may change, but can't exceed 11 digits
^\d{1,9}(-)?[\d]$
12345678910, 1234567891-0
Itaú
341
Format: DDDDDD-D or DDDDDDD where D are digits. The number of digits may change but ranges from 6 to 7
^\d{1,7} (-)?[\d]$
123456, 12345-6
Pix Key Phone
10000
Empty string
^$
Pix Key Email
10001
Empty string
^$
Pix Key Document
10002
Empty string
^$
""
Others
-
Format: DDDDDDDDDD-D or DDDDDDDDDDD where D are digits. The number of digits may change, but can't exceed 11 digits
^\d{1,9}(-)?[\d]$
123456789, 123456789-0
### `bank_branch` validations
Use the Regex below to validate the valid (and invalid) bank branches on your end.
Bank name
Bank code
Format
Regex
Exceptions
Banco do Brasil
001
Format: DDDD-X or DDDDX where D are digits and X is a digit or the letter 'X'. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\dxX]$
Can't have 4 zeros and a digit.
^0{0,4}(-)?[\dxX]$
1234-1, 1234-X, 12341, 1234X
Santander
033
Format: DDDD where D are digits. The number of digits may change, but can't exceed 4 digits
^\d{1,4}$
Can't be 033
^033$
1234
Banrisul
041
Format: DDDD-X or DDDDX where D are digits and X is a digit or the letter 'X'. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\dxX]$
N/A
1234-1, 1234-X, 12341, 1234X
Banco Inter
077
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't start with zeros followed by 77
^0{0,3}77$
1234-1, 12341
Caixa
104
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't be: 001/013/023/104
^001$|^013$|^023$|^104$
1234-1, 12341
Banco Original
212
Format: DDDDD-D or DDDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't start with zeros followed by 212
^0{0,2}212$
1234-1, 12341
Bradesco
237
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't be 237
^237$
1234-1, 12341
Banco Nu Pagamento
260
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
^\d{1,4}(-)?[\d]$
Can't start with zeros followed by 260
^0{0,2}260$
1234-1, 12341
PagSeguro
290
Format: DDD-D or DDDD where D are digits. The number of digits may change, but can't exceed 4 digits
^\d{3}(-)?[\d]$
Can't start with zeros followed by 290
^0{0,2}290$
123-4, 1234
Mercado Pago
323
N/A
N/A
N/A
0001
Itau
341
Format: DDDD-D or DDDDD where D are digits. The number of digits may change, but can't exceed 5 digits
bank_account and bank_branch must be empty. The field acount_type can have any value. The field phone must be sent
Pix Key Email
10001
bank_account and bank_branch must be empty. The field acount_type can have any value. The field email must be sent
Pix Key Document
10002
bank_account and bank_branch must be empty. The field acount_type can have any value. The field document_id must be sent
Pix Key Random
10003
bank_branch must be empty. The field account_type can have any value. The field bank_account must be sent - this indicates the customer's PIX random key
If a payout is created without the mandatory fields, it will be rejected.
### Bank codes
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
Bank
Code
BANCO DO BRASIL S.A.
001
BANCO DA AMAZONIA S.A.
003
BANCO DO NORDESTE DO BRASIL S.A.
004
BANESTES S.A. BANCO DO ESTADO DO ESPIRITO SANTO
021
Banco Alfa S.A.
025
BANCO SANTANDER BRASIL S.A.
033
BANCO ABN AMRO S.A
075
BANCO DO ESTADO DO PARA S.A. - BANPARA
037
BANCO DO ESTADO DO RIO GRANDE DO SUL S.A. - BANRISUL
041
BANCO DO ESTADO DE SERGIPE S.A. - BANESE
047
BANCO DE BRASILIA S.A. - BRB
070
BANCO INTER
077
Banco Original do Agronegócio S.A.
079
Cooperativa Central de Crédito (VIACREDI)
085
POLOCRED SCMEPP
093
Credisis - Central de Cooperativas de Crédito Ltdav
097
XP INVESTIMENTOS S.A
102
CAIXA ECONOMICA FEDERAL - CEF
104
Banco BOCOM BBM S.A.
107
BANCO AGIPLAN S.A.
121
Confederação Nacional das Cooperativas Centrais Unicred
136
Stone Pagamentos S.A
197
Banco BTG Pactual S.A.
208
BANCO ORIGINAL
212
BANCO BONSUCESSO S.A.
218
Banco Fibra S.A.
224
BANCO BRADESCO S.A.
237
NU PAGAMENTOS
260
Will Financeira S.A.
280
PagSeguro Internet S.A
290
Banco BPP Instituição de Pagamento S/A
301
BANCO BMG S.A
318
China Construction Bank Banco Múltiplo S.A.
320
MERCADOPAGO.COM REPRESENTACOES LTDA.
323
BANCO BARI DE INVESTIMENTOS E FINANCIAMENTOS S.A
330
BAcesso Soluções de Pagamento S.A
332
Banco Digio S.A
335
BANCO C6 S.A
336
ITAU UNIBANCO S.A.
341
GERENCIANET S.A
364
Banco Société Générale Brasil S.A.
366
PICPAY SERVICOS S.A
380
BANCO MERCANTIL DO BRASIL S.A.
389
Banco Hub pagamentos SA
396
HSBC BANK BRASIL S.A. - BANCO MULTIPLO
399
CORA SCD S.A
403
Banco BV S.A.
413
BANCO SAFRA S.A.
422
CITIBANK N.A.
477
Deutsche Bank S.A. – Banco Alemão
487
JPMorgan Chase Bank, National Association
488
ING Bank N.V.
492
Banco Credit Suisse S.A.
505
Neon Pagamentos S.A. IP
536
Banco PAN S.A.
623
BANCO SOFISA
637
Banco Votorantim S.A.
655
BANCO DAYCOVAL S.A.
707
BANCO OURINVEST S.A
712
BANCO CITIBANK
745
BANCO MODAL S.A.
746
Banco Rabobank International Brasil S.A.
747
BANCO COOPERATIVO SICREDI S.A.
748
Banco BNP Paribas Brasil S.A.
752
BANCO COOPERATIVO DO BRASIL S/A - BANCOOB
756
iCash
998
Pix Key Phone
10000
Pix Key Email
10001
Pix Key Document
10002
# Canada
Check the requirements and validations made over the cashouts on Canada
### Required fields
| Field | Format | Description |
| ---------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `login` | String | Cashouts login |
| `pass` | String | Cashouts pass |
| `external_id` | String (max length: 100) | Transaction's ID on your end |
| `document_id` | See [document validations](#document-validations) | Beneficiary's document ID |
| `country` | `CA` | The country codes are in ISO 3166-1 alpha-2 format. |
| `currency` | `CAD` / `USD` | The currencies are in ISO 4217 format. |
| `amount` | Number with up to 2 decimals | Cashout amount |
| `bank_code` | [Valid](/cashouts/countries-validations/american-countries/canada#bank-codes) bank code | Code specifying the beneficiary's bank |
| `bank_account` | [Valid](/cashouts/countries-validations/american-countries/canada#bank-account-validations) bank account | Beneficiary's bank account |
| `bank_branch` | [Valid](/cashouts/countries-validations/american-countries/canada#bank-branch-validations) institute number | Beneficiary's institute number |
| `email` | [Valid](/knowledge-base/countries-specifications#emails-validations) email address | Beneficiary's email address |
| `beneficiary_name` | String (max length: 100) | Beneficiary's name |
| `beneficiary_lastname` | String (max length: 100) | Beneficiary's last name |
### bank\_account validations
Use the Regex below to validate the bank accounts on your end.
| Bank name | Bank code | Format | Regex | Example |
| --------- | :-------: | --------------------------------------------------------------- | ------------ | ------------ |
| Etransfer | 10000 | For Etransfer, the bank\_account must come empty: "" (Not null) | `^$` | |
| Others | - | Numeric between 3 and 16 digits. | `^\d{3,16}$` | 738746356473 |
### `bank_branch` Validations
Use the Regex below to validate the valid (and invalid) bank branches on your end.
Bank name
Bank code
Format
Regex
Example
Etransfer
10000
For Etransfer, the bank_branch must come empty: "" (not null)
^$
Others
-
String of 5 characters
^[\s\S]{5}$
12345
### `email` validations
Bank name
Bank code
Required
Example
Etransfer
10000
Yes
johnSmith1@gmail.com
Others
-
No
-
### `document` validations
Document type
Format
HC (Health Card)
Numeric. Length 10
PASS (Passport)
Length between 8 and 12 inclusive
### Example request
{% tabs %}
{% tab title="Etransfer" %}
```json
{
"login": "xxxxxxxx",
"pass": "xxxxxxxx",
"external_id": "30000000001",
"country": "CA",
"currency": "CAD",
"amount": 100,
"document_id": "5676586998",
"bank_account": "",
"bank_code": "10000",
"bank_branch": "",
"email": "johnSmith@gmail.com",
"beneficiary_name": "John",
"beneficiary_lastname": "Smith",
"notification_url": "https://webhook.site/url",
"type": "json"
}
```
{% endtab %}
{% tab title="Banks" %}
```json
{
"login": "xxxxxxxx",
"pass": "xxxxxxxx",
"external_id": "30000000001",
"country": "CA",
"currency": "CAD",
"amount": 100,
"document_id": "5676586998",
"bank_account": "38749027362",
"bank_code": "001",
"bank_branch": "12345",
"email": "johnSmith@gmail.com",
"beneficiary_name": "John",
"beneficiary_lastname": "Smith",
"notification_url": "https://webhook.site/url",
"type": "json"
}
```
{% endtab %}
{% endtabs %}
### Bank codes
{% hint style="info" %}
### **Approval times**
* **Etransfer approval time:** Up to one business day
* **Banks approval time:** Up to four business days
{% endhint %}
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
| Bank Name | Code |
| ----------------------------------------------------------------------- | ----- |
| Etransfer | 10000 |
| BANK OF MONTREAL | 001 |
| THE BANK OF NOVA SCOTIA | 002 |
| ROYAL BANK OF CANADA | 003 |
| THE TORONTO-DOMINION BANK | 004 |
| BANQUE NATIONALE DU CANADA | 006 |
| CANADIAN IMPERIAL BANK OF COMMERCE | 010 |
| HSBC BANK CANADA | 016 |
| CANADIAN WESTERN BANK | 030 |
| BANQUE LAURENTIENNE DU CANADA | 039 |
| BANK OF CANADA | 177 |
| CANADA SAVINGS BOND REDEMPTION CERTIFICATE | 187 |
| ATB FINANCIAL | 219 |
| BANK OF AMERICA NATIONAL ASSOCIATION | 241 |
| THE BANK OF NEW YORK MELLON | 242 |
| THE BANK OF TOKYO-MITSUBISHI UFJ LTD | 245 |
| BARCLAYS BANK OF CANADA | 248 |
| BNP PARIBAS | 250 |
| CITIBANK CANADA | 260 |
| DEUTSCHE BANK AG | 265 |
| MEGA INTERNATIONAL COMMERCIAL BANK (CANADA) | 269 |
| JPMORGAN CHASE BANK, NATIONAL ASSOCIATION | 270 |
| KEB HANA BANK CANADA | 275 |
| MIZUHO CORPORATE BANK LTD CANADA BRANCH | 277 |
| NATIONAL BANK OF GREECE (CANADA) | 286 |
| UBS BANK (CANADA) | 290 |
| SBI CANADA BANK | 294 |
| SUMITOMO MITSUI BANKING CORPORATION CAN. | 301 |
| AMEX BANK OF CANADA | 303 |
| INDUSTRIAL AND COMMERCIAL BANK OF CHINA | 307 |
| BANK OF CHINA (CANADA) | 308 |
| CITIZENS BANK OF CANADA | 309 |
| FIRST NATIONS BANK OF CANADA | 310 |
| BOFA CANADA BANK | 311 |
| JP MORGAN BANK CANADA | 314 |
| CTBC BANK CORP. (CANADA) | 315 |
| HABIB CANADIAN BANK | 321 |
| CAPITAL ONE BANK (CANADA BRANCH) | 323 |
| STATE STREET | 327 |
| CITIBANK, NA | 328 |
| COMERICA BANK | 330 |
| FIRST COMMERCIAL BANK | 332 |
| VERSABANK | 334 |
| UNITED OVERSEAS BANK LIMITED | 335 |
| CANADIAN TIRE BANK | 338 |
| ICICI BANK CANADA | 340 |
| ZAG BANK | 342 |
| HOLLIS CANADIAN BANK | 343 |
| SOCIETE GENERALE (CANADA BRANCH) | 346 |
| DIRECTCASH BANK | 352 |
| SHINHAN BANK CANADA | 355 |
| HOME BANK | 361 |
| WELLS FARGO BANK NA CANADIAN BRANCH | 362 |
| CHINA CONTRUCTION BANK (TORONTO BRANCH) | 366 |
| WEALTH ONE BANK OF CANADA | 370 |
| BANK OF CHINA (TORONTO BRANCH) | 372 |
| TRUST GENERAL INC | 506 |
| COMMUNITY TRUST COMPANY LTD | 507 |
| THE CANADA TRUST COMPANY | 509 |
| TRUST LA LAURENTIENNE | 522 |
| THE EFFORT TRUST COMPANY | 532 |
| HOME SAVINGS AND LOAN CORPORATION | 535 |
| INVESTORS GROUP TRUST COMPANY LTD | 536 |
| MANULIFE BANK OF CANADA | 540 |
| MONTREAL TRUST COMPANY | 544 |
| MENNONITE TRUST LIMITED | 547 |
| CIBC TRUST CORPORATION | 548 |
| MONTREAL TRUST COMPANY OF CANADA | 550 |
| SUN LIFE FINANCIAL TRUST INC. | 551 |
| PEACE HILLS TRUST COMPANY | 568 |
| ROYAL TRUST COMPANY (THE) | 570 |
| ROYAL TRUST COMPANY (THE) | 580 |
| NATIONAL TRUST COMPANY | 590 |
| CS ALTERNA BANK | 608 |
| TANGERINE BANK | 614 |
| B2B BANK | 618 |
| PEOPLES TRUST COMPANY | 621 |
| EQUITABLE BANK | 623 |
| MANULIFE TRUST COMPANY | 626 |
| THE TORONTO-DOMINION BANK | 715 |
| LATVIAN CREDIT UNION LTD | 803 |
| DUCA FINANCIAL SERVICES CREDIT UNION LTD | 806 |
| CENTRAL 1 CREDIT UNION | 809 |
| ALL TRANS FINANCIAL SERVICES CREDIT UNION LTD | 810 |
| AAA GROUP CLEARER NOT UNIQUE | 815 |
| CAISSE FINANCIAL GROUP | 819 |
| CREDIT UNIONS IN NOVA SCOTIA | 821 |
| CENTRAL 1 CREDIT UNION | 828 |
| FEDERATION DES CAISSES POPULAIRES DE L'ONTARIO | 829 |
| CREDIT UNIONS IN NEW BRUNSWICK | 831 |
| COMMUNITY FIRST - A DIVISION OF YOUR NEIGHBOURHOOD CREDIT UNION LIMITED | 834 |
| CAISSE POPULAIRE DE KAPUSKASING LIMITEE | 836 |
| MERIDIAN CREDIT UNION LIMITED | 837 |
| CREDIT UNION CENTRAL OF NOVA SCOTIA | 839 |
| DUNDALK DISTRICT CREDIT UNION LTD | 840 |
| CREDIT UNIONS IN QUEBEC | 841 |
| ALTERNA SAVINGS AND CREDIT UNION LTD | 842 |
| RAPPORT CREDIT UNION | 846 |
| BRUNSWICK CREDIT UNION FEDERATION LTD | 849 |
| CREDIT UNIONS IN ONTARIO | 851 |
| CONCENTRA BANK | 853 |
| GOLDEN HORSESHOE CREDIT UNION LTD | 854 |
| FEDERATION DES CAISSES POPULAIRES ACADIENNES | 865 |
| CREDIT UNION CENTRAL OF MANITOBA | 879 |
| CREDIT UNION CENTRAL OF SASKATCHEWAN | 889 |
| L'ALLIANCE DES CAISSES POPULAIRES DE L'ONTARIO | 890 |
| CENTRAL 1 CREDIT UNION ALBERTA | 899 |
# Chile
Check the requirements and validations made over the cashouts on Chile
### Required fields
| Field | Format | Description |
| ------------------ | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `login` | String | Cashouts login |
| `pass` | String | Cashouts pass |
| `external_id` | String (max length: 100) | Transaction's ID on your end |
| `document_id` |
Length 8 or 9
Document types: ID / RUN / RUT
| Beneficiary's document ID |
| `country` | `CL` | The country codes are in ISO 3166-1 alpha-2 format. |
| `currency` | `CLP` / `USD` | The currencies are in ISO 4217 format. |
| `amount` | Number with up to 2 decimals | Cashout amount |
| `bank_code` | See [bank codes](/cashouts/countries-validations/american-countries/chile#bank-codes) | Code specifying the beneficiary's bank |
| `bank_account` | See [validations below](/cashouts/countries-validations/american-countries/chile#bank-account-validations) | Beneficiary's bank account |
| `account_type` | See [account type codes](/cashouts/countries-validations/american-countries/chile#account-types) | Beneficiary's bank account type |
| `beneficiary_name` | String (max length: 100) | Beneficiary's name |
### `bank_account` validations
| Bank name | Bank code | Format | Regex | Example |
| --------- | :-------: | ------- | ------------ | ---------- |
| All | - | Numeric | `^\d{6,16}$` | 1234567890 |
### `account_type`
The `account_type` is specified with only one character as described below.
| account\_type | Description |
| :-----------: | ----------------- |
| **`C`** | Checkings account |
| **`S`** | Savings account |
| **`V`** | Salary account |
### Example request
```java
{
"login": "xxxxxxxx",
"pass": "xxxxxxxx",
"external_id": "30000000001",
"country": "CL",
"currency": "CLP",
"amount": 100,
"document_id": "56765869",
"bank_account": "56687456",
"bank_code": "001",
"account_type": "C",
"beneficiary_name": "User",
"notification_url": "https://webhook.site/url",
"type": "json"
}
```
### Bank codes
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
| Bank | Code |
| --------------------------- | ---- |
| Banco de Chile | 001 |
| Banco Edwards | 001 |
| Citi | 001 |
| Banco Internacional | 009 |
| Banco del Estado de Chile | 012 |
| Scotiabank Sud Americano | 014 |
| Banco Crédito e Inversiones | 016 |
| Corpbanca Bank | 027 |
| Banco Bice | 028 |
| HSBC Bank | 031 |
| Banco Santander- Santiago | 037 |
| Banco Itaú | 039 |
| ABN Amor Bank Chile | 046 |
| Banco Security | 049 |
| Banco Falabella | 051 |
| Deutsche Bank | 052 |
| Banco Ripley | 053 |
| Radobank Chile | 054 |
| Consorcio | 055 |
| Banco Penta | 056 |
| Banco Paris | 057 |
| BCI (Mach) | 116 |
| BBVA Banco Bhif | 504 |
| Banco del Desarrollo | 507 |
# Colombia
Check the requirements and validations made over the cashouts on Colombia
## Required fields
| Field | Format | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `login` | String | Cashouts login |
| `pass` | String | Cashouts pass |
| `external_id` | String (max length: 100) | Transaction's ID on your end |
| `document_id` | See [document validations](/cashouts/countries-validations/american-countries/colombia#document-validations) | Beneficiary's document ID |
| `document_type` | See [document validations](/cashouts/countries-validations/american-countries/colombia#document-validations) | Beneficiary's document type |
| `country` | `CO` | The country codes are in ISO 3166-1 alpha-2 format. |
| `currency` | `COP` / `USD` | The currencies are in ISO 4217 format. |
| `amount` | Number with up to 2 decimals | Cashout amount |
| `bank_code` | See [bank codes](/cashouts/countries-validations/american-countries/colombia#bank-codes) | Code specifying the beneficiary's bank |
| `bank_account` | See [validations below](/cashouts/countries-validations/american-countries/colombia#bank-account-validations) | Beneficiary's bank account |
| `account_type` | See [account type codes](/cashouts/countries-validations/american-countries/colombia#account-types) | Beneficiary's bank account type |
| `beneficiary_name` | String (max length: 100) | Beneficiary's name |
| `beneficiary_lastname` | String (max length: 100) | Beneficiary's last name |
| `address` | String (max length: 255) | Beneficiary's address |
| `phone` | String (max length: 20). [See validations](/cashouts/countries-validations/american-countries/colombia#phone-validations) | Beneficiary's phone number |
| `email` | String (max length: 255) | Optional Field - Only required for Punto Red |
### `bank_account` validations
| Bank name | Bank code | Format | Regex | Example |
| ---------------- | :-------: | -------------------------------------------- | ---------------- | ------------- |
| Pandablue Wallet | 30000 | Customer's mobile phone | `^[\s\S]{1,20}$` | +57 15551234 |
| Nequi | 1507 | Customer's mobile phone | `^[\s\S]{1,20}$` | 5715551234 |
| Daviplata | 1551 | Customer's mobile phone | `^[\s\S]{1,20}$` | 5715551234 |
| Efecty | 10003 | Empty string | `^$` | |
| Punto Red | 10006 | Customer's mobile phone and customer's email | `^[\s\S]{1,20}$` | 5715551234 |
| Others | - | Numeric[^1] | `^\d{8,19}$` | 1234567890123 |
### `account_type`
The `account_type` is specified with only one character as described below.
| account\_type | Description |
| :-----------: | ----------------- |
| **`C`** | Checkings account |
| **`S`** | Savings account |
### `phone` validations
Bank name
Bank code
Format
Required
Example
Efecty
10003
Numeric - Country code +57 plus 10 digits +57 XXX XXXXXXX
Yes
+57 310 4028587
Punto Red
10006
Numeric - Country code +57 plus 10 digits +57 XXX XXXXXXX
{% endtab %}
{% endtabs %}
#### BREB Cashouts - Types of Keys
| Bank | Bank Code | Bank Details |
| ----------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| BREB Key Phone | 20000 | `bank_account` must contain the phone value. `bank_branch` must be empty. `phone` is required. `account_type` can be any value. |
| BREB Key Email | 20001 | `bank_account` must contain the email value. `bank_branch` must be empty. `email` is required. `account_type` can be any value. |
| BREB Key Document | 20002 | `bank_account` must contain the document\_id value. `bank_branch` must be empty. `document_id` is required. `account_type` can be any value. |
| BREB Key Random | 20003 | `bank_branch` must be empty. The field `account_type` can have any value. The field `bank_account` must be sent - this indicates the customer's BREB random key |
### Bank codes
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
| Bank | Code |
| ----------------------------------- | ----- |
| BANCO DE BOGOTÁ | 001 |
| BANCO POPULAR | 002 |
| ITAÚ - Antes CORPBANCA | 006 |
| BANCOLOMBIA | 007 |
| ABN AMRO | 008 |
| CITIBANK | 009 |
| HSBC | 010 |
| BANCO SUDAMERIS | 012 |
| BBVA | 013 |
| ITAÚ (HELM) | 014 |
| BANCO COLPATRIA | 019 |
| BANCO DE OCCIDENTE | 023 |
| BANCOLDEX S.A. | 031 |
| BANCO CAJA SOCIAL BCSC | 032 |
| BANCO AGRARIO | 040 |
| BANCO MUNDO MUJER | 047 |
| BANCO DAVIVIENDA | 051 |
| BANCO AV VILLAS | 052 |
| BANCO W S.A. | 053 |
| BANCO PROCREDIT | 058 |
| BANCAMIA S.A. | 059 |
| BANCO PICHINCHA | 060 |
| BANCOOMEVA | 061 |
| BANCO FALABELLA S.A | 062 |
| BANCO FINANDINA | 063 |
| BANCO MULTIBANK S.A. | 064 |
| SANTANDER | 065 |
| BANCO COMPARTIR S.A. | 067 |
| BANCO SERFINANZA S.A. | 069 |
| LULO BANK S.A | 070 |
| J.P. MORGAN COLOMBIA | 071 |
| COOPCENTRAL S.A. | 076 |
| BANCO DALE | 097 |
| Directa24 | 100 |
| COOPERATIVA FINANCIERA DE ANTIOQUIA | 283 |
| COTRAFA COOPERATIVA FINANCIERA | 289 |
| COOFINEP | 291 |
| CONFIAR | 292 |
| FINANCIERA JURISCOOP | 296 |
| BANCO UNION | 303 |
| COLTEFINANCIERA | 370 |
| BANCO CREDIFINANCIERA S.A. | 558 |
| IRIS | 637 |
| MOVII | 801 |
| Nubank | 809 |
| RAPPIPAY | 811 |
| BANCO W | 1053 |
| MIBANCO | 1067 |
| ASOPAGOSS | 1086 |
| JFK COOPERATIVA FINANCIERA | 1286 |
| NEQUI | 1507 |
| DAVIPLATA | 1551 |
| BAN100 CREDIFINANCIERA | 1558 |
| PIBANK | 1560 |
| DING TECNIPAGOS SA | 1802 |
| POWWI | 1803 |
| UALA | 1804 |
| BANCO BTG PACTUAL | 1805 |
| BOLD CF | 1808 |
| COINK | 1812 |
| GLOBAL66 | 1814 |
| D24 Card | 10001 |
| Su Red | 10002 |
| Efecty | 10003 |
| TPAGA Wallet | 10005 |
| PUNTO RED | 10006 |
| BREB | 1184 |
| Pandablue Wallet | 30000 |
[^1]: Numeric
# Pandablue Wallet: Cashouts to the Panda Wallet
Pandablue Wallet is Pandablue's digital wallet for beneficiaries in Colombia. Instead of sending funds to a bank account, merchants can send cashouts directly to a beneficiary's Pandablue Wallet using
## Key Features
**Same Cashouts API.** No additional integration is required. Cashouts to the Pandablue Wallet use the standard cashout request — only the `bank_code` changes to `30000`, and `bank_account` carries the beneficiary's wallet phone number.
**Beneficiary identification by phone number.** The wallet account is identified by the mobile phone number the beneficiary registered in the Pandablue Wallet app, not by a bank account number. Make sure the phone number you send matches the one registered in the beneficiary's wallet.
## Request Validations
| Field | Format | Notes |
| ------------------------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `bank_code` | `30000` | Fixed value for Pandablue Wallet |
| `bank_account` | Beneficiary's mobile phone | The mobile number registered in the beneficiary's Pandablue Wallet, e.g. `+57 3001234567`. Regex `^[\s\S]{1,20}$` |
| `account_type` | `C` | Fixed value |
| `phone` | Beneficiary's mobile phone | Same value as `bank_account` |
| `document_type` / `document_id` | `CC`, `NIT`, `CE`, `PASS` | Same rules as standard Colombia cashouts |
| `email` | Optional | |
All remaining fields (`login`, `pass`, `external_id`, `country` = `CO`, `currency` = `COP`, `amount`, `beneficiary_name`, `beneficiary_lastname`, `address`, `notification_url`) follow the standard Colombia cashout validations.
{% hint style="warning" %}
**The phone number format is not validated at request time.** The `bank_account` regex accepts any value between 1 and 20 characters, so a malformed or unregistered phone number will **not** return a validation error. The cashout will be accepted and later transition to `REJECTED`. Always send the phone number exactly as the beneficiary registered it in the Pandablue Wallet app.
{% endhint %}
## Example Request
```json
{
"login": "xxxxxxxx",
"pass": "xxxxxxxx",
"external_id": "30000000001",
"country": "CO",
"currency": "COP",
"amount": 185000,
"document_id": "848392783",
"document_type": "CC",
"bank_account": "+57 3001234567",
"bank_code": "30000",
"account_type": "C",
"phone": "+57 3001234567",
"email": "beneficiary@email.com",
"beneficiary_name": "User",
"beneficiary_lastname": "Test",
"address": "Calle 18, Colombia",
"notification_url": "https://webhook.site/url",
"type": "json"
}
```
## Status Flow & Notifications
Cashouts to the Pandablue Wallet are processed asynchronously:
{% stepper %}
{% step %}
## `CREATED`
The cashout request was accepted.
{% endstep %}
{% step %}
## `DELIVERED`
The cashout is being credited to the beneficiary's wallet. This transition typically happens within minutes.
{% endstep %}
{% step %}
## `COMPLETED` or `REJECTED`
Funds were credited to the beneficiary's Pandablue Wallet, or the credit could not be applied.
{% endstep %}
{% endstepper %}
The final status is delivered asynchronously to your `notification_url`. Always rely on the notification (or the status endpoint) rather than the synchronous response to confirm the credit.
## Rejection Scenarios
If the cashout cannot be credited, it transitions to `REJECTED` and the rejection reason is included in the notification. Common scenarios:
| Scenario | What to check |
| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| The phone number is not registered to an active Pandablue Wallet | Confirm with the beneficiary that the phone number you sent is the one registered in their wallet |
| Beneficiary data doesn't match the wallet owner | Verify `beneficiary_name`, `beneficiary_lastname` and `document_id` against the wallet owner's data |
| The withdrawal expired before being credited | Create a new cashout request |
| Invalid `bank_account` format | Ensure the value is a valid Colombian mobile number |
Rejections are final. To retry, create a new cashout request with a new `external_id` and the corrected data.
# Bre-B: Colombia’s Instant Payment System
Bre-B is Colombia’s new real-time payments platform launched by the Central Bank. It allows users to send and receive funds instantly via unique “Bre-B keys.”
#### Key Features
**Bre-B Keys (Claves Bre-B):**\
Users can register identifiers such as phone numbers, email addresses, national IDs, or randomly generated aliases. Each key is mapped to a specific financial account for instant transfers.
**Cashouts to Bre-B Keys:**\
Merchants can initiate withdrawals to a user’s Bre-B key instead of a traditional bank account number, streamlining the payout process and ensuring faster fund delivery.
#### Supported Bre-B Key Types (and bank\_code)
| Bank / Channel | Code | Notes |
| ------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| BREB Key — Phone | `20000` | `bank_account` must contain the phone value. `bank_branch` must be empty. `phone` is required. `account_type` can be any value. |
| BREB Key — Email | `20001` | `bank_account` must contain the email value. `bank_branch` must be empty. `email` is required. `account_type` can be any value. |
| BREB Key — Document | `20002` | `bank_account` must contain the document\_id value. `bank_branch` must be empty. `document_id` is required. `account_type` can be any value. |
| BREB Key — Random | `20003` | `bank_branch` must be empty. `bank_account` must contain the BRE-B random key string. `account_type` can be any value. |
#### Cashout Validations for Colombia
To successfully process cashouts in Colombia, the following parameters and formats must be respected:
| Field | Description / Format |
| ------------------------------------------- | ------------------------------------------------------------ |
| `login` / `pass` | Merchant credentials for cashout API access |
| `external_id` | Merchant transaction ID (max length 100) |
| `country` | Must be `CO` |
| `currency` | `COP` or `USD` |
| `amount` | Numeric, up to two decimal places |
| `document_id` / `document_type` | Accepts `CC`, `NIT`, `CE`, or `PASS`, depending on user type |
| `bank_code` | 1184 |
| `bank_account` | Numeric format, length depending on the selected bank |
| `account_type` | `C` (checking) or `S` (savings) |
| `beneficiary_name` / `beneficiary_lastname` | Text fields, required |
| `address` | Optional, depending on method |
| `phone` | Must include country code `+57` |
| `email` | Optional, required only for certain payout methods |
***
# Ecuador
Check the requirements and validations made over the cashouts on Ecuador
### Required fields
| Field | Format | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- |
| `login` | String | Cashouts login |
| `pass` | String | Cashouts pass |
| `external_id` | String (max length: 100) | Transaction's ID on your end |
| `document_id` | See [document validations](/knowledge-base/countries-specifications#documents-validations) | Beneficiary's document ID |
| `country` | `EC` | The country codes are in ISO 3166-1 alpha-2 format. |
| `currency` | `USD` | The currencies are in ISO 4217 format. |
| `amount` | Number with up to 2 decimals | Cashout amount |
| `bank_code` | See [bank codes](/cashouts/countries-validations/american-countries/ecuador#bank-codes) | Code specifying the beneficiary's bank |
| `bank_account` | See [validations below](/cashouts/countries-validations/american-countries/ecuador#bank-account-validations) | Beneficiary's bank account |
| `account_type` | See [account type codes](/cashouts/countries-validations/american-countries/ecuador#account-types) | Beneficiary's bank account type |
| `beneficiary_name` | String (max length: 100) | Beneficiary's name |
| `beneficiary_lastname` | String (max length: 100) | Beneficiary's last name |
### `bank_account` validations
Bank name
Bank code
Format
Regex
Example
All
-
Numeric between 5 and 20 digits
^\d{5,20}$
1234567890
PayPhone
10007
593 (Ecuador Country code) + 9 digits Cellphone
^\d{5,12}$
593985512345
### `account_type`
The `account_type` is specified with only one character as described below.
| account\_type | Description |
| :-----------: | ----------------- |
| **`C`** | Checkings account |
| **`S`** | Savings account |
### `document_id` validations
Document type
Format
CC
Numeric. Length between 9 and 10 inclusive
DL
Numeric. Length 10
RUC
Numeric. Length between 12 and 13 inclusive and ends with 001
PASS
Alphanumeric. Length between 8 and 13 inclusive and ends with 001
### Example request
{% tabs %}
{% tab title="Bank" %}
```json
{
"login": "xxxxxxxx",
"pass": "xxxxxxxx",
"external_id": "30000000001",
"country": "EC",
"currency": "USD",
"amount": 100,
"document_id": "0809283023",
"bank_account": "56687456387234",
"bank_code": "001",
"account_type": "C",
"beneficiary_name": "John",
"beneficiary_lastname": "Smith",
"notification_url": "https://webhook.site/url",
"type": "json"
}
```
{% endtab %}
{% tab title="PayPhone" %}
```json
{
"login": "xxxxxxxx",
"pass": "xxxxxxxx",
"country": "EC",
"amount": 5,
"currency": "USD",
"external_id": "300000000001",
"cashout_type": "BANK",
"document_id": "***********",
"beneficiary_name": "Test",
"beneficiary_lastname": "Test",
"email": "",
"phone": "",
"notification_url": "",
"bank_code": 10007,
"bank_branch": "",
"bank_account": "593985512345",
"account_type": "C",
"document_type": "CC",
"address": ""
}
```
{% endtab %}
{% endtabs %}
### Bank codes
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
| Bank | Code |
| ------------------------------------ | ---- |
| Banco Pichincha C.A. | 010 |
| Banco de Guayaquil S.A | 017 |
| Banco City Bank | 024 |
| Banco Machala | 025 |
| Banco de Loja | 029 |
| Banco del Pacifico | 030 |
| Banco Internacional | 032 |
| Banco Amazonas | 034 |
| Banco del Austro | 035 |
| Produbanco / Promerica | 036 |
| Banco Bolivariano | 037 |
| Comercial de Manabi | 039 |
| Banco General Ruminahui S.A. | 042 |
| Banco del Litoral S.A. | 043 |
| Banco Solidario | 059 |
| Banco Procredit S.A. | 060 |
| Banco Capital | 061 |
| Banco Desarrollo de Los Pueblos S.A. | 065 |
| Banecuador B.P. | 066 |
| Banco Delbank S.A. | 201 |
# Mexico
Check the requirements and validations made over the cashouts on Mexico
### Required fields
Field
Format
Description
login
String
Cashouts login
pass
String
Cashouts pass
external_id
String (max length: 100)
Transaction's ID on your end
document_id
Length between 7 and 18 inclusive. CURP / RFC / IFE / PASS
Beneficiary's document ID
country
MX
The country codes are in ISO 3166-1 alpha-2 format.
### Cashouts to debit cards
In Mexico, we accept cashouts to be sent directly to debit cards.
Note that specifically those cashouts, must be sent through a different endpoint URL:
* STG endpoint for Debit Cards: **`https://cc-api-stg.directa24.com/v3/cashout`**
* PROD endpoint for Debit Cards: Email with your cashout API Key
The bank accounts in Mexico are in [CLABE](https://en.wikipedia.org/wiki/CLABE) format (numeric) and have 18 digits (without dashes). Therefore one way to detect that a bank account specified by the customer is a **debit card** is by checking with the[ luhn algorithm ](https://www.geeksforgeeks.org/luhn-algorithm/)if it is a valid card number and/or with a regex for each brand, like the example below.
```java
public static final String SENSIBLE_DATA_PATTERN = new StringBuilder("(?:(?4[0-9]{12}(?:[0-9]{3})?)")
.append("|(?5[1-5][0-9]{14})")
.append("|(?6(?:011|5[0-9]{2})[0-9]{12})")
.append("|(?3[47][0-9]{13})")
.append("|(?3(?:0[0-5]|[68][0-9])?[0-9]{11})")
.append("|(?(?:2131|1800|35[0-9]{3})[0-9]{11}))")
.toString();
private boolean validateCreditCard(CashoutRequestDto request) {
final String bankAccount = request.getBank_account();
if (StringUtils.isEmpty(bankAccount) || !LuhnCheckDigit.LUHN_CHECK_DIGIT.isValid(bankAccount) ||
bankAccount.matches(Constants.SENSIBLE_DATA_PATTERN)) {
return false;
}
return true;
}
```
If true, send the request through the **`cc-api`** endpoint, if false send it through the normal endpoint. The integration and requirements remains exactly the same, only changing the error message returned in case of invalid bank account and that we validate the **`bank_account`** sent to be a valid credit card number using the [Luhn Algorithm](https://en.wikipedia.org/wiki/Luhn_algorithm).
{% hint style="warning" %}
### Ensure to match debit card cashouts with correct URL.
Sending a debit card number through the non-cc endpoint will make the request to fail with the following error:
{% code overflow="wrap" %}
```java
{
"code": 300,
"message": "bank_account: Invalid bank account, it shouldn't be a credit card"
}
```
{% endcode %}
Also, you may receive the following error if an invalid `bank_account` is sent to the cc-api endpoint:
```java
{
"code": 300,
"message": "bankAccount: invalid credit card number"
}
```
{% endhint %}
### `bank_account` validations
Below you will find the format and value validations that we perform on the **`bank_account`** parameter.
### `bank_account` validations
| Bank name | Format |
| --------- | --------------------------------- |
| All | Numeric. Between 3 and 20 digits. |
### `document_type` and `document_id` validations
Document type
Format
CRC / CRP / DNI / PASS / RUC
Length Between 3 and 15 characters
CIC
Length between 6 to 8 characters
### Example request
```json
{
"login": "xxxxxxx",
"pass": "xxxxxxx",
"external_id": "30000000001",
"country": "PY",
"currency": "PYG",
"amount": 100,
"document_type": "PASS",
"document_id": "1225255",
"beneficiary_name": "User",
"bank_account": "1234567890",
"bank_code": "1",
"notification_url": "https://webhook.site/url",
"type": "json"
}
```
### Bank codes
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
| Bank | Code |
| -------------------------------- | ---- |
| BANCO CENTRAL DEL PARAGUAY | 001 |
| BANCO NACIONAL DE FOMENTO | 002 |
| BANCO DE LA NACION ARGENTINA | 003 |
| BANCO GNB PARAGUAY | 4 |
| BANCO DO BRASIL | 6 |
| SUDAMERIS BANK | 8 |
| BANCO ITAU PARAGUAY | 17 |
| BANCO CONTINENTAL | 20 |
| BANCO BASA (ex Amambay) | 30 |
| VISION BANCO | 39 |
| BANCO RIO (Ex - Itapua) | 40 |
| BANCO FAMILIAR | 41 |
| BANCO ATLAS | 42 |
| BANCOP | 43 |
| INTERFISA BANCO | 44 |
| UENO BANK S.A | 6557 |
| CRISOL Y ENCARNACION FINANCIERA | 6558 |
| FINLATINA S.A. DE FINANZAS | 6559 |
| FINANCIERA PARAGUAYO-JAPONESA | 6560 |
| FINANCIERA EXPORTADORA PARAGUAYA | 6561 |
| TU FINANCIERA | 6565 |
| FIC S.A. DE FINANZAS | 7079 |
# Peru
Check the requirements and validations made over the cashouts on Peru
### Required fields
| Field | Format | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `login` | String | Cashouts login |
| `pass` | String | Cashouts pass |
| `external_id` | String (max length: 100) | Transaction's ID on your end |
| `document_id` | See [document validations](#document_type-and-document_id-validations) | Beneficiary's document ID |
| `document_type` | See [document validations](#document_type-and-document_id-validations) | Beneficiary's document type |
| `country` | `PE` | The country codes are in ISO 3166-1 alpha-2 format. |
| `currency` | `PEN` / `USD` | The currencies are in ISO 4217 format. |
| `amount` | Number with up to 2 decimals | Cashout amount |
| `bank_account` | See [validations below](/cashouts/countries-validations/american-countries/peru#bank-account-validations) | Beneficiary's bank account |
| `account_type` | See[ account types](/cashouts/countries-validations/american-countries/peru#account-types) | Beneficiary's bank account type |
| `phone` | Number 10-11 digits | Customer's Phone. Mandatory for Yape\&Plin |
| `beneficiary_name` | String (max length: 100) | Beneficiary's name |
| `beneficiary_lastname` | String (max length: 100) | Beneficiary's last name |
### `bank_account` validations
Bank name
Bank code
Description
Format
Example
All
-
CCI - Código de Cuenta Interbancaria
Length 20 (with verifying digits - a validation algorithm is ran over these)
00219300153895206813
Yape
901
Empty string
^$
Plin
902
Empty string
^$
#### CCI validation algorithm
Since the first three digits of the CCI are the bank code, it is not mandatory to send the `bank_code` field. However, we validate those 3 first digits to be a valid `bank_code`.
{% tabs %}
{% tab title="Java" %}
{% code title="Peru CCI validation algorithm in Java" %}
```java
public final class Validations {
static Integer CCI_LENGTH_ST = 18;
static Integer CCI_LENGTH_FST = 20;
static String EMPTY_CHECK_DIGITS = "00";
public static boolean validateBankAccount(String bankAccount) {
if (!ValidationsUtils.validateOnlyNumbers(bankAccount)) {
return false;
} else {
int accountLength = bankAccount.length();
String lastDigits = bankAccount.substring(bankAccount.length() - 2);
if (accountLength == CCI_LENGTH_ST && lastDigits.equals(EMPTY_CHECK_DIGITS)) {
return true;
}
return validateCCI(bankAccount);
}
}
//Validate CCI bank account
public static boolean validateCCI(String cci) {
if (validateCCILength(cci)) {
String cciWithoutCheck = cci.substring(0, cci.length() - 2);
String checkDigits = cci.substring(cci.length() - 2);
String calculatedCheckDigits = getCciCheckDigits(cciWithoutCheck);
return checkDigits.equals(calculatedCheckDigits);
}
return false;
}
public static boolean validateCCILength(String cci) {
return cci.length() == CCI_LENGTH_FST;
}
public static String getCciCheckDigits(String cci) {
int firstControlNumber = calculateCheckDigit(cci.substring(0, 6));
int secondControlNumber = calculateCheckDigit(cci.substring(6, 18));
return String.valueOf(firstControlNumber) + String.valueOf(secondControlNumber);
}
private static int calculateCheckDigit(String cci) {
int total = 0;
int factor = 1;
for (int i = 0; i < cci.length(); i++) {
String[] cciArray = cci.split("");
int num = Integer.parseInt(cciArray[i]);
if (num * factor < 10) {
total += (num * factor);
} else {
int product = (num * factor);
String product_str = Integer.toString(product);
int firstDigit = Integer.parseInt(product_str.substring(0, 1));
int lastDigit = product % 10;
total += firstDigit + lastDigit;
}
factor = factor == 1 ? 2 : 1;
}
return (total % 10) > 0 ? 10 - (total % 10) : 0;
}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### `account_type`
The `account_type` is specified with only one character as described below.
| account\_type | Description |
| :-----------: | ----------------- |
| **`C`** | Checkings account |
| **`S`** | Savings account |
### `document_type` and `document_id` validations
document_type
document_id format
CE/CPP
Numeric. Length 9
DNI
Numeric. Length 8-9
PASS
Numeric. Length 12
RUC
Length 11
### `phone` validations
Bank name
Bank code
Format
Required
Example
Yape
901
Numeric - Country code +51 plus 10 digits +51 XXXXXXXXX
Yes
+51901671234
Plin
902
Numeric - Country code +51 plus 9 digits +51 XXXXXXXXX
{% endtab %}
{% endtabs %}
### Bank codes
{% hint style="success" %}
### Bank code retrieval via API
For the full and most up-to-date list of banks and its codes, please check this endpoint Get bank codes
{% endhint %}
| Bank | Code |
| -------------------------------------------- | ---- |
| Banco de Crédito del Peru | 002 |
| Interbank | 003 |
| Citibank | 007 |
| Scotiabank | 009 |
| BBVA Continental | 011 |
| Banco de la Nación | 018 |
| Banco de Comercio | 023 |
| Banco Financiero | 035 |
| Banco Interamericano de Finanzas (BIF) | 038 |
| Crediscotia Financiera | 043 |
| Mi Banco | 049 |
| Banco GNB Peru S.A | 053 |
| Banco Falabella | 054 |
| Santander | 056 |
| Caja Metropolitana de Lima | 800 |
| Caja Municipal de Ahorro y Credito Piura SAC | 801 |
| Caja Municipal de Ahorro y Crédito Trujillo | 802 |
| Caja Municipal de Ahorro y Crédito Arequipa | 803 |
| Caja Municipal de Ahorro y Crédito Sullana | 805 |
| Caja Municipal de Ahorro y Crédito Cuzco | 806 |
| Caja Municipal de Ahorro y Crédito Huancayo | 808 |
| Yape | 901 |
| Plin | 902 |
# Africa
Learn about the cashouts validations of the African countries
### Available countries
{% columns %}
{% column %}
🇧🇯 Benin
🇧🇼 Botswana
🇨🇲 Cameroon
🇨🇬 Congo Brazzaville
🇨🇩 Congo DRC
🇪🇬 Egypt
🇬🇦 Gabon
🇬🇭 Ghana
🇨🇮 Ivory Coast
{% endcolumn %}
{% column %}
🇰🇪 Kenya
🇳🇬 Nigeria
🇲🇼 Malawi
🇲🇱 Mali
🇷🇼 Rwanda
🇿🇦 South Africa
🇹🇬 Togo
🇺🇬 Uganda
🇿🇲 Zambia
{% endcolumn %}
{% endcolumns %}
{% hint style="success" %}
#### Interested in expanding to :earth\_africa: Africa?
Please get in touch with your commercial representative, we can guide you through!
{% endhint %}
# Asia
Learn about the cashouts validations of the Asian countries
### Available countries
{% columns %}
{% column %}
🇧🇩 Bangladesh
🇨🇳 China
🇭🇰 Hong Kong
🇮🇳 India
🇮🇩 Indonesia
🇯🇵 Japan
{% endcolumn %}
{% column %}
🇲🇾 Malaysia
🇵🇰 Pakistan
🇹🇭 Thailand
🇹🇷 Turkey
🇻🇳 Vietnam
{% endcolumn %}
{% endcolumns %}
{% hint style="success" %}
#### Interested in expanding to :earth\_asia: Asia?
Please get in touch with your commercial representative, we can guide you through!
{% endhint %}
# Oceania
Learn about the cashouts validations of the Asian countries
### Available countries
* :flag\_au: Australia
{% hint style="success" %}
#### Interested in expanding to Oceania?
Please get in touch with your commercial representative, we can guide you through!
{% endhint %}
# Create cashouts
# API Integration
Our Cashouts API enable merchants to generate local withdrawals in every country that PandaBlue operates. In order to do so, **merchants need provide the in each transaction the local banking details required**.
Therefore, it is important to properly understand the Countries validations within each market that the merchant is willing to operate.
***
### Integration flow
{% stepper %}
{% step %}
### Cashout creation
{% tabs %}
{% tab title="Example request" %}
Merchants need to send **all the required local information** for creating the transaction.
In this example, in :flag\_mx: Mexico we need the document, the bank account, the beneficiary name and last name.
{% endtab %}
{% tab title="Example response" %}
In response, merchants receive the transaction identifier (`cashout_id`).
```json
{
"cashout_id": "8405147"
}
```
{% endtab %}
{% endtabs %}
> For technical details, please visit the API Reference Create a cashout
> {% endstep %}
{% step %}
### Webhook notification
Each time that a cashout changes its status we will send a webhook notification.
> Please visit Notifications
> {% endstep %}
{% step %}
### Retrieve the cashout status
By creating a request to the cashout status endpoint you will capable od retrieving the final status of the transaction.
{% tabs %}
{% tab title="Example request" %}
{% endtab %}
{% tab title="Example response" %}
```json
{
"cashout_status": 1,
"cashout_status_description": "Completed"
}
```
For more information regarding the **`cashout_status`**, please visit Cashout status codes
{% endtab %}
{% endtabs %}
> For technical details, please visit the API Reference Get a cashout status
> {% endstep %}
> {% endstepper %}
{% hint style="info" %}
### Additional flows
Note that the flow described above corresponds to a regular cashout completion flow.
Within the cashout lifecycle, cashouts can also be **CANCELLED** or put **ON\_HOLD** status.\
For more information visit the API References:
* Cashout cancellation
* Update to On Hold
{% endhint %}
# Pay users via Merchant Panel
# Notifications
Every time a cashout changes its status, we will send you an asynchronous notification containing the ID of the cashout by **POST** protocol in **x-www-form-urlencoded** format.
The webhooks are sent to:
1. the **`notification_url`** you sent in the request, or
2. to the one you have configured under the section: ***Settings*** :arrow\_right: ***API Access*** :arrow\_right: ***Withdrawal URL.***
**Once received the notification, you should check its new status with the** Get cashout status **endpoint** **and update it on your end accordingly.**
{% hint style="success" %}
### Firewall configurations
Bear in mind we will only connect through ports 80 and 443. \
Make sure your **`notification_url`** has one of those ports open accepting connections from us.
{% endhint %}
#### Example notification
```http
date=2020-03-12%2020%3A26%3A11
&bank_reference_id=
&comments=
&external_id=cashoutV35381
&control=A4CFF64E78C4BD01F8BFCA4AFF04632EC4A33CC61BD6BBD156BA1289897892EB
&cashout_id=60067
&status_reason=
```
Field
Format
Description
date
Date. Format: YYYY-MM-DD HH:MM:SS (GMT)
Date the cashout changed its status
bank_reference_id
String (max. 50 chars)
Reference ID of the bank if any
comments
String (max. 200 chars)
Comments of the cashout if any
external_id
String (max. 100 chars)
ID of the cashout you sent while creating the request
control
String
Control signature of the notification
cashout_id
Number
ID of the cashout on our end
status_reason
String
Reason of the status if any
### Control String
The control string for the notifications is made up of some random characters at the beginning and the end of the request and the **`external_id`** received in the middle.
{% hint style="info" %}
The control string should be generated using your own secret key (API Signature) and must be in upper case.
Make sure you convert the message to hash to **UTF-8** to prevent errors.
{% endhint %}
Check the examples below on how to calculate the control string for the notifications:
{% tabs %}
{% tab title="JAVA" %}
```java
public static void main(String[] args) throws IOException, NoSuchAlgorithmException, InvalidKeyException {
String external_id = "cashoutID1234";
String message = "Be4" + external_id + "Bo7";
String apiSignature = "your_cashout_api_signature";
Mac hasher = Mac.getInstance("HmacSHA256");
hasher.init(new SecretKeySpec(apiSignature.getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
byte[] result = hasher.doFinal(message.getBytes(StandardCharsets.UTF_8));
System.out.println(StringUtils.upperCase(DatatypeConverter.printHexBinary(result)));
}
```
{% endtab %}
{% tab title="PHP" %}
```php
$external_id = 'cashoutID1234';
$message = 'Be4' . $external_id . 'Bo7';
$api_signature = 'cashout_api_signature';
$hash = strtoupper(hash_hmac('sha256', pack('A*', $message), pack('A*', $api_signature)));
```
{% endtab %}
{% tab title="C#" %}
```csharp
string external_id = "cashoutID1234";
string message = "Be4" + external_id + "Bo7";
string apiSignature = "your_cashouts_api_signature";
byte[] keyByte = new System.Text.Encoding.UTF8.GetBytes(apiSignature);
byte[] messageBytes = new System.Text.Encoding.UTF8.GetBytes(message);
byte[] hashmessage = new HMACSHA256(keyByte).ComputeHash(messageBytes);
string control = BitConverter.ToString(hashmessage).Replace("-", "").ToUpper();
```
{% endtab %}
{% endtabs %}
### Testing notification in Staging
Receiving notifications accordingly is part of our [integration requirements checklist](/getting-started/start-testing#integration-checklist).
In the **Staging** environment, in order to test the full flow you can manually set a cashout to **COMPLETED,** **CANCELLED, REJECTED or ON HOLD** status by: Logging in into the [STG Merchant Panel](https://merchants-stg.d24.com/login) :arrow\_right: Transactions :arrow\_right: Withdrawals.
Those options will change the status of the deposit, therefore **sending the respective notification to your `notification_url` after a few minutes**.
### Retry logic
Every time a cashout changes its status, we will send you a notification so you can Get cashout status back.
In case that for some reason your server was unable to receive the notification and you returned an HTTP code different than 2XX, we will retry the notification up to 5 more times or until you respond with HTTP 2XX, whatever comes first.
{% hint style="success" %}
In case of errors while handling the notification, make sure you will answer with an HTTP code distinct than 2XX, that way we will retry the notification.
{% endhint %}
The time between the 5 notifications attempts will be of 5 minutes each.
When the notification failed to be sent, it will be shown like this in our Merchant Panel:
If you see the errors from the screenshot above, it means the cashout was successfully completed but suddenly we couldn't notify you. Keep reading to know how to resend the notifications.
### Resend Notifications
In case your system was unable to receive the notification in any of the 5 attempts, you can always check its status with the Get cashout status
If you need to trigger the check status by receiving our notification, once the issue preventing you from receiving our notifications was fixed, you can go to the Merchant Panel, locate the cashout (Transactions :arrow\_right: Withdrawals) and click on the three dotted button under the section and then "**Resend notification**" to force a new notification to be sent.:clock1: **It can take up to 2 minutes for the notification to be resent.**
{% hint style="success" %}
:clock1: **It can take up to 2 minutes for the notification to be resent.**
{% endhint %}
# Status flow
### Understanding the cashout lifecycle
#### Status diagram explanation
Status
Description
DECLINED
The DECLINED status is not a status by itself. It means the transaction couldn't be created because of an error with the data, the customer or the merchant configuration. No transaction will change its status from DECLINED.
PENDING
Once the cashout is in PENDING status, it means it was successfully created and that it will be send for processing soon, changing to DELIVERED. It can also be manually changed to ON_HOLD or CANCELLED.
ON_HOLD
A cashout will be created with ON_HOLD status only if specified while creating the cashout with on_hold: true. Otherwise, it can be manually set to ON_HOLD from the Merchant Panel. If a cashout is ON_HOLD, it won't be send for processing until you manually go and set it to PENDING from the Merchant Panel. It can still be CANCELLED.
CANCELLED
It means you didn't want to proceed with the cashout and it was CANCELLED through the Merchant Panel or through the Cancel Cashout Endpoint. Final status.
DELIVERED
As soon as the cashout is sent to the bank for processing, its status will change to DELIVERED. At which point it can't be cancelled anymore.
COMPLETED
If the cashout was successfully completed, its status will be set to COMPLETED. Final status*.
REJECTED
If the cashout was rejected by the bank, its status will be set to REJECTED.
Final status.
**\*** There are cases in which the banks confirm that a payout was successfully processed and after a few days, it gets returned by the beneficiary's bank therefore the status on our platform will change to REJECTED as well. Those are corner cases but must be considered.
### Cashout status codes
In the cashout status endpoint you will receive a **`cashout_status`** code.\
Below you will find the codes and associated status:
Code
Meaning
Description
0
The cashout was accepted by PandaBlue but it wasn't sent to the bank yet. It can still be Canceled.
1
The money reached the customer's account
2
The cashout was cancelled by you
3
The cashout was rejected by the bank due to invalid bank account, account closed, etc.
4
The cashout was sent to the bank for processing. At this point it can't be cancelled anymore
5
Cashout set to on hold by you. It won't be processed until manually changed again to Pending status
# Overview
Our Platforms solution enables platforms and fintechs to scale their operations by creating a network of SubMerchants, managing their payment flows, and capturing revenue from every transaction (if desired).
Key aspects include:
* [x] Smooth SubMerchant onboarding.
* [x] Scalable deposit creation.
* [x] All parties are aware and accountable of their own balance by providing real-time fidelity and transparency.
{% hint style="success" %}
#### Get in touch
If you consider that your business may be suitable for this solution get in touch with your Account Manager or a Sales representative!
{% endhint %}
### Build the solution
We count with several APIs for helping Platfoms upscale their SubMerchant creation and management. By clicking in the cards below you will find specific pages with information on those topics.
# Onboarding
The primary method for onboarding new sub-merchants is through our **Referral Signup Link**.
Once your platform is eligible, your account manager will provide a unique URL. You should present this link to the clients you wish to onboard as sub-merchants.
When your client uses this link, the form will:
* [x] Collect all the necessary information to create their merchant account.
* [x] Automatically apply all required configurations for them to start processing payments.
The form is mobile-responsive and can be embedded directly into your platform using an `iframe` for a seamless user experience.
### Matching Submerchants with your system
To easily track and match a new sub-merchant with the corresponding user in your own system, you can add a **query parameter** to the referral URL.
Append the **`externalSubMerchantId`** parameter to the end of the URL you received, using your internal identifier for that user.
Format:
**`&externalSubMerchantId=`**`{YourUniqueSubMerchantID}`
Example: If your referral URL is `https://example.pandablue.com/referral?id=XYZ123` and your internal user ID is `user-9876`, the final URL would be:
`https://example.pandablue.com/referral?id=XYZ123&`**`externalSubMerchantId=user-9876`**
### Onboarding confirmation
After a submerchant successfully completes the signup form, you will receive a webhook Notification confirming that their account has been created.
# Notifications
Each time that a Submerchant:
* is successfully onboarded through the Referral Signup Form, or
* a change in information has occurred in a Submerchant of yours
A webhook notification will be sent to the Referral URL that you defined at:
> Merchant Panel :arrow\_right: Settings :arrow\_right: API Access :arrow\_right: **Referral URL**
{% hint style="info" %}
#### Firewall configurations
Bear in mind we will only connect through ports 80 and 443. Make sure your `Referral URL` has one of those ports open accepting connections from us.
{% endhint %}
#### Example
```json
{
"sub_merchant_id":18703
}
```
Field
Format
Description
sub_merchant_id
Integer
Identifier of the SubMerchant on our end.
### Retrieve Submerchant details
With the received **`sub_merchant_id`** you can now retrieve the recently created Submerchant's details.
In order to do so, you can generate an API request to the Get submerchant information or you can visit the dedicated section in the Merchant Panel ("Referred merchants").
{% code title="Example response GET /v3/sub\_merchants/{sub\_merchant\_id}" %}
```json
{
"sub_merchant_id": 18703,
"markup_fee": 2.00,
"sub_merchant_name": "Dunder Mifflin",
"email": "johndoe@pandablue.com",
"status": "ACTIVE",
"external_submerchant_id":"user-9876"
}
```
{% endcode %}
{% hint style="success" %}
#### `markup_fee`
The `markup_fee` is the commision that the Platform receives for each transaction successfully created by the Submerchant.\
Note that the `markup_fee` received in the response, is the default value for all recently created Submerchants. It can be aligned with your commercial representative.
You can update the value via API Update a comission and also through the Merchant Panel (in the *Referred merchants* section).
{% endhint %}
{% hint style="warning" %}
#### `status`
Note that only Submerchants with status `ACTIVE` are capable to process payments.
{% endhint %}
# Manage Submerchants payments
# Create a deposit
Our payments solution for platforms ***easily adapts*** to all our deposit creation flows.
Merchants willing to use this model, just need to include in the deposit request the **`sub_merchant_id`** parameter indicating in the value, for which of their Submerchants the deposit belongs.
Server2Server
To understand with our deposit solution is more suitable for your needs, please visit the Deposits overview page.
# Create a cashout
Merchants willing to create cashouts for your Submerchant accounts, they just need to include the **`sub_merchant_id`** parameter in the cashout request, indicating in the value to which of their submerchant the cashout corresponds.
# Countries Specifications
Learn how to validate the country's specific details
## Countries and currencies
* The country codes are in **ISO 3166-1 alpha-2** format.
* The currencies are in **ISO 4217** format.
| Country | Country code
(ISO 3166-1 alpha-2 code) | Currency code
(ISO 4217) |
| ------------------ | :----------------------------------------: | :---------------------------: |
| Argentina | AR | USD / ARS |
| Australia | AU | USD / AUS |
| Brazil | BR | USD / BRL |
| Bangladesh | BD | USD/BDT |
| Bolivia | BO | USD / BOB |
| Cameroon | CM | USD / XAF |
| Canada | CA | USD / CAD |
| Chile | CL | USD / CLP |
| China | CN | USD/CNY |
| Colombia | CO | USD / COP |
| Costa Rica | CR | USD / CRC |
| Côte d'Ivoire | CI | USD / XOF |
| Dominican Republic | DO | USD / DOP |
| Ecuador | EC | USD |
| Egypt | EG | USD/EGP |
| El Salvador | SV | USD / SVC |
| Ghana | GH | USD / GHS |
| Guatemala | GT | USD / GTQ |
| Honduras | HN | USD / HNL |
| India | IN | USD / INR |
| Indonesia | ID | USD / IDR |
| Japan | JP | USD / JPY |
| Kenya | KE | USD / KES |
| Malaysia | MY | USD / MYR |
| Mexico | MX | USD / MXN |
| Nicaragua | NI | USD / NIO |
| Nigeria | NG | USD / NGN |
| Panama | PA | USD |
| Peru | PE | USD / PEN |
| Paraguay | PY | USD / PYG |
| Philippines | PH | USD / PHP |
| Singapore | SG | USD / SGD |
| South Africa | ZA | USD / ZAR |
| Tanzania | TZ | USD / TZS |
| Turkey | TR | USD/TRY |
| Thailand | TH | USD / THB |
| Uganda | UG | USD / UGX |
| Uruguay | UY | USD / UYU |
| Venezuela | VE | USD / VES |
| Vietnam | VN | USD / VND |
## Documents validations
The `document` sent must follow the validations for its respective `document_type` described below.
| Country | Document type | Validation |
| ------------------ | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Argentina | DNI | Numeric. Length 7-9 |
| Argentina | CUIL | Numeric. Length between 7 and 9 inclusive or equal to 11 |
| Bangladesh | ID | Numeric. Length: 10 digits |
| Bangladesh | PASS |
Length 9 digits, Starting with 2 alphanumerical character (i.e: AB1234567)
|
| Bangladesh | DL (Driving license) |
Length: 15, Starting with 2 alphanumerical characters, followed by 7 numerical digits, 1 alphanumerical character and finally 5 numerical (i.e: AB1234567C12345)
|
| Brazil | CPF | Numeric. Length 11 (Validate verifier-digits) |
| Bolivia | CI | Numeric. Length: 7 |
| Bolivia | CIE | Alphanumeric. One character followed by 8 digits |
| Bolivia | PASS | Alphanumeric. One character followed by 6 digits |
| Bolivia | NIT | Numeric. Length:12 |
| Cameroon | PASS | Numeric. Length between 9 and 11 inclusive |
| Cameroon | CI | Numeric. Length between 8 and 12 inclusive |
| Cameroon | DL (Driving License) | Numeric. Length between 8 and 10 inclusive |
| Canada | DL (Driving License) | Numeric and length between 6 and 9 inclusive or string between 10 and 15 inclusive |
| Canada | HC (Health Card) | Numeric. Length 10 |
| Canada | PASS (Passport) | Length between 8 and 12 inclusive |
| Chile | ID / RUN / RUT | Length 8 or 9 |
| China | ID | Numeric. Length between 3 and 20 inclusive |
| Colombia | CC | Numeric. Length between 6 and 10 inclusive |
| Colombia | NIT | Numeric. Length between 8 and 15 |
| Colombia | CE | Numeric. Length between 6 and 10 inclusive. |
| Colombia | PASS | Length between 6 and 10 inclusive |
| Colombia | PPT | Length between 6 and 10 inclusive |
| Costa Rica | CI | Length: 9 |
| Côte d'Ivoire | ID | Length between 8 and 12 inclusive |
| Dominican Republic | CIE | Numeric. Length 11 |
| Ecuador | CC | Numeric. Length between 9 and 10 inclusive |
| Ecuador | DL | Numeric. Length 10 |
| Ecuador | RUC | Numeric. Length between 12 and 13 inclusive and ends with 001 |
| Ecuador | PASS | Alphanumeric. Length between 8 and 13 inclusive and ends with 001 |
| Egypt | ID | Length between 12 and 14 |
| El Salvador | DUI | Length between 6 and 18 inclusive |
| Ghana | ID | Length between 8 and 12 inclusive |
| Guatemala | DPI | Length between 6 and 18 inclusive |
| India | ID (PAN) | Length between 8 and 12 inclusive |
| India | DL (Driver's License) | Length between 15 and 16 inclusive |
| India | UID (Aadhar Card) | Numeric. Length 12 |
| Indonesia | NIK / KTP | Numeric. Length between 14 and 18 inclusive |
| Japan | DL / ID / PASS / RD (Resident Registration Card) | Length between 9 and 12 inclusive |
| Kenya | ID | Length between 7 and 12 inclusive |
| Malaysia | ID | Numeric. Length between 10 and 14 inclusive |
| Mexico | CURP / RFC / IFE / PASS | Length between 7 and 18 inclusive |
| Nicaragua | CI | Length between 8 and 18 inclusive |
| Nigeria | ID | Length between 9 and 12 inclusive |
| Nigeria | ID (NIN) | Numeric length 11 |
| Nigeria | PASS (Passport) | Alphanumeric length between 8 and 10 |
| Panama | CIP | Numeric. Length between 5 and 10 inclusive |
| Panama | PASS | Length between 8 and 11 inclusive |
| Paraguay | CRC / CRP / DNI / PASS / RUC | Length Between 3 and 15 characters |
| Paraguay | CIC | Length between 6 to 8 characters |
| Peru | CE/CPP | Numeric. Length 9 |
| Peru | DNI | Numeric. Length 8-9 |
| Peru | PASS | Numeric. Length 12 |
| Peru | RUC | Length 11 |
| Philippines | PSN | Numeric. Length between 9 and 13 inclusive |
| Singapore | NRIC | Length 9 |
| Singapore | PASS | Length 9 |
| South Africa | ID | Numeric. Length between 9 and 14 inclusive |
| Tanzania | ID | Length between 8 and 20 inclusive |
| Thailand | ID | Numeric. Length between 10 and 14 inclusive |
| Turkey | DL | Numeric Length between 5-8 digits |
| Turkey |
TCKK (Turkish National Identity Card (Kimlik Kartı)
| Numeric length Between 5 to 20 digits |
| Uganda | RIC / NID | Numeric. Length between 11 and 15 inclusive |
| Uruguay | CI | Numeric. Length between 6 and 8 inclusive |
| Venezuela | CI | Numeric. Length between 3 and 20 inclusive |
| Venezuela | RIF | Numeric. Length between 3 and 20 inclusive |
| Vietnam | ID | Numeric. Length between 9 and 13 inclusive |
## Postal code validations
The validation for the postal codes dependes up on the country sent. Make sure you validate them with the regex in the table below to avoid errors due to Invalid postal Code.
| Country | Regex | Example |
| ------------------ | -------------------------------------- | :-------: |
| Argentina | `^\d{4}\|[A-Za-z]\d{4}([a-zA-Z]{3})?$` | A1234ABC |
| Brazil | `^\d{5}[\s-/]?\d{3}$` | 12345-678 |
| Cameroon | N/A | N/A |
| Canada | `^[a-zA-Z]\d[a-zA-Z]\s?\d[a-zA-Z]\d$` | A1A 2B2 |
| Chile | `^\d{3}[\s-/]?\d{4}$` | 123-4567 |
| Colombia | `^\d{5,6}$` | 12345 |
| Côte d'Ivoire | N/A | N/A |
| Dominican Republic | `^\d{5}$` | 12345 |
| Ecuador | `^\d{6}$` | 123456 |
| El Salvador | N/A | N/A |
| Ghana | `^[A-Za-z]{2}\d{3,5}$` | AB1234 |
| Guatemala | N/A | N/A |
| India | `^\d{3}[\s-/]?\d{3}$` | 123-456 |
| Japan | N/A | N/A |
| Indonesia | `^\d{5}$` | 12345 |
| Kenya | `^\d{5}$` | 12345 |
| Malaysia | `^\d{5}$` | 12345 |
| Mexico | `^\d{5}$` | 12345 |
| Nicaragua | N/A | N/A |
| Nigeria | `^\d{6}$` | 123456 |
| Panama | `^\d{4,6}$` | 12345 |
| Paraguay | `^\d{4}$` | 1234 |
| Peru | `^\d{5}$` | 12345 |
| Philippines | `^\d{3,4}$` | 1234 |
| Singapore | N/A | N/A |
| South Africa | `^\d{4}$` | 2345 |
| Tanzania | `^\d{5}$` | 12345 |
| Thailand | `^\d{5}$` | 12345 |
| Uganda | N/A | N/A |
| Uruguay | `^\d{5}$` | 12345 |
| Venezuela | N/A | N/A |
| Vietnam | `^\d{5}$` | 12345 |
## Phone numbers validations
We use the Google's common library for parsing, formatting, and validating international phone numbers. Validating the phone numbers on your end could help preventing `Invalid phone number` errors.
{% embed url="" %}
## Emails validations
We suggest you using the following regex to validate email addresses on your end and prevent `invalid email` errors.
```
(?i)[a-z0-9!#$%&'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])
```
---
[Next Page](/llms-full.txt/1)
