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
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*
string
Beneficiary's name - Length between 5 and 100 -
When
document_id = CPFThenamefield only supports English alphabet characters (A–Z,a–z) and spaces.When
document_id = CNPJThenamefield supports:English alphabet characters (
A–Z,a–z)Numbers (
0–9)Dot (
.)Hyphen (
-)Spaces
phone
string
Beneficiary's phone
- Max 15, valid phone -
string
Beneficiary's email - Max 64, valid email -
document_id*
string
Beneficiary's personal identification number.
branch*
string
Bank Branch Code
- 4 digits -
account*
string
Beneficiary's Bank Account
- 1 ~ 20 digits -
account_type*
string
Beneficiary's Account Type
- One of: SAVINGS, PAYMENT, CURRENT, SALARY -
Use CURRENT for checking/current accounts, SAVINGS for savings accounts, PAYMENT for digital bank or payment wallet accounts, and SALARY for salary accounts.
For backward compatibility, CHECKING is also accepted for existing integrations. For new integrations, use CURRENT instead of 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
All fees charge to merchant or beneficiary - One of: merchant, beneficiary -
amount*
number
Payout Amount, 2 decimal numbers
- Min 0.01, Max 15,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) -
Example
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
CPF
22*******99
11 digits
CNPJ
23**********31
14 digits
Example of Brazil Bank Account
X --> Numeric character
D --> Alphanumeric character
00000000
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
90400888
Banco Santander Brasil S.A.
XXXX
XXXXXXXX-X Prefixes: 01, 02, 03, 05, 09, 13 or 92
XXXXXXXX-X Prefixes: 60
00360305
CAIXA ECONOMICA FEDERAL
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
60746948
Banco Bradesco S.A.
XXXX, XXXXX or XXXX-X
XXXXXXX or XXXXXXX-X
XXXXXXX or XXXXXXX-X
60701190
Itau Unibanco S.A.
XXXX
XXXXX-X
XXXXX-X
53518684
BCO HSBC 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
JavaScript: https://www.npmjs.com/package/cpf-cnpj-validator
Last updated