Skip to main content

Payouts to Brazil

Payout parameters

NameTypeMandatoryDescription
payment_methodPaymentMethod+Payout data
 typestring+Value: bank_account
 bank_accountBankAccountPaymentMethod+Bank account
  system_typestring+Value: global
  globalBankAccountGlobal+Bank account details
   descriptionstring+Purpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
   bank_account_numberstring+Bank account number for the payout
   branch_numberstring+Branch number
   account_typestring+Account type. Valid values: CHECKING, SAVINGS, DEPOSIT, OTHERS
participant_detailsParticipantDetails+Information on payout participants
 recipientParticipant+Recipient details
  bank_namestring+Important: the bank name must be chosen from the List of supported banks, otherwise the payout will fail
  currencystring+Recipient's currency in ISO 4217 format. Case insensitive
  country_iso3string+Recipient's country code (ISO-3166-1 alpha-3)
  first_namestring+Recipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
  last_namestring+Recipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
  identity_documentIdentityDocument+Recipient's identity details
   id_numberstring+Recipient's identification number (CPF, 11 digits)
 senderParticipant+Sender details
  company_namestring+Sender company name. Limited to 100 characters, cannot contain digits only
  registration_numberstring+Sender company registration number
  country_iso3string+Sender’s country code (ISO-3166-1 alpha-3)
  codestring+Sender company registration number
amount_detailsAmountDetails+Payout amount details
 amountint+Payout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
 currencystring+ISO 4217 currency code. Case insensitive

Example

curl -X POST \
https://demo.smart-glocal.com/api/v1/session/start/payout \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d'{
"session_id": "ps_1053680",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "global",
"global": {
"bank_account_number": "NUMBER_VALUE",
"branch_number": "00001",
"account_type": "SAVINGS",
"description": "purpose of remittance"
}
}
},
"participant_details": {
"recipient": {
"bank_name": "Bank name from the table below",
"currency": "brl",
"country_iso3": "BRA",
"first_name": "John",
"last_name": "Johnson",
"identity_document": {
"id_number": "CPF number"
}
}
},
"sender": {
"company_name": "Company name",
"registration_number": "1234567890",
"country_iso3": "BRA",
"code": "1234567890"
},
"amount_details": {
"amount": 1000,
"currency": "usd"
}
}

List of supported banks

CountryCurrencyBank
BrazilBRLACESSO SOLUCOES PAGAMENTO SA
BrazilBRLBANCO INDUSVAL S.A.
BrazilBRLBCO C6 S.A.
BrazilBRLCOOPERATIVA CENTRAL DE CREDITO URBANO - CECRED
BrazilBRLCAIXA ECONOMICA FEDERAL
BrazilBRLUNICRED DO BRASIL
BrazilBRLBANCO ITAU S.A.
BrazilBRLBANCO MERCANTIL DO BRASIL S.A.
BrazilBRLBANCO SAFRA S.A.
BrazilBRLBANCO COOPERATIVO SICREDI S.A.
BrazilBRLBANCO COOPERATIVO DO BRASIL S.A.
BrazilBRLSTONE PAGAMENTOS S.A
BrazilBRLUNIPRIME CENTRAL
BrazilBRLCREDICOAMO CREDITO RURAL COOPERATIVA
BrazilBRLBANCO DO NORDESTE DO BRASIL S.
BrazilBRLBANCO DO BRASIL S.A
BrazilBRLBANCO BTG PACTUAL S.A.
BrazilBRLBANCO MAXIMA S.A.
BrazilBRLPARANA BANCO S.A.
BrazilBRLMERCADO PAGO
BrazilBRLAll Banks Brazil PIX
BrazilBRLBANCO DO ESTADO DO RIO GRANDE DO SUL S.A.
BrazilBRLBANCO DIGIO
BrazilBRLBANESTES S.A BANCO DO ESTADO DO ESPIRITO SANTO
BrazilBRLBRB - BANCO DE BRASILIA S.A.
BrazilBRLBANCO PANAMERICANO S.A.
BrazilBRLBANCO DO ESTADO DE SERGIPE S.A.
BrazilBRLBANCO VOTORANTIM
BrazilBRLCCC NOROESTE BRASILEIRO LTDA
BrazilBRLPAGSEGURO
BrazilBRLBANCO RENNER
BrazilBRLBANCO AGIBANK
BrazilBRLBANCO CRESOL
BrazilBRLUNICRED NORTE DO PARANA
BrazilBRLBANCO MODAL
BrazilBRLBANCO DAYCOVAL
BrazilBRLBANCO CREFISA S.A
BrazilBRLBANCO RENDIMENTO
BrazilBRLBANCO J.P. MORGAN S.A.
BrazilBRLBCO BS2
BrazilBRLBANCO CREDISAN
BrazilBRLBRASIL PLURAL S.A BANCO
BrazilBRLBPP IP S.A.
BrazilBRLSUPER PAGAMENTOS E ADMINISTRACAO DE
BrazilBRLPICPAY SERVICOS S.A.
BrazilBRLBCO CREDIT SUISSE S.A
BrazilBRLNUBANK
BrazilBRLBANCO DO ESTADO DO PARA S.A.
BrazilBRLBANCO SANTANDER BRASIL S.A
BrazilBRLBANCO SOFISA S.A.
BrazilBRLBANCO ORIGINAL S.A.
BrazilBRLBANCO INTERMEDIUM S.A.
BrazilBRLBANCO BMG S.A.
BrazilBRLBANCO ALFA S.A.