BrazilGet Payout Status (Brazil PIX)
GET
/v1/payouts/:idPoll payout status after Create Payout. This is the shared status endpoint for all rails. There is no request body.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Use transactionId from the create response |
Example
cURL
curl -X GET https://api.transacty.ai/v1/payouts/{transactionId} \
-H "X-Transacty-Key: $TRANSACTY_KEY" \
-H "X-Transacty-Timestamp: $TS" \
-H "X-Transacty-Signature: $SIG" \
-H "Content-Type: application/json"Response fields
| Field | Type | Description |
|---|---|---|
id | string | Internal id |
transactionId | string | Public transaction id |
status | string | pending, success, or failed |
amount | string | Amount sent to the beneficiary |
currency | string | BRL |
platformOrderId | string | Provider reference (on success) |
recipient | object | Beneficiary and originator details |
createdAt | string (ISO datetime) | Creation timestamp |
completedAt | string | null (ISO datetime) | Completion timestamp |
estimatedCompletion | string (ISO datetime) | Estimated completion while pending |
fees | object | Transacty service fee |
fees.feeStatus | string | estimated while pending; applied on success |
totalWalletDebit | string | BRL debited from your wallet (amount + fee) |
On payout.failed, the BRL debit is refunded. Poll until
status === "success" or handle the webhook.
Next steps
Last updated on