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

Name	Type	Description
Content-Type*	String	Default: application/json Content Type
Authorization*	String	Authorization
customer_id*	String	string <= 12 Customer id
countryCode*	String	Value: "BRA"

Request Body

Name	Type	Description
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 Check the Bank Codes
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]*$ Check document_id validation Brazil
merchant_id*	String	[ 0 .. 60 ] characters Your internal transaction/tracking ID
concept_code*	String	You can see the concept code Concept Codes
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

200: OK

[
    {
        "authenticate": false,
        "transaction_id": 308047,
        "payout_id": 51622,
        "status": "Received",
        "Ticket": "16401863440000",
        "submerchant_code": "TEST",
        "sender_taxid": null,
        "sender_name": "SENDER",
        "sender_address": "ADDRESS",
        "sender_state": "STATE",
        "sender_country": "ARGENTINA",
        "sender_birthdate": null,
        "sender_email": null,
        "sender_phone_number": null,
        "sender_zip_code": null,
        "beneficiary_name": "BENFICIARY",
        "beneficiary_document_id": "XXXXXXXXXXXX",
        "bank_account_type": "C",
        "bank_code": "341",
        "bank_branch": "00019",
        "beneficiary_address": "",
        "beneficiary_account_number": "XXXXXXXX",
        "beneficiary_state": null,
        "beneficiary_country": null,
        "beneficiary_birth_date": null,
        "beneficiary_email": null,
        "beneficiary_phone_number": "0",
        "beneficiary_zip_code": null,
        "merchant_id": "1234567890001",
        "concept_code": "0001",
        "currency": "BRL",
        "payout_date": "20211222",
        "amount": 1001,
        "exchange_rate": 5659629,
        "iof_tax": 1,
        "ErrorRow": {
            "Errors": [],
            "HasError": false
        }
    }
]

Example: PayOut request

Request

curl --location --request POST {{Api_URL}} \
--header 'Authorization: {{Token_Generated}} \
--header 'customer_id: {{Your_CustomerID}}' \
--header 'countryCode: BRA' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "amount": 543000,
        "bank_account_type": "A",
        "bank_branch": "1677",
        "bank_code": "001",
        "beneficiary_account_number": "4462-4",
        "beneficiary_document_id": 45053975809,
        "beneficiary_name": "Beneficiary Name",
        "concept_code": "0001",
        "currency": "BRL",
        "merchant_id": {{$timestamp}},
        "submerchant_code": "Submerchant Code"
    }
]

Request (complete)

curl --location --request POST {{Api_URL}} \
--header 'Authorization: {{Token_Generated}} \
--header 'customer_id: {{Your_CustomerID}}' \
--header 'countryCode: BRA' \
--header 'Content-Type: application/json' \
--data-raw '[
   {
        "amount": 543000,
        "bank_account_type": "A",
        "bank_branch": "1677",
        "bank_code": "001",
        "beneficiary_account_number": "4462-4",
	"beneficiary_address": "Beneficiary Address",
        "beneficiary_birth_date": "19800101",
        "beneficiary_country": "Beneficiary Country",
        "beneficiary_document_id": 45053975809,
        "beneficiary_email": "[e-mail]",
	"beneficiary_name":"Beneficiary Name",
        "beneficiary_phone_number": "123456789",
        "beneficiary_state": "Beneficiary State",
        "concept_code": "0001",
        "currency": "BRL",
        "merchant_id": {{$timestamp}},
        "payout_date": "20221129",
        "sender_address": "Sender Address",
        "sender_birthdate": "19800101",
        "sender_country": "Sender Country",
        "sender_email": "[e-mail]",
        "sender_name": "Sender Name",
        "sender_phone_number": "987654321",
        "sender_state": "Sender State",
        "sender_taxid": "Sender Tax",		
        "submerchant_code": "Submerchant Code"
    }
]

Status OK

[
    {
        "authenticate": false,
        "transaction_id": 318605,
        "payout_id": 61987,
        "status": "Received",
        "Ticket": "16680015870368",
        "submerchant_code": "Submerchant Code",
        "sender_taxid": null,
        "sender_name": null,
        "sender_address": "",
        "sender_state": null,
        "sender_country": null,
        "sender_birthdate": null,
        "sender_email": null,
        "sender_phone_number": null,
        "sender_zip_code": null,
        "beneficiary_name": "Beneficiary Name",
        "beneficiary_document_id": "45053975809",
        "bank_account_type": "A",
        "bank_code": "001",
        "bank_branch": "16772",
        "beneficiary_address": "",
        "beneficiary_account_number": "4462-4",
        "beneficiary_state": null,
        "beneficiary_country": null,
        "beneficiary_birth_date": null,
        "beneficiary_email": null,
        "beneficiary_phone_number": "0",
        "beneficiary_zip_code": null,
        "merchant_id": "1669675041",
        "concept_code": "0001",
        "currency": "BRL",
        "payout_date": "20221128",
        "amount": 543000,
        "exchange_rate": 5014071,
        "iof_tax": 412,
        "ErrorRow": {
            "Errors": [],
            "HasError": false
        }
    }
]sos

Bad Request

[
    {
        "authenticate": false,
        "transaction_id": 0,
        "payout_id": 0,
        "status": null,
        "Ticket": null,
        "submerchant_code": "Submerchant Code",
        "sender_taxid": null,
        "sender_name": null,
        "sender_address": null,
        "sender_state": null,
        "sender_country": null,
        "sender_birthdate": null,
        "sender_email": null,
        "sender_phone_number": null,
        "sender_zip_code": null,
        "beneficiary_name": "Beneficiary Name",
        "beneficiary_document_id": "45053975809",
        "bank_account_type": "S",
        "bank_code": "001",
        "bank_branch": "1677",
        "beneficiary_address": null,
        "beneficiary_account_number": "4462-4",
        "beneficiary_state": null,
        "beneficiary_country": null,
        "beneficiary_birth_date": null,
        "beneficiary_email": null,
        "beneficiary_phone_number": null,
        "beneficiary_zip_code": null,
        "merchant_id": "1669675683",
        "concept_code": "0001",
        "currency": "BR",
        "payout_date": "20221128",
        "amount": 543000,
        "exchange_rate": 0,
        "iof_tax": 0,
        "ErrorRow": {
            "Errors": [
                {
                    "Key": "currency",
                    "Messages": [
                        "Parameter :: currency :: invalid format, only allow codes: 'USD' | 'BRL'."
                    ],
                    "CodeTypeError": [
                        "INVALID"
                    ]
                },
                {
                    "Key": "bank_account_type",
                    "Messages": [
                        "Parameter :: bank_account_type :: invalid format, only characters available: 'C' – checking account, 'A' – savings account."
                    ],
                    "CodeTypeError": [
                        "INVALID"
                    ]
                }
            ],
            "HasError": true
        }
    }
]hsi