Brazil
Example PayOut Request and Response
Last updated
Example PayOut Request and Response
Last updated
POST https://api.stage.localpayment.com /api/payout
Create a payout order
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
Payouts from Brazil can be made using the complete bank account details or using a Chave PIX.
Pix is an instant payment method, it was launched by the Central Bank of Brazil in 2020 and is gradually gaining more members.
Through Pix you can make payments and transfers at any time of the day, including holidays and weekends.
In order for payments and transfers to take place, users must have a registered Pix key.
A Pix key can be divided into four types:
CPF
CNPJ
Cellphone number
Random key
The random key is a unique code generated by the Central Bank, containing 32 characters with letters and symbols and linked to a single account. It is a way to receive Pix without providing any personal data..
The Pix key must be passed in the bank.account.alias property of the beneficiary and as indicated above must be a valid key.
To make a payment with:
Authorization *
String
JWT token in format Bearer eyJ0... For more information about authentication, please refer to Authentication
externalId*
String
An ID that is meaningful to you and your system. Must be unique.
country*
String
Your end user's country (i.e. country in which the payment will be processed), in ISO format. Please refer to Country Codes for a full list of supported countries.
currency*
String
The currency in which the amount is expressed. It could be A) the local currency of the selected country or B) the account's currency. If A), the amount will be charged to the customer's cash payment method. If B) and it differs from the local currency, the amount specified will be credited to your account and Localpayment will perform a Foreign Exchange operation to collect the amount expressed in local currency. In bimonetary countries, paymentMethod.code resolves possible ambiguity: the payment will be executed in the currency of that specific payment method network. e.i.: SPID (USD); SPEI (MXN)
amount*
Number
For BRL transactions, the amount must be specified with 2 decimal places, separated by a dot.
paymentMethod*
Object
Party Object
paymentMethod.type*
String
Value "BankTransfer"
paymentMethod.code*
String
Select among the codes available in each country for a payout BankTransfer payment type. NOTE: payment method code might affect the collection currency in bimonetary countries. For more info, see the side note on currency field.
paymentMethod.flow*
String
The payment method data could be embeded in the API request (DIRECT)or collected via an aditional form or plugin (REDIRECT). Currently, only DIRECT flow is allowed.
beneficiary*
Object
Party Object
beneficiary.type*
String
Possible values: "COMPANY" or "INDIVIDUAL"
beneficiary.name*
String
Individual / company name
beneficiary.lastName*
String
Only for INDIVIDUAL type / Ignored for COMPANY.
beneficiary.document *
Object
Party Object
beneficiary.document.type*
String
Document type (related to the beneficiary's residence).
**Only optional for Mexico and Bolivia countries
beneficiary.document.id*
String
Identity document id. Usually numbers or combination of numbers and letters (related to the beneficiary's residence).
beneficiary.userReference
String
Username or id in your platform.
beneficiary.email
String
Beneficiary's email address.
beneficiary.phone
Object
Party Object
beneficiary.phone.countryCode
String
Country code of the beneficiary's telephone number.
beneficiary.phone.areaCo
String
Area code of the beneficiary's telephone number
beneficiary.phone.number
String
Beneficiary's phone number
beneficiary.birthdate
String
Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).
beneficiary.nationality
String
Beneficiary's nationality
beneficiary.address
Object
Party Object
beneficiary.address.street
String
Beneficiary's street address
beneficiary.address.number
String
Beneficiary's number address
beneficiary.address.city
String
Beneficiary's city of residence
beneficiary.address.state
String
Beneficiary's state of residence
beneficiary.address.country
String
Beneficiary's country of residence
beneficiary.address.zipCode
String
Beneficiary's Zip code / Postal code of residence.
beneficiary.address.comment
String
Additional info, such as floor or apartment number.
beneficiary.bank*
Object
Party Object
beneficiary.bank.name
String
Account holder full name
beneficiary.bank.code*
String
beneficiary.bank.account*
Object
Party Object
sender.birthdate
String
Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).
sender.phone.number
String
Sender's phone number
sender.phone.area
String
Area code of the sender's telephone number
sender.phone.country
String
Country code of the sender's telephone number.
sender.phone
Object
sender.email
String
Sender's email address
sender.userReference
String
Username or id in your platform.
sender.document.id
String
Identity document Id. Usually numbers or combination of numbers and letters.
sender.document.type
String
Document types. Can be an international document issued by the the sender's country.
sender.document
Object
sender.lastName
String
Mandatory for individuals / Ignored for companies.
sender.name
String
Individual first name / company name
sender.type
String
Possible values: "COMPANY" or "INDIVIDUAL"
sender
Object
Party Object
beneficiary.bank.account.type*
String
beneficiary.bank.account.number*
String
Beneficiary's account number
merchant.phone.area
String
Area code of the merchant's telephone number
merchant.phone.country
String
Country code of the sender's telephone number.
merchant.phone
Object
Party Object.
merchant.userReference
String
Username or id in your platform.
merchant.document.id
String
Optional. Identity document id. Usually numbers or combination of numbers and letters.
merchant.document.type
String
Document type (related to the merchant's residence)
merchant.document
Object
Party Object.
merchant.lastName
String
Mandatory only for INDIVIDUAL type / Ignored for COMPANY.
merchant.name*
String
Individual first name / company name
merchant.type*
String
Possible values: "COMPANY" or "INDIVIDUAL"
merchant*
Object
Party Object.
sender.address.comment
String
Additional info, such as floor or apartment number.
sender.address.zipcode
String
Sender's zip code of residence
sender.address.city
String
Sender's city of residence
sender.address.number
String
Sender's number address
sender.address.street
String
Sender's street address
sender.address
Object
Party Object.
sender.nationality
string
Sender's nationality
merchant.email
String
Merchant's email address
merchant.address.comment
String
Additional info, such as floor or apartment number.
merchant.phone.number
String
Merchant's phone number
merchant.address.zipcode
String
Merchant's zip code of residence
merchant.address.street
String
Merchant's street address
merchant.address
Object
Party Object.
merchant.nationality
String
Merchant's nationality
merchant.birthdate
String
Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).
beneficiary.document.type
String
Type of beneficiary document
comment
String
Add any relevant informaction
conceptCode*
String
Choose the suitable concept code from our Concept Code List. Based on our experience, the most usual are 0039 (remittances) and 0040 (corporate payments).
accountNumber*
String
Your Localpayment account number in which the amount will be debited.
merchant.address.country
String
Merchant's country of residence
merchant.address.state
String
Merchant's state of residence
merchant.address.city
String
Merchant's city of residence
merchant.address.number
String
Merchant's number address
beneficiary.bank.branch*
OBJECT
Only mandatory for Brazilian bank accounts. Branch information. Party Object.
beneficiary.bank.branch.code*
String
Branch code Only Brazil
beneficiary.bank.branch.name
String
Branch name Only Brazil