BankTransfer

How to use Bank Transfer to submit a payout in Brazil.

Submit a payout by Bank Transfer in Brazil

POST https://sandbox.transfersmile.com/api/payout

This endpoint allows you to submit a payout by Bank Transfer in Brazil.

Headers

Name
Type
Description

Content-Type*

string

application/json; charset=UTF-8

AppId*

string

Your App ID in payout platform.

Authorization*

string

SHA256($sorted_params + $app_key)

Request Body

Name
Type
Description

name*

string

Beneficiary's name - Length must between 5 and 100 -

phone

string

Beneficiary's phone

- 0 ~ 15 digits -

email

string

Beneficiary's email

document_id*

string

Beneficiary's personal identification number.

bank_code*

string

branch*

string

Bank Branch Code

- 4 digits -

account*

string

Beneficiary's Bank Account

- 4 ~ 18 digits -

account_type*

string

Beneficiary's Account Type - One of: SAVINGS, CHECKING -

account_digit

string

Account Digit

- 1 or 2 digits. Left empty if the account_digit is included in the account field -

branch_digit

string

Branch digit

method*

string

Fixed value: BANKTRANSFER

custom_code*

string

Merchant Payout ID - Max. 50 chars -

fee_bear*

string

Processing fee charges to merchant or beneficiary - One of: merchant, beneficiary -

amount*

number

Payout Amount, 2 decimal numbers

- Min 1, Max 50,000 -

source_currency*

string

Merchant Account Currency - One of: USD, EUR, GBP, BRL -

arrival_currency*

string

Fixed value: BRL

notify_url*

string

Where pagsmile will send notification to.

additional_remark*

string

Descriptor on the user's bank bill - Max. 40 chars -

country*

string

BRA for Brazil

document_type*

string

Beneficiary's personal identification type

- One of: CPF, CNPJ -

amount_type

string

Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQM",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "0.51",
        "arrival_currency": "BRL",
        "source_amount": "0.07",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}

Example

curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "name" : "GUILHERME ****** SOUZA",
      "phone": "",
      "email": "payout@pagsmile.com",
    * "bank_code": "001",
    * "account_type": "CHECKING", // should be one of SAVINGS, CHECKING
    * "account": "6***84", // "4" is the account digit
      "account_digit": "",
    * "branch": "0**8",
    * "document_id": "12*******91",
    * "document_type": "CPF",  // should be one of CPF, CNPJ
    * "source_currency": "BRL", 
    * "arrival_currency": "BRL", // fixed value: BRL
    * "fee_bear": "merchant", // should be one of merchant, beneficiary
    * "method": "BANKTRANSFER", // fixed value: BANKTRANSFER
    * "amount": "1.80",
    * "notify_url": "https://notify.url",
    * "custom_code" : "custom_code9982674851738108",
    * "additional_remark": "pagsmile payout test remark",
    * "country": "BRA"  // fixed value: BRA
}
'

Note: 94FAC*********************68548 is Pagsmile's test App ID for sandbox, and d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 is authorization token associated with the test App ID.

Example of Document

Document Type
Document ID
Descritpion

CPF

22*******99

11 digits

CNPJ

23**********31

14 digits

Example of Brazil Bank Account

  • X --> Numeric character

  • D --> Alphanumeric character

Bank code
Bank name
Bank branch
Checking account
Savings account

001

Banco do Brasil S.A.

XXXX, XXXXD or XXXX-D

XXXXXXXX or XXXXXXXX-X

XXXXXXXXX or XXXXXXXXX-X Prefixes: 00, 01, 51, 02, 52, 91, 92, 96 or 97

033

Banco Santander Brasil S.A.

XXXX

XXXXXXXX-X Prefixes: 01, 02, 03, 05, 09, 13 or 92

XXXXXXXX-X Prefixes: 60

104

Caixa CEF

XXXX, XXXXX or XXXX-X

XXX.XXXXXXXX-X or any combination with or without ',' or '-' characters and prefix or verification code Prefixes: 001, 010, 003 or 023

XXXX.XXXXXXXXX-X //XXX.XXXXXXXX-X or any combination with or without ',' or '-' characters and prefix or verification code Prefixes: 1288 or 013, 022

237

Banco Bradesco S.A.

XXXX, XXXXX or XXXX-X

XXXXXXX or XXXXXXX-X

XXXXXXX or XXXXXXX-X

341

Itau Unibanco S.A.

XXXX

XXXXX-X

XXXXX-X

399

HSBC Bank Brasil S.A.

XXXX, XXXXD, XXXXDD, XXXX-D or XXXX-DD

XXXXX-XX

XXXXX-XX

-

Other banks

XXXX, XXXXD, XXXXDD, XXXX-D or XXXX-DD

-

-

"account_digit" is optional. If the user fills full account number in the "account" field, the "account_digit" field should be removed or left empty. For example, if the complete account number is 1234-5, then the request can be

"account": "12345"

or

"account": "1234",

"account_digit": "5"

Third-party CPF/CNPJ Validator

PreviousPixNextChile

Last updated