Mandatory parameters

Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
document_idSee document validations below.
document_typeOnly mandatory when document type is RUT, DE (Documento Extranjero) or PASS (Passport)
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryUY
bank_codeSee bank codes below.
bank_branchMandatory only If the bank is Santander.
bank_accountSee bank account validations below.
account_typeOnly mandatory if bank_code is BROU
C: for Checking accounts
S: for Savings accounts
amountMax. 2 decimal numbers
currency_to_payUSD
Mandatory only if the payout needs to be paid in USD.

In case this parameter is missing, the payout will be paid in local currency.

Example request

{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678b",
"document_id":"12345678",
"country":"UY",
"bank_branch":"11",
"bank_account":"1234567",
"account_type":"C",
"currency":"UYU",
"amount":"114848.39",
"type":"json",
"notification_url":"",
"bank_name":"Banco Itau00fa",
"bank_code":"113",
"comments":"this is the 1st comment",
"on_hold":"1",
"beneficiary_name":"HOY",
"beneficiary_lastname":"SA",
"address":"Rbla. Rep. de chile 1119, Montevideo",
"city":"",
"postal_code":"",
"email":"[email protected]",
"bdate":"",
"extra_info":"{this_is_extra:2334}",
"bank_province":"",
"bank_city":"",
"bank_branch_name":"",
"document_type":"RUT",
"purpose":"",
}

Document validations

ValidationNameLengthTypeVerification digitExample
DocumentCI8NumericLast digit8.741.777-1
87417771
DocumentRUT12NumericLast digit21-100342-001-7
211003420017
DocumentDE-Numeric-33475876
DocumentPASS-Alphanumeric-NNFE4379

Bank account validations

NameAccount formatLengthDetailsExample
BROUYYYYYYYYYWWWWW14Y-> account num.
W->sub account
00099299700002
BHUXXXYYZZZZZZV10X-> Bank branch, starts with 0
Y-> Product num.
Z-> Account num. filling with 0 on the left
V-> Verif. Digit
012345678901
CitibankXXXXXXXXXX10Filling with 0 on the left Account num. start with 0, 1 or 50061436006
ItauXXXXXXX7Filling with 0 on the left3190373
ScotiabankCCCCCCCCII10C-> Client num. filling with 0 on the left
I-> Account id
1274204300
ScotiabankXXXXXXX7Account num filling with 0 on the left0123456
SantanderXXXXXXXXXXXX12Account num filling with 0 on the left012345678901
NacionXXXXXXXXXXXX12Account num. filling with 0 on the left001234568901
BBVAXXXXXXXXXmax 9Account num. without filling with 0 on the left Only numeric digits20237345 674501433
HSBCXXXXXXXXXX10Filling with 0 to the left0003237999
HeritageXXXXXXXYY9X-> Account num. filling with 0 on the left
Y-> Sub Account num.
0003237999

Bank codes

Check below the different values that bank_code parameter can take depending on each country's bank requirements.

Bank CodeBank NameSupport UYU currencySupport USD currency
153Banco Bilbao Vizcaya Argentaria
246Banco de la Nación Argentina
091Banco Hipotecario del Uruguay
113Banco ITAU
137Banco Santander
162Banque Heritage
61BAPRO
001BROU - Banco de la República Oriental del Uruguay
205Citibank N.A. Sucursal
157HSBC Bank
999Oca Blue
603Prex
624Redpagos
917Midinero
128Scotiabank