Payout to Brazil (PIX)

To send a payout to Brazil, the payout_method must be set to PIX. In the required_BR object, provide the PIX key of the recipient.

  POST https://api-sandbox.letpay.io/payoutTransaction

Additional Required Fields (Brazil)

Field	Type	Required	Description
pix_key	String	Yes	Customer's PIX key (e.g., CPF, email, phone, or a UUID-based key).

PIX Key Format

Type	Requirement	Example
CNPJ	No formatting; must contain 14 numbers	71370784000198
CPF	No formatting; must contain 11 numbers	12345678909
Email	Must be a valid email format	[email protected]
Telephone	Must follow international format with '+' prefix	+5511987654321
EVP	Must be a valid UUID version 4	25899a12-349c-4d6b-8663-85fde794bdfc

Example Request

{
    "payoutTransactions": [
        {
            "original_amount": 10.00,
            "original_currency": "BRL",
            "payment_currency": "BRL",
            "payment_country": "BR",
            "payout_method": "PIX",
            "contract_id": "MY_PAYOUT_CONTRACT_ID",
            "reference_id": "MY_REFERENCE_ID",
            "notification_url": "https://my.notification.url/callback",
            "ttl": 0,
            "required_BR": {
                "pix_key": "25899a12-349c-4d6b-8663-85fde794bdfc"
            }
        }
    ]
}

Example Response

{
    "payoutTransactionResponses": [
        {
            "tx_id": "PAYOUT_REFERENCE_ID",
            "reference_id": "MY_REFERENCE_ID",
            "amount": 200,
            "original_amount": 200,
            "original_asset": "BRL",
            "customer_fees": 0,
            "customer_amount": 200,
            "merchant_fees": 0,
            "merchant_amount": 200,
            "asset": "BRL",
            "banking_data": "25899a12-349c-4d6b-8663-85fde794bdfc",
            "status": "CREATED"
        }
    ],
    "refresh_token": "MY_ACCESS_TOKEN"
}