Payment methods
PagaSul supports, continually develops, and adds new payment methods to enable payment processing by using multiple payment instruments and currencies in different countries.
Supported payment methods
| Payment method | Code | Type | Country | Currency | Operations |
|---|---|---|---|---|---|
| Bank transfers in Argentina | AR.BT | Bank transfers | Argentina | ARS | Pay-in, Pay-out |
| Pix | BR.PIX | Bank transfers | Brazil | BRL | Pay-in, Pay-out |
| Bank transfers in Colombia | CO.BT | Bank transfers | Colombia | COP | Pay-in, Pay-out |
| Nequi | CO.NEQUI | E-wallet | Colombia | COP | Pay-in |
| PSE | CO.PSE | Bank transfers | Colombia | COP | Pay-in |
For more details about processing payments with these payment methods, see the information below.
Pix
| Payment method logo | |
| Payment method type | Bank transfers |
| Country | Brazil |
| Currency | BRL |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the PIX payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the PIX payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass BR.PIX in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.email | string | Required* | Customer's email. |
payer.cpf | string | Required* | Customer's CPF (Cadastro de Pessoas Físicas). Can be passed in the following formats: 231.002.999-00, 23100299900 |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
Pay-out request
To initiate a pay-out with the PIX payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the PIX payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Strictly required | Payment method's code. Pass BR.PIX. |
payee_account | object | ||
payee_account.pix_key | string | Strictly required | Customer's key for the Pix account. It may be the cusomer's CPF, CNPJ, email, phone, or EVP. |
payee_account.pix_key_type | string | Strictly required | Type of the customer's Pix key. Possible values: CPF, CNPJ, EMAIL, PHONE, EVP. |
Argentina QR
| Payment method logo | |
| Payment method type | QR |
| Country | Argentina |
| Currency | ARS |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Argentina QR payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Argentina payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass AR.QR in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.cuit | string | Required* | Customer's CUIT (Clave Única de Identificación Tributaria). Can be passed in the following formats: 30-69330706-2, 30693307062 |
*The parameter may be sometimes required for purchase processing. If it is required and you haven't passed it in the request, the customer will have to enter the information themselves on the checkout page. Reach out to your key account manager at PagaSul to find out whether it is required in your case.
For host2host flow: deeplink from "payment_data.qr_data" should be used to generate QR code. It is also recommended to create a button under QR with a link for a better conversion.
Bank transfers in Argentina
| Payment method logo | |
| Payment method type | Bank transfers |
| Country | Argentina |
| Currency | ARS |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Bank transfers in Argentina payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Argentina payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass AR.BT in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.cuit | string | Required* | Customer's CUIT (Clave Única de Identificación Tributaria). Can be passed in the following formats: 30-69330706-2, 30693307062 |
*The parameter may be sometimes required for purchase processing. If it is required and you haven't passed it in the request, the customer will have to enter the information themselves on the checkout page. Reach out to your key account manager at PagaSul to find out whether it is required in your case.
Pay-out request
To initiate a pay-out with the Bank transfers in Argentina payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the Bank transfers in Argentina payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Strictly required | Payment method's code. Pass AR.BT. |
payee | object | ||
payee.id | string | Strictly required | A unique identifier for a customer or customer account on your side. It is used to accumulate customer data and for anti-fraud protection. |
payee.name | string | Strictly required | Customer's name. |
payer.cuit | string | Strictly required | Customer's CUIT (Clave Única de Identificación Tributaria). |
payee_account | object | ||
payee_account.number | string | Strictly required | Customer's bank account number. |
payee_account.holder_name | string | Strictly required | Bank account's holder name. |
Bank transfers in Colombia
| Payment method logo | |
| Payment method type | Bank transfers |
| Country | Colombia |
| Currency | COP |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Bank transfers in Colombia payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Colombia payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass CO.BT in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.email | string | Required* | Customer's email. |
payer.phone | string | Required* | Customer's phone number. |
payer.nit | string | Required* | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ce. |
payer.citizenship_card | string | Required* | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.nit parameter in it, or payer.ce. |
payer.ce | string | Required* | Customer's Identity card of Foreigners(Cédula de Extranjería). The request must contain either this parameter or the payer.nit parameter in it, or payer.citizenship_card. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
Pay-out request
To initiate a pay-out with the Bank transfers in Colombia payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the Bank transfers in Colombia payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Strictly required | Payment method's code. Pass CO.BT. |
payee | object | ||
payee.id | string | Strictly required | A unique identifier for a customer or customer account on your side. It is used to accumulate customer data and for anti-fraud protection. |
payee.name | string | Strictly required | Customer's name. |
payee.phone | string | Strictly required | Customer's phone. |
payee.email | string | Strictly required | Customer's email |
payee.nit | string | Strictly required | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ce. |
payee.citizenship_card | string | Strictly required | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.nit parameter in it, or payer.ce. |
payee.ce | string | Strictly required | Customer's Identity card of Foreigners(Cédula de Extranjería). The request must contain either this parameter or the payer.nit parameter in it, or payer.citizenship_card. |
payee_account | object | ||
payee_account.number | string | Strictly required | Customer's bank account number. |
payee_account.account_type | string | Strictly required | Customer's bank account type. Possible values: CACC—for the current account, SVGS—for the savings account. |
payee_account.bank_code | string | Strictly required | Customer's bank code. For the values that can be passed in this parameter, see the Bank list section. |
Nequi
| Payment method logo | |
| Payment method type | E-wallet |
| Country | Colombia |
| Currency | COP |
| Pay-in min and max amount | — |
Pay-in request
To initiate a pay-in with the Nequi payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Nequi payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass CO.NEQUI in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.email | string | Required* | Customer's email. |
payer.phone | string | Required* | Customer's phone number. |
payer.nit | string | Required* | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ce. |
payer.citizenship_card | string | Required* | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.nit parameter in it, or payer.ce. |
payer.ce | string | Required* | Customer's Identity card of Foreigners(Cédula de Extranjería). The request must contain either this parameter or the payer.nit parameter in it, or payer.citizenship_card. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
PSE
| Payment method logo | |
| Payment method type | Bank transfers |
| Country | Colombia |
| Currency | COP |
| Pay-in min and max amount | — |
Pay-in request
To initiate a pay-in with the PSE payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the PSE payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass CO.PSE in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.email | string | Required* | Customer's email. |
payer.phone | string | Required* | Customer's phone number. |
payer.nit | string | Required* | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ce. |
payer.citizenship_card | string | Required* | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.nit parameter in it, or payer.ce. |
payer.ce | string | Required* | Customer's Identity card of Foreigners(Cédula de Extranjería). The request must contain either this parameter or the payer.nit parameter in it, or payer.citizenship_card. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
Transfia
| Payment method logo | |
| Payment method type | Transfia |
| Country | Colombia |
| Currency | COP |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
To initiate a pay-out with the Transfia payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the PIX payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass CO.TF in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.email | string | Required* | Customer's email. |
payer.phone | string | Required* | Customer's phone number. |
payer.nit | string | Required* | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ce. |
payer.citizenship_card | string | Required* | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.nit parameter in it, or payer.ce. |
payer.ce | string | Required* | Customer's Identity card of Foreigners(Cédula de Extranjería). The request must contain either this parameter or the payer.nit parameter in it, or payer.citizenship_card. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
Bre-B
| Payment method logo | |
| Payment method type | Bre-B |
| Country | Colombia |
| Currency | COP |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Bre-B payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Colombia payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass CO.BREB in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.email | string | Required* | Customer's email. |
payer.phone | string | Required* | Customer's phone number. |
payer.nit | string | Required* | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ce. |
payer.citizenship_card | string | Required* | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.nit parameter in it, or payer.ce. |
payer.ce | string | Required* | Customer's Identity card of Foreigners(Cédula de Extranjería). The request must contain either this parameter or the payer.nit parameter in it, or payer.citizenship_card. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
Pay-out request
To initiate a pay-out with the Bank transfers in Colombia payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the Bank transfers in Colombia payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payee | object | ||
payee.id | string | Strictly required | A unique identifier for a customer or customer account on your side. It is used to accumulate customer data and for anti-fraud protection. |
payee.name | string | Strictly required | Customer's name. |
payee.phone | string | Strictly required | Customer's phone. |
payee.email | string | Strictly required | Customer's email |
payee.nit | string | Strictly required | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ce. |
payee.citizenship_card | string | Strictly required | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.nit parameter in it, or payer.ce. |
payee.ce | string | Strictly required | Customer's Identity card of Foreigners(Cédula de Extranjería). The request must contain either this parameter or the payer.nit parameter in it, or payer.citizenship_card. |
payee_account | object | ||
payee_account.breb_key | string | Strictly required | Key for Bre-b account one of the following: E-mail, Phone,ID (Cédula), Alpha-Numeric Code (user-generated alias). |
Bank transfers in Bolivia
| Payment method logo | |
| Payment method type | Bank transfers |
| Country | Bolivia |
| Currency | BOB |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-out request
To initiate a pay-out with the Bank transfers in Bolivia payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the Bank transfers in Colombia payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Strictly required | Payment method's code. Pass BO.BT. |
payee | object | ||
payee.id | string | Strictly required | A unique identifier for a customer or customer account on your side. It is used to accumulate customer data and for anti-fraud protection. |
payee.name | string | Strictly required | Customer's name. |
payee.phone | string | Strictly required | Customer's phone. |
payee.email | string | Strictly required | Customer's email |
payee.nit | string | Strictly required | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.pas parameter in it, or payer.ci. |
payee.pas | string | Strictly required | Customer's Passport. The request must contain either this parameter or the payer.nit parameter in it, or payer.ci. |
payee.ci | string | Strictly required | Customer's Identity document(Cédula de Identidad). The request must contain either this parameter or the payer.nit parameter in it, or payer.pas. |
payee_account | object | ||
payee_account.number | string | Strictly required | Customer's bank account number. |
payee_account.account_type | string | Strictly required | Customer's bank account type. Possible values: CACC—for the current account, SVGS—for the savings account. |
payee_account.bank_code | string | Strictly required | Customer's bank code. For the values that can be passed in this parameter, see the Bank list section. |
Bolivia QR
| Payment method logo | |
| Payment method type | QR |
| Country | Bolivia |
| Currency | BOB |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Bolivia QR payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Argentina payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass BO.QR in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.email | string | Required* | Customer's email. |
payer.phone | string | Required* | Customer's phone number. |
payer.name | string | Required* | Customer's full name. |
payer.cuit | string | Required* | Customer's CUIT (Clave Única de Identificación Tributaria). Can be passed in the following formats: 30-69330706-2, 30693307062 |
payer.nit | string | Required* | Customer's NIT (Número de Identificación Tributaria). The request must contain either this parameter or the payer.pas parameter in it, or payer.ci. |
payer.pas | string | Required* | Customer's Passport. The request must contain either this parameter or the payer.nit parameter in it, or payer.ci. |
payer.ci | string | Required* | Customer's Identity document(Cédula de Identidad). The request must contain either this parameter or the payer.nit parameter in it, or payer.pas. |
*The parameter may be sometimes required for purchase processing. If it is required and you haven't passed it in the request, the customer will have to enter the information themselves on the checkout page. Reach out to your key account manager at PagaSul to find out whether it is required in your case.
Bank transfers in Ecuador
| Payment method logo | |
| Payment method type | Bank transfers |
| Country | Ecuador |
| Currency | USD |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Bank transfers in Ecuador payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Colombia payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass EC.ECin this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.email | string | Required* | Customer's email. |
payer.phone | string | Required* | Customer's phone number. |
payer.pas | string | Required* | Customer's Passport. The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ruc. |
payer.citizenship_card | string | Required* | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.pas parameter in it, or payer.ruc. |
payer.ruc | string | Required* | Customer's Taxpayer number (Registro Único de Contribuyente). The request must contain either this parameter or the payer.pas parameter in it, or payer.ruc. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
Pay-out request
To initiate a pay-out with the Bank transfers in Colombia payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the Bank transfers in Colombia payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Strictly required | Payment method's code. Pass EC.BT. |
payee | object | ||
payee.id | string | Strictly required | A unique identifier for a customer or customer account on your side. It is used to accumulate customer data and for anti-fraud protection. |
payee.name | string | Strictly required | Customer's name. |
payee.phone | string | Strictly required | Customer's phone. |
payee.email | string | Strictly required | Customer's email |
payer.pas | string | Strictly required | Customer's Passport. The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ruc. |
payer.citizenship_card | string | Strictly required | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.pas parameter in it, or payer.ruc. |
payer.ruc | string | Strictly required | Customer's Taxpayer number (Registro Único de Contribuyente). The request must contain either this parameter or the payer.pas parameter in it, or payer.ruc. |
payee_account | object | ||
payee_account.number | string | Strictly required | Customer's bank account number. |
payee_account.account_type | string | Strictly required | Customer's bank account type. Possible values: CACC—for the current account, SVGS—for the savings account. |
payee_account.bank_code | string | Strictly required | Customer's bank code. For the values that can be passed in this parameter, see the Bank list section. |
Cash in Ecuador
| Payment method logo | |
| Payment method type | Cash |
| Country | Ecuador |
| Currency | USD |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Bank transfers in Ecuador payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Colombia payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass EC.CASHin this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.email | string | Required* | Customer's email. |
payer.phone | string | Required* | Customer's phone number. |
payer.pas | string | Required* | Customer's Passport. The request must contain either this parameter or the payer.citizenship_card parameter in it, or payer.ruc. |
payer.citizenship_card | string | Required* | Customer's citizenship card (Cédula de Ciudadanía). The request must contain either this parameter or the payer.pas parameter in it, or payer.ruc. |
payer.ruc | string | Required* | Customer's Taxpayer number (Registro Único de Contribuyente). The request must contain either this parameter or the payer.pas parameter in it, or payer.ruc. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
Bank transfers in Venezuela
| Payment method logo | |
| Payment method type | Bank transfers |
| Country | Venezuela |
| Currency | VES |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Bank transfers in Venezuela payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Colombia payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass VE.BT in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.phone | string | Required* | Customer's phone number. |
payer.ci | string | Required* | Customer's Identity document(Cédula de Identidad). The request must contain either this parameter or the payer.nit parameter in it, or payer.pas. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
For host2host flow: Use receiver_account from payment.data to display it on your checkout page for payment. Also you need to display a field for the user to enter the UTR number on your checkout page. After you receive it from the user, send the UTR number in "Confirm payment" request.
Pay-out request
To initiate a pay-out with the Bank transfers in Colombia payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the Bank transfers in Colombia payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Strictly required | Payment method's code. Pass CO.BT. |
payee | object | ||
payee.id | string | Strictly required | A unique identifier for a customer or customer account on your side. It is used to accumulate customer data and for anti-fraud protection. |
payee.phone | string | Strictly required | Customer's phone. |
payee.ci | string | Strictly required | Customer's Identity document(Cédula de Identidad). The request must contain either this parameter or the payer.rif parameter in it. |
payee.rif | string | Strictly required | Customer's Tax number (Registro de Información Fiscal). The request must contain either this parameter or the payer.ci parameter in it. |
payee_account | object | ||
payee_account.number | string | Strictly required | Customer's bank account number. |
payee_account.holder_name | string | Strictly required | Bank account's holder name. |
payee_account.bank_code | string | Strictly required | Customer's bank code. For the values that can be passed in this parameter, see the Bank list section. |
Pago Movil in Venezuela
| Payment method logo | |
| Payment method type | Pago Movil |
| Country | Venezuela |
| Currency | VES |
| Pay-in min and max amount | — |
| Pay-out min and max amount | — |
Pay-in request
To initiate a pay-in with the Bank transfers in Venezuela payment method, send the PagaSul payment platform a request. For the parameters required in a pay-in request, see the Create pay-in section.
Apart from the strictly required parameters, you can also add the following parameteres to the request for the pay-in processing with the Bank transfers in Colombia payment method:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Optional | Payment method's code. Pass VE.BT in this parameter to enforce this payment method for your customer on the checkout. If not passed, the customer will have to choose a payment method on the checkout themselves. |
payer | object | ||
payer.name | string | Required* | Customer's full name. |
payer.phone | string | Required* | Customer's phone number. |
payer.ci | string | Required* | Customer's Identity document(Cédula de Identidad). The request must contain either this parameter or the payer.nit parameter in it, or payer.pas. |
*The parameter is required for purchase processing but using it in the request is optional. If you don't add this parameter to your request, the customer will have to enter the information themselves on the checkout page.
For host2host flow: Use receiver_account from payment.data to display it on your checkout page for payment. Also you need to display a field for the user to enter the UTR number on your checkout page. After you receive it from the user, send the UTR number in "Confirm payment" request.
Pay-out request
To initiate a pay-out with the Bank transfers in Colombia payment method, send the PagaSul payment platform a request. For the parameters required in a pay-out request, see the Create pay-out section.
Apart from the parameters that are strictly required in any pay-out request, the request for a payout with the Bank transfers in Colombia payment method has to also contain the following parameters:
| Object/Parameter | Type | Required | Description |
|---|---|---|---|
payment_method | string | Strictly required | Payment method's code. Pass CO.BT. |
payee | object | ||
payee.id | string | Strictly required | A unique identifier for a customer or customer account on your side. It is used to accumulate customer data and for anti-fraud protection. |
payee.ci | string | Strictly required | Customer's Identity document(Cédula de Identidad). The request must contain either this parameter or the payer.rif parameter in it. |
payee.rif | string | Strictly required | Customer's Tax number (Registro de Información Fiscal). The request must contain either this parameter or the payer.ci parameter in it. |
payee_account | object | ||
payee_account.number | string | Strictly required | Customer's bank account number. |
payee_account.bank_code | string | Strictly required | Customer's bank code. For the values that can be passed in this parameter, see the Bank list section. |