Pix Refund (Bridge)
Pix Refund
This endpoint allows you to perform a refund of an incoming PIX transaction (cash-in). It is used when you need to return a full or partial amount that was previously received.
More information about request and response here: https://dev.paybrokers.com/reference/cashin-pix-refund
Webhook
After the request, the refund status will be updated asynchronously via webhook.
Payload example:
{
"id": "019c573c-e1d9-7b80-e690-09fb5878b5e4",
"transactionState": "Refund",
"transactionDate": "2026-03-30T10:00:00.000Z",
"transactionAmount": 100.00,
"transactionType": "Credit",
"transactionPaymentType": "PIX",
"transactionOrderId": "12345",
"transactionOrderDescription": "",
"transactionCharges": "0.000000",
"webhookUrl": "https://webhook.site/1234567890",
"transactionReceipt": "https://api.sandbox.paybrokers.com/v1/system/e-receipt/019c573c-e1d9-7b80-e690-09fb5878b5e4/receipt.pdf",
"transactionReceiptDate": "2026-03-30T10:00:00.000Z",
"transactionReceiptVoucher": "E44444444202405211946Dwg1pjxgehP",
"stateRegisteredDate": "2026-03-30T10:00:00.000Z",
"stateCompletedDate": "2026-03-30T10:00:00.000Z",
"stateCancelledDate": "2026-03-30T10:00:00.000Z",
"stateRefundDate": "2026-03-30T10:00:00.000Z",
"stateErrorDate": "2026-03-30T10:00:00.000Z",
"stateErrorCause": "ERROR_CODE",
"transactionRefundsAmount": 90.0,
"payer": {
"name": "John Doe",
"taxNumber": "1234567890",
"bankCode": "1234567890",
"accountAgency": "1234567890",
"accountNumber": "1234567890",
"accountDigit": "1",
"accountType": "CheckingAccount"
}
}Possible States
| State | Description |
|---|---|
Refund | The transaction was successfully refunded |
Error | Error during processing |
Important Notes
- The refund amount cannot exceed the available amount of the original transaction.
- Refunds may take a few seconds to be processed (asynchronous).
- Always use the webhook for final confirmation.
- The field
transactionRefundsAmountshows the total amount already refunded from the transaction.
Updated about 6 hours ago
What’s Next
