> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Confirm a PIX refund > Sends an `INITIATED` refund: the amount leaves the wallet's `FLEX_INTERNATIONAL` balance and goes back to the account that sent the Pix. The answer is the refund as the bank took it: usually `REQUESTED` (sent, not settled yet) — then `CONFIRMED` once the bank settles it, or `FAILED` if the receiving bank refuses it — and sometimes `CONFIRMED` or `FAILED` right away. Follow it with `GET .../transactions/{transactionId}/reversals`; a settled refund also appears in the wallet's transactions as a Pix `DEBIT` with `initiationType` `REVERSAL`. `reversalAmount` is the amount the bank refunded. The request has no body. If the bank refuses the refund here, the refund stays `INITIATED` — confirm it again, or cancel it — and the amount set aside for it goes back to the wallet's `FLEX_INTERNATIONAL` balance; when that return fails, it is retried automatically, and the amount stays unavailable until it goes through. Organization admins can confirm refunds of every wallet; other users of the wallets shared with them as `OWNER` or `USER`. Use `default` as `walletId` for the organization's main wallet, and send `x-environment: LIVE` for production wallets. ## OpenAPI ````yaml /api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm openapi: 3.0.3 info: title: Banking version: 1.0.0 description: >- Portão 3 banking API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Banking attaches a zod validationSchema at the route; request bodies are resolved from it (object + array roots). Responses have no presenter layer, so they stay tier=unknown. Confidence tiers: generated:typed=300 copied:manual=0 unknown=20. servers: - url: https://api.banking.v2.portao3.com.br/ description: production - url: https://api.banking.dev.3pers.com.br/ description: development security: [] tags: - name: Accounts - name: Account Limits - name: Wallets - name: Transaction Limits - name: Transfers - name: Cards - name: Card Limits - name: Cards 3DS - name: Pix Payments - name: Pix Keys - name: PIX Charges - name: PIX Automatic - name: PIX Initiation (Open Finance) - name: PIX Infractions (MED) - name: Boleto Payments - name: Boleto Charges - name: TED Payments - name: Transactions - name: Transaction Reversals - name: Spend Review - name: Cashback - name: Currency Codes paths: /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm: post: tags: - Transaction Reversals summary: Confirm a PIX refund description: >- Sends an `INITIATED` refund: the amount leaves the wallet's `FLEX_INTERNATIONAL` balance and goes back to the account that sent the Pix. operationId: >- postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdReversalsByReversalIdConfirm parameters: - name: realmId in: path required: true description: |- ID of your realm. Format: `UUID` schema: type: string format: uuid example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b - name: organizationId in: path required: true description: |- ID of the organization the wallet belongs to. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: accountId in: path required: true description: ID of the organization's account (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 66f2a1c7b4d3e80012c9a0b4 - name: walletId in: path required: true description: >- ID of the wallet that received the Pix (24 hexadecimal characters), or `default` for the organization's main wallet. schema: type: string pattern: ^([0-9a-fA-F]{24}|default)$ example: 66f2a3d1b4d3e80012c9a0d2 - name: transactionId in: path required: true description: >- ID of the transaction of the Pix received (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 6710c9a2b4d3e80012c9a1e4 - name: reversalId in: path required: true description: ID of the refund (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 6710d2e4b4d3e80012c9a1f7 - name: x-environment in: header required: false description: >- Environment of the wallet: `LIVE` (production) or `TEST` (sandbox). When you omit it, the request runs in `TEST`; any other value is rejected. schema: type: string enum: - LIVE - TEST example: LIVE responses: '200': description: Successful response content: application/json: schema: type: object properties: _id: type: string description: ID of the reversal. example: 6710d2e4b4d3e80012c9a1f7 environment: type: string enum: - LIVE - TEST description: 'Environment of the reversal: `LIVE` or `TEST`.' example: LIVE realmId: type: string description: ID of the realm. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizationId: type: string description: ID of the organization. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid accountId: type: string description: ID of the account. example: 66f2a1c7b4d3e80012c9a0b4 walletId: type: string description: ID of the wallet that received the payment and refunds it. example: 66f2a3d1b4d3e80012c9a0d2 transactionId: type: string description: >- ID of the wallet transaction of the payment being refunded. example: 6710c9a1b4d3e80012c9a1e2 status: type: string enum: - INITIATED - REQUESTED - CONFIRMED - FAILED - CANCELED description: >- Status of the refund: `INITIATED` (created, not confirmed yet), `REQUESTED` (sent, waiting to settle), `CONFIRMED` (the money went back), `FAILED` (refused, see `errorCode`) or `CANCELED` (cancelled before it was confirmed). example: REQUESTED requestedAt: type: string description: >- When the refund was sent to the bank. Absent while it is `INITIATED`; it doesn't mean the refund settled. example: '2026-10-17T14:22:03.000Z' format: date-time originalPixId: type: string description: ID of the PIX payment being refunded, when it is known. example: 6710c9a0b4d3e80012c9a1e0 originalPixBillingId: type: string description: ID of the PIX charge the payment paid, when it paid one. example: 6710c5f2b4d3e80012c9a1d4 originalReceipt: type: object properties: endToEndId: type: string description: End-to-end identifier (E2E ID) of the PIX payment. example: E18236120202611021310s0123456789 description: End-to-end identifier of the payment being refunded. originalEffectiveAt: type: string description: When the payment being refunded was received. example: '2026-10-16T18:40:11.000Z' format: date-time originalAmount: type: number description: Amount of the payment being refunded, in cents. example: 50000 originalCurrency: type: string description: >- Currency of that payment, as an ISO 4217 numeric code: `986` (Brazilian real). example: '986' originalCreditParty: type: object properties: _id: type: string description: Internal identifier of this entry. example: 6710d2e4b4d3e80012c9a1f8 bankIspb: type: string description: ISPB code of the party's bank. example: '18236120' accountType: type: string enum: - CACC - SLRY - SVGS - TRAN description: >- Type of the party's account: `CACC` (checking), `SLRY` (salary), `SVGS` (savings) or `TRAN` (payment account). example: CACC document: type: string description: CPF or CNPJ of the party, digits only. example: '12345678000190' keyType: type: string enum: - PHONE - EMAIL - CPF - CNPJ - EVP description: >- Type of the PIX key used: `CPF`, `CNPJ`, `EMAIL`, `PHONE` or `EVP` (random key). example: EMAIL key: type: string nullable: true description: The PIX key used. Can be `null`. example: financeiro@cliente.com.br name: type: string description: Name of the party. example: Cliente Exemplo Ltda street: type: string description: Street of the party's address. example: Rua das Flores, 100 city: type: string description: City of the party's address. example: Curitiba state: type: string description: State of the party's address, as its two-letter code. example: PR postalCode: type: string description: Postal code (CEP) of the party's address. example: '80010000' branch: type: string description: Branch of the party's account. example: '0001' accountNumber: type: string description: Number of the party's account. example: '123456' description: 'Who received the payment being refunded: this wallet.' originalDebitParty: type: object properties: _id: type: string description: Internal identifier of this entry. example: 6710d2e4b4d3e80012c9a1f8 bankIspb: type: string description: ISPB code of the party's bank. example: '18236120' accountType: type: string enum: - CACC - SLRY - SVGS - TRAN description: >- Type of the party's account: `CACC` (checking), `SLRY` (salary), `SVGS` (savings) or `TRAN` (payment account). example: CACC document: type: string description: CPF or CNPJ of the party, digits only. example: '12345678000190' keyType: type: string enum: - PHONE - EMAIL - CPF - CNPJ - EVP description: >- Type of the PIX key used: `CPF`, `CNPJ`, `EMAIL`, `PHONE` or `EVP` (random key). example: EMAIL key: type: string nullable: true description: The PIX key used. Can be `null`. example: financeiro@cliente.com.br name: type: string description: Name of the party. example: Cliente Exemplo Ltda street: type: string description: Street of the party's address. example: Rua das Flores, 100 city: type: string description: City of the party's address. example: Curitiba state: type: string description: State of the party's address, as its two-letter code. example: PR postalCode: type: string description: Postal code (CEP) of the party's address. example: '80010000' branch: type: string description: Branch of the party's account. example: '0001' accountNumber: type: string description: Number of the party's account. example: '123456' description: >- Who sent the payment being refunded — and receives the refund. reversalReason: type: string description: 'Why the payment is refunded: `USER_REQUESTED`.' example: USER_REQUESTED reversalDescription: type: string nullable: true description: Description of the refund. `null` when none was given. example: Pedido cancelado pelo cliente reversalEffectiveAt: type: string nullable: true description: When the refund settled. `null` until it does. example: null format: date-time reversalAmount: type: number description: >- Amount refunded, in cents. At most the amount of the payment. example: 50000 reversalCurrency: type: string description: >- Currency of the refund, as an ISO 4217 numeric code: `986` (Brazilian real). example: '986' reversalAdditionalInformation: type: string description: Extra information sent with the refund. example: Estorno referente ao pedido 4471 reversalReceipt: type: object properties: endToEndId: type: string description: End-to-end identifier (E2E ID) of the PIX payment. example: E18236120202611021310s0123456789 description: >- End-to-end identifier of the refund. Present once it was sent. errorCode: type: string description: >- Code of the error that made the refund fail. Only on `FAILED` refunds. example: AM04 errorDescription: type: string description: Description of that error. example: Saldo insuficiente na conta do recebedor external: type: object properties: reversalId: type: string description: Identifier of the refund at the bank. example: rev_6b8f0c2a9d1e4f3a description: References of the refund. Present once it was sent. processingType: type: string enum: - INSTANT - DELAYED description: 'How the refund is processed: `INSTANT` or `DELAYED`.' example: INSTANT createdAt: type: string description: When the refund was created. example: '2026-10-17T14:21:40.000Z' format: date-time updatedAt: type: string description: When it last changed. example: '2026-10-17T14:22:05.000Z' format: date-time __v: type: number description: Internal revision counter of the refund. example: 0 required: - _id - environment - realmId - organizationId - accountId - walletId - transactionId - status - originalEffectiveAt - originalAmount - originalCurrency - reversalReason - reversalDescription - reversalEffectiveAt - reversalAmount - reversalCurrency - processingType - createdAt - updatedAt description: >- A refund of a PIX payment the wallet received: the money, in full or in part, goes back to whoever sent it. '400': description: >- `INSUFFICIENT_FUNDS` — The wallet's `FLEX_INTERNATIONAL` balance doesn't cover the refund. Nothing was sent; the refund is still `INITIATED`. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - INSUFFICIENT_FUNDS description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: INSUFFICIENT_FUNDS origin: BANKING message: Transaction rejected due to insufficient funds '403': description: >- `FORBIDDEN_WALLET` — You are not an admin of the organization and the wallet isn't shared with you as `OWNER` or `USER`. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - FORBIDDEN_WALLET description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: FORBIDDEN_WALLET origin: BANKING message: >- You do not have permission to perform this action on this wallet '404': description: >- `ACCOUNT_NOT_FOUND` — No account with this ID exists in the organization. `WALLET_NOT_FOUND` — No wallet with this ID exists in the account and environment. `PIX_REVERSAL_NOT_FOUND` — The transaction has no refund with this ID in this environment. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - ACCOUNT_NOT_FOUND - WALLET_NOT_FOUND - PIX_REVERSAL_NOT_FOUND description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: ACCOUNT_NOT_FOUND origin: BANKING message: Account not found '422': description: >- `BAD_REQUEST` — A path parameter is invalid; `fields` lists each one. `PIX_REVERSAL_STATUS_NOT_INITIATED` — The refund was already sent or cancelled, or another confirmation of it is under way. `WALLET_EXTERNAL_PROPERTIES_NOT_SET` — The wallet isn't set up at the bank to send money. Contact support. `INVALID_ACCOUNT_STATUS` — The bank refused to move the wallet's money: the account can't send it right now. Nothing was sent; the refund is still `INITIATED`. `BANKING_PROVIDER_VALIDATION_ERROR` — The bank refused a field of the refund (such as a too-long `description`); `fields` names it. The refund wasn't sent and is still `INITIATED`. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST - PIX_REVERSAL_STATUS_NOT_INITIATED - WALLET_EXTERNAL_PROPERTIES_NOT_SET - INVALID_ACCOUNT_STATUS - BANKING_PROVIDER_VALIDATION_ERROR description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BAD_REQUEST origin: BANKING message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: organizationId message: Invalid UUID code: ORGANIZATIONID_UUID '429': description: >- `BANKING_PROVIDER_INTEGRATION_ERROR` — Too many requests reached the wallet's balance at once. Nothing was sent — retry shortly. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_INTEGRATION_ERROR description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_INTEGRATION_ERROR origin: BANKING message: Too Many Requests '500': description: >- `BANKING_PROVIDER_INTEGRATION_ERROR` — The bank answered with an error this API doesn't recognize. The refund is still `INITIATED` — check the wallet's transactions before confirming again. `BANKING_PROVIDER_UNAVAILABLE` — The bank answered with a server error. The refund is still `INITIATED` — check the wallet's transactions before confirming again. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_INTEGRATION_ERROR - BANKING_PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_INTEGRATION_ERROR origin: BANKING message: Unexpected banking provider error '502': description: >- `BANKING_PROVIDER_UNAVAILABLE` — The bank's gateway failed. The refund is still `INITIATED` — check the wallet's transactions before confirming again. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_UNAVAILABLE origin: BANKING message: Banking provider temporarily unavailable, please retry '503': description: >- `BANKING_PROVIDER_UNAVAILABLE` — The bank was unavailable. The refund is still `INITIATED` — check the wallet's transactions before confirming again. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_UNAVAILABLE origin: BANKING message: Banking provider temporarily unavailable, please retry '504': description: >- `BANKING_PROVIDER_UNAVAILABLE` — The bank didn't answer in time, so the refund may still go out. It is still `INITIATED` — check the wallet's transactions before confirming again. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_UNAVAILABLE origin: BANKING message: Banking provider did not respond in time, please retry ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.