Create Payout (Brazil PIX)
POST
/v1/br/payoutspayout:createCreate a PIX payout. Debits your BRL wallet immediately, then disburses via PIX.
You may send an optional Idempotency-Key header.
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
amount | string (numeric) | Yes | Payout amount in BRL. 10.00–15000.00. |
benificiaryAccountInfo | object | Yes | PIX recipient details |
benificiaryAccountInfo.number | string | Yes | PIX key (CPF, email, phone, or random key) |
benificiaryAccountInfo.orgId | string | Yes | Bank / institution id (from Transacty Brazil provider list) |
benificiaryAccountInfo.orgCode | string | Yes | Institution code |
benificiaryAccountInfo.orgName | string | Yes | Institution name |
benificiaryAccountInfo.holderName | string | Yes | Account holder name |
cardHolderInfo | object | Yes | Payer / originator (Travel Rule) |
cardHolderInfo.firstName | string | Yes | First name |
cardHolderInfo.lastName | string | Yes | Last name |
cardHolderInfo.email | string | Yes | |
cardHolderInfo.phone | string | Yes | Phone |
Example
Request
{
"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
| Field | Type | Description |
|---|---|---|
transactionId | string | Transaction identifier |
status | string | e.g. pending while processing |
amount | string | Amount sent to the beneficiary |
currency | string | BRL |
platformOrderId | string | Provider-side reference |
recipient | object | Echo of beneficiary and card-holder from the request |
estimatedCompletion | string (ISO datetime) | Estimated completion time |
fees | object | Transacty service fee |
fees.platformFee | string | Service fee amount |
fees.feeType | string | payout |
fees.feeStatus | string | estimated at create |
netAmount | string | null | null at create |
totalWalletDebit | string | Total 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 balance → 400 with an insufficient-balance message.
Provider rejection → 400 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