Payout Parameters

Country and Currency Codes

Here are all of the currency and country codes that can be used in your payout request. They must match each other for your payout to work. For example, attempting to process a payout with country "BR" and currency "MXN" will return the following error: {0}_PAYOUT_PSP_CURRENCY_NOT_ALLOWED.

Our system also allows you to process payouts in USD in all countries, you will only need to keep in mind a few things:

• You will need to send "CurrencyCode": "USD"in the request
• You will need to add the paramenter "TermsApproved": trueto the request
• In the webhook, the currency code will indicate the local currency
• The amount parameter of the webhook will indicate the amount paid to the customer in their local currency
• The settlementAmount paramenter of the webhook will indicate the amount charged upon settlement to you

Argentina

Payouts can be processed by informing only the customer's CBU or CVU, apart from the customer's details. For that reason, there are a few differences to bear in mind when creating payouts for Argentina.

Document Type

Bank Name and Payout Account Type Code

The BankName and PayoutAccountTypeCode parameters required to send the request for your payout to be successfully processed but the value must be a hyphen "-".
"BankName": "-", "PayoutAccountTypeCode": "-"

Account Number

The value expected in this field is the customer's CBU (Clave Bancaria Uniforme) , or CVU(Clave virtual uniforme), not the client’s account number.

Brazil

Document Type

Account Type

Bank Name

📘

The list below contains the most used banks in Brazil. However, all Brazil bank codes are supported by our system. You can visit conta-corrente.com to see the full list of banks available in Brazil with their associated code.

Account Number

Account number with verification digit ''X'' it must be replaced by a ''0''. Example: 1234X should be 12340.

Account Agency Number

🚧

Only use the numbers before the hyphen as value. (ex: For the Account Agency Number "1234-5" the value would be 1234).

Recipient Pix Key

Payretailers offers the possibility to process payouts in Brazil via PIX. This implies using additional parameters when creating the payout. You must put the PIX key of your user as value of RecipientPixKey. The value will vary depending on the customer's PIX key, which can be:

Using PIX only

Payretailers system is designed to use the bank details of the customer as backup in case of a failure when using PIX to process the payout. As of now, the fields bankName, accountNumber, payoutAccountTypeCode and accountAgencyNumber are still required when creating a PIX payout. However, these fields do not have to contain real details when sent for the PIX payout to be processed.

You can process PIX Payouts without adding the customer's bank details in the request. For this, please put a hyphen as value of those fields, like shown in the following example:

{
	"beneficiaryFirstName": "test",
	"beneficiaryLastName": "test",
	"documentType": "1",
	"documentNumber": "79052703515",
	"email": "[email protected]",
	"city": "test",
	"amount": 10.00,
	"currencyCode": "BRL",
	"country": "BR",
	"bankName": "-",
	"accountAgencyNumber": "-",
	"accountNumber": "-",
	"payoutAccountTypeCode": "-",
	"externalReference": "test",
	"NotificationUrl": "",
	"PaymentReason": "test",
	"recipientPixKey": "[email protected]",
	"testMode": true
}

Chile

Document Type

Account Type

Beneficiary Type

Bank Name

Mexico

Document Type

Account Type

Bank Name

***** Only available via API request.

Colombia

Document Type

Account Type

Bank Name

Ecuador

Document Type

Account Type

Bank Name

Account Number Requirements

Peru

Document Type

¹The verification number after the dash must not be sent.

Account Type

Bank Name

Account Number Requirements