Brazil
Localpayment's API works 24/7/365, the payments are processed during business hours from 9am to 15pm GMT -3 when we have our cut-off. Requests done after the cut-off will be executed next business day
Create Payout Brazil
POST https://sandbox.localpayment.com/api/v2/payouts/payout
Array () [
*Key required
Headers
Content-Type*
String
Default: application/json Content Type
Authorization*
String
Authorization
customer_id*
String
string <= 12
Customer id
countryCode*
String
Value: "BRA"
Request Body
submerchant_code*
String
[ 3 .. 60 ] characters ^[a-zA-Z0-9\s\-_]{3,60}$
The name of the merchant sending the payment
sender_taxid
String
^[a-zA-Z0-9\s]{1,50}$
This field is required when the sender is a customer (C2C or C2B)
sender_name
String
^[a-zA-ZáéíóúÁÉÍÓÚ\\s]{1,60}$
This field is required when the sender is a customer (C2C or C2B)
sender_address
String
"^[a-zA-ZáéíóúÁÉÍÓÚ0-9\s]{1,300}$" accepts numbers, letters, and spaces, and the length is between 1 and 300 characters.
This field is required when the sender is a customer (C2C or C2B)
sender_state
String
^[a-zA-ZáéíóúÁÉÍÓÚ\\s]{1,20}$
This field is required when the sender is a customer (C2C or C2B)
sender_country
String
^[a-zA-ZáéíóúÁÉÍÓÚ\\s]{1,20}$
This field is required when the sender is a customer (C2C or C2B)
sender_birthdate
String
([12]\\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\\d|3[01]))
format - yyyymmdd
sender_email
String
beneficiary_name*
String
[ 1 .. 60 ] characters ^[a-zA-Z0-9\s]{1,60}$
bank_account_type*
String
1 charactersEnum: "C" "A"
Available: 'C' – checking account / 'A' – savings account
bank_code*
String
3 characters
bank_branch*
String
4 characters (^\d{4}[0-9a-zA-Z]{1}$)|(^\d{4}-[0-9a-zA-Z]{1...Show pattern
We only accept the branch number without the check digit
beneficiary_account_number*
String
[ 3 .. 14 ] characters (^\d{4,12}[0-9Xx]{1}$)|(^\d{4,12}-[0-9Xx]{1}$...Show pattern
hyphen is optional. Example 4450-1 or 44501 Also for minimum accepted values are XX-X o XXX with or without hypen
beneficiary_address
String
^[a-zA-ZáéíóúÁÉÍÓÚ0-9\s]{1,150}$
beneficiary_state
String
^[a-zA-ZáéíóúÁÉÍÓÚ\s]{1,60}$
beneficiary_country
String
^[a-zA-ZáéíóúÁÉÍÓÚ\s]{1,60}$
beneficiary_birth_date
String
([12]\\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\\d|3[01]))
format - yyyymmdd
beneficiary_email
String
beneficiary_phone_number
String
sender_phone_number
String
beneficiary_document_id*
String
^(?=(?:.{14}|.{11})$)[0-9]*$
merchant_id*
String
[ 0 .. 60 ] characters
Your internal transaction/tracking ID
concept_code*
String
currency*
String
Value: "BRL"
payout_date
String
format - yyyymmdd - UTC Timezone
amount*
integer <int64>
The last 2 digits represent the decimals (cents). This is the amount to be received by the beneficiary in the local currency
authenticate
boolean
If set as true, the transaction will be created in status OnHold and will expire after a week unless is aproved using the endpoint payouts/authenticate. As default this parameter is false and will be created with the status Received
Example: PayOut request
Last updated
Was this helpful?