Payouts to Brazil

Payout parameters

Name	Mandatory	Type	Description
payment_method	+	object	Payout data
type	+	string	Value: bank_account
bank_account	+	object	Bank account
system_type	+	string	Value: global
global	+	object	Bank account details
description	+	string	Purpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
bank_account_number	+	string	Bank account number for the payout
branch_number	+	string	Branch number
account_type	+	string	Account type. Valid values: CHECKING, SAVINGS, DEPOSIT, OTHERS
participant_details	+	object	Information on the payout participants
recipient	+	object	Recipient details
bank_name	+	string	Important: the bank name must be chosen from the List of supported banks, otherwise the payout will fail
currency	+	string	Recipient's currency in ISO 4217 format. Case insensitive
country_iso3	+	string	Recipient's country code (ISO-3166-1 alpha-3)
first_name	+	string	Recipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
last_name	+	string	Recipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
identity_document	+	object	Recipient's identity details
id_number	+	string	Recipient's identification number (CPF, 11 digits)
sender	+	object	Sender details
company_name	+	string	Sender company name. Limited to 100 characters, cannot contain digits only
registration_number	+	string	Sender company registration number
country_iso3	+	string	Sender’s country code (ISO-3166-1 alpha-3)
code	+	string	Sender company registration number
amount_details	+	object	Payout amount details
amount	+	int	Payout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
currency	+	string	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

Country	Currency	Bank
Brazil	BRL	ACESSO SOLUCOES PAGAMENTO SA
Brazil	BRL	All Banks Brazil PIX
Brazil	BRL	BANCO AGIBANK
Brazil	BRL	BANCO ALFA S.A.
Brazil	BRL	BANCO BMG S.A.
Brazil	BRL	BANCO BRADESCO S.A.
Brazil	BRL	BANCO BTG PACTUAL S.A.
Brazil	BRL	BANCO C6 S.A.
Brazil	BRL	BANCO COOPERATIVO DO BRASIL S.A.
Brazil	BRL	BANCO COOPERATIVO SICREDI S.A.
Brazil	BRL	BANCO CREDISAN
Brazil	BRL	BANCO CREFISA S.A
Brazil	BRL	BANCO CRESOL
Brazil	BRL	BANCO DAYCOVAL
Brazil	BRL	BANCO DIGIO
Brazil	BRL	BANCO DO BRASIL S.A
Brazil	BRL	BANCO DO ESTADO DE SERGIPE S.A.
Brazil	BRL	BANCO DO ESTADO DO PARA S.A.
Brazil	BRL	BANCO DO ESTADO DO RIO GRANDE DO SUL S.A.
Brazil	BRL	BANCO DO NORDESTE DO BRASIL S.
Brazil	BRL	BANCO INDUSVAL S.A.
Brazil	BRL	BANCO INTERMEDIUM S.A.
Brazil	BRL	BANCO ITAU S.A.
Brazil	BRL	BANCO J.P. MORGAN S.A.
Brazil	BRL	BANCO MAXIMA S.A.
Brazil	BRL	BANCO MERCANTIL DO BRASIL S.A.
Brazil	BRL	BANCO MODAL
Brazil	BRL	BANCO ORIGINAL S.A.
Brazil	BRL	BANCO PANAMERICANO S.A.
Brazil	BRL	BANCO RENDIMENTO
Brazil	BRL	BANCO RENNER
Brazil	BRL	BANCO SAFRA S.A.
Brazil	BRL	BANCO SANTANDER BRASIL S.A
Brazil	BRL	BANCO SOFISA S.A.
Brazil	BRL	BANCO VOTORANTIM
Brazil	BRL	BANESTES S.A BANCO DO ESTADO DO ESPIRITO SANTO
Brazil	BRL	BCO BS2
Brazil	BRL	BCO CREDIT SUISSE S.A
Brazil	BRL	BPP IP S.A.
Brazil	BRL	BRASIL PLURAL S.A BANCO
Brazil	BRL	BRB - BANCO DE BRASILIA S.A.
Brazil	BRL	CAIXA ECONOMICA FEDERAL
Brazil	BRL	CCC NOROESTE BRASILEIRO LTDA
Brazil	BRL	COOPERATIVA CENTRAL DE CREDITO URBANO - CECRED
Brazil	BRL	CREDICOAMO CREDITO RURAL COOPERATIVA
Brazil	BRL	MERCADO PAGO
Brazil	BRL	NUBANK
Brazil	BRL	PAGSEGURO
Brazil	BRL	PARANA BANCO S.A.
Brazil	BRL	PICPAY SERVICOS S.A.
Brazil	BRL	STONE PAGAMENTOS S.A
Brazil	BRL	SUPER PAGAMENTOS E ADMINISTRACAO DE MEIOS ELETRONICOS S.A.
Brazil	BRL	UNICRED DO BRASIL
Brazil	BRL	UNICRED NORTE DO PARANA
Brazil	BRL	UNIPRIME CENTRAL