Skip to Content
BrazilPayoutCreate Payout (Brazil PIX)

Create Payout (Brazil PIX)

POST/v1/br/payoutspayout:create

Create a PIX payout. Debits your BRL wallet immediately, then disburses via PIX. You may send an optional Idempotency-Key header.

Request fields

FieldTypeRequiredDescription
amountstring (numeric)YesPayout amount in BRL. 10.0015000.00.
benificiaryAccountInfoobjectYesPIX recipient details
benificiaryAccountInfo.numberstringYesPIX key (CPF, email, phone, or random key)
benificiaryAccountInfo.orgIdstringYesBank / institution id (from Transacty Brazil provider list)
benificiaryAccountInfo.orgCodestringYesInstitution code
benificiaryAccountInfo.orgNamestringYesInstitution name
benificiaryAccountInfo.holderNamestringYesAccount holder name
cardHolderInfoobjectYesPayer / originator (Travel Rule)
cardHolderInfo.firstNamestringYesFirst name
cardHolderInfo.lastNamestringYesLast name
cardHolderInfo.emailstringYesEmail
cardHolderInfo.phonestringYesPhone

Example

{ "amount": "500.00", "benificiaryAccountInfo": { "number": "ana.souza@email.com", "orgId": "PIX_BANK_ID", "orgCode": "PIX_BANK_CODE", "orgName": "Example Bank", "holderName": "Ana Souza" }, "cardHolderInfo": { "firstName": "John", "lastName": "Merchant", "email": "ops@merchant.com", "phone": "+5511987654321" } }

Response fields

FieldTypeDescription
transactionIdstringTransaction identifier
statusstringe.g. pending while processing
amountstringAmount sent to the beneficiary
currencystringBRL
platformOrderIdstringProvider-side reference
recipientobjectEcho of beneficiary and card-holder from the request
estimatedCompletionstring (ISO datetime)Estimated completion time
feesobjectTransacty service fee
fees.platformFeestringService fee amount
fees.feeTypestringpayout
fees.feeStatusstringestimated at create
netAmountstring | nullnull at create
totalWalletDebitstringTotal debited from BRL wallet (amount + platformFee)

Note the spelling benificiaryAccountInfo — it must match exactly. Valid orgId / orgCode / orgName values come from Transacty’s Brazil provider list; confirm with support before going live.

Insufficient balance400 with an insufficient-balance message. Provider rejection400 with code: payment_provider_rejected and the provider reason in message. On payout failure after debit, the BRL wallet is refunded automatically.

Next steps

Last updated on