> ## 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. # Get a transaction > Returns one of the wallet's transactions in full: its details sub-document (`cardTransaction`, `pixTransaction`, `boletoTransaction`, `tedTransaction`, `p2pTransaction` or `feeTransaction`), its custom fields and, once it was submitted for an expense review, its `spendReview`. For a Pix sent, a boleto paid or a card transaction, `paymentInfo` adds the status and references of the Pix payment, boleto payment or card behind it; with `details=true`, the whole record instead. Use `default` as `walletId` for the organization's main wallet, and send `x-environment: LIVE` for production wallets. Organization admins can read every wallet's transactions; other users only those of the wallets shared with them, in any role. ## OpenAPI ````yaml /api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId} 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}: get: tags: - Transactions summary: Get a transaction description: >- Returns one of the wallet's transactions in full: its details sub-document (`cardTransaction`, `pixTransaction`, `boletoTransaction`, `tedTransaction`, `p2pTransaction` or `feeTransaction`), its custom fields and, once it was submitted for an expense review, its `spendReview`. operationId: >- getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionId 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 (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 (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 66f2a7e9b4d3e80012c9a112 - 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 - name: details in: query required: false description: >- `true` to get, in `paymentInfo`, the whole Pix payment, boleto payment or card behind the transaction instead of its status and external references (or, for a card, its masked number). Defaults to `false`. schema: type: string enum: - 'true' - 'false' example: 'false' responses: '200': description: Successful response content: application/json: schema: type: object properties: _id: type: string description: ID of the transaction. example: 6710c9a2b4d3e80012c9a1e4 environment: type: string enum: - LIVE - TEST description: >- Environment of the transaction: `LIVE` (production) or `TEST` (sandbox). 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 organization's account. example: 66f2a1c7b4d3e80012c9a0b4 walletId: type: string description: ID of the wallet. example: 66f2a3d1b4d3e80012c9a0d2 cardId: type: string description: >- ID of the card, on a card transaction or a fee charged on a card. example: 66f2a4b8b4d3e80012c9a0e1 balanceCategory: type: string description: >- Balance category of the wallet the amount was taken from or added to, such as `FLEX_INTERNATIONAL`, `FLEX_NATIONAL`, `ADS`, `TRAVEL`, `HOTEL`, `AIRLINES`, `GAS`, `FOOD` or `CASHBACK`. example: FLEX_INTERNATIONAL availableBalanceBefore: type: number nullable: true description: >- Balance of that category before the transaction, in cents (BRL). Can be `null`. example: 1250000 financialImpactType: type: string enum: - DEBIT - CREDIT - NONE description: >- Effect on the balance: `DEBIT` (money out), `CREDIT` (money in) or `NONE` (no effect — a declined or authorization-only card transaction, a failed transfer). example: CREDIT responseCode: type: number description: >- Result code. `0` is success; for a card, a few other codes are approvals too (such as `10`, partially approved) and the rest are decline reasons, such as `51` (insufficient funds). Use `financialImpactType` to know whether money moved. example: 0 msgType: type: number description: >- Kind of message: `1100` (card authorization), `1120` (card settlement or credit), `1400` (card refund), `1420` (card reversal), `1600` (Pix or boleto), `1220` (transfer between wallets, or TED), `1722` (charge), `8900` / `8901` / `8902` (fee). example: 1600 txnType: type: number description: >- Operation type: for a card, ISO 8583 codes such as `0` (purchase) or `14` (return); for the others, `12` (credit), `13` (debit), `36` (Pix received), `39` (Pix or boleto paid) or `27` (a refund). example: 36 effectiveAt: type: string description: >- When the transaction happened. Lists are ordered by it, and the period filters apply to it. example: '2026-10-17T13:42:58.000Z' format: date-time billingAmount: type: number description: >- Amount charged to or credited on the wallet, in cents (BRL). example: 15000 billingAmountAuthorized: type: number description: >- Amount authorized, in cents (BRL). The totals add this one up. example: 15000 billingCurrency: type: string description: >- Currency of the billed amounts, as an ISO 4217 numeric code: `986` (Brazilian real). Absent on a few boleto transactions. example: '986' cardTransaction: type: object properties: _id: type: string description: >- ID of the details record. Absent on some older transactions. example: 66f2a7e9b4d3e80012c9a115 acquiringCountryCode: type: string nullable: true description: >- Country of the merchant's acquirer, as an ISO 3166 numeric code. Can be `null`. example: '076' acquiringId: type: string nullable: true description: Identifier of the merchant's acquirer. Can be `null`. example: '012345' localTime: type: string description: Date and time of the purchase. example: '2026-11-02T15:20:31.000Z' format: date-time txnCurrency: type: string description: >- Currency of the purchase, as an ISO 4217 numeric code (`986` is the Brazilian real). example: '986' txnAmount: type: number description: Amount of the purchase, in cents of `txnCurrency`. example: 18990 txnAmountAuthorized: type: number description: Amount authorized, in cents of `txnCurrency`. example: 18990 linkedTransactions: type: array items: type: object properties: _id: type: string description: ID of the link. Absent on some older links. example: 66f2a7e9b4d3e80012c9a114 transactionId: type: string description: ID of the related transaction. example: 66f2a7e9b4d3e80012c9a113 linkType: type: string description: >- How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side. example: CLEARING_DEBITED_BY createdAt: type: string description: When the link was created. example: '2026-11-03T09:12:40.000Z' updatedAt: type: string description: When the link last changed. example: '2026-11-03T09:12:40.000Z' required: - transactionId - linkType - createdAt - updatedAt description: >- A link between this transaction and a related one (its settlement, a refund, …). description: >- Related transactions: the settlement, a refund, a reversal. mcc: type: string nullable: true description: >- Merchant category code (MCC) of the merchant. Can be `null`. example: '5943' merchantCity: type: string nullable: true description: City of the merchant. Can be `null`. example: SAO PAULO merchantCountry: type: string nullable: true description: >- Country of the merchant, as an ISO 3166 alpha-3 code. Can be `null`. example: BRA merchantId: type: string nullable: true description: Identifier of the merchant. Can be `null`. example: '000000000473921' merchantName: type: string nullable: true description: Name of the merchant. Can be `null`. example: PAPELARIA CENTRAL expired: type: boolean description: >- Whether the authorization expired without being settled. Absent on older transactions. example: false cleared: type: boolean description: >- Whether the purchase has been settled. Absent on older transactions. example: true overcleared: type: boolean description: >- Whether it was settled for more than was authorized. Absent on older transactions. example: false reversed: type: boolean description: >- Whether the authorization was reversed. Absent on older transactions. example: false posEntryMode: type: string nullable: true description: >- How the card was used, such as `E-Commerce` or `Contactless`. Can be `null`. example: E-Commerce recurring: type: boolean nullable: true description: >- Whether the merchant flagged the purchase as recurring. Absent or `null` when unknown. example: false mobileWalletProvider: type: number description: >- Device wallet the card was used through: `103` (Apple Pay), `216` (Google Pay), `217` (Samsung Pay) or `327` (a card stored by a merchant). Absent when the card was used directly, and on transactions before August 2026. example: 103 required: - localTime - txnCurrency - txnAmount - txnAmountAuthorized - linkedTransactions description: Details of a card purchase, its settlement or refund. pixTransaction: type: object properties: _id: type: string description: ID of the details record. Present on Pix sent only. example: 6710c9a2b4d3e80012c9a1e7 internalPixId: type: string description: >- ID of the Pix payment behind a Pix SENT — use it with the Pix payment routes. Absent on a Pix received. example: 6710c8f1b4d3e80012c9a1d0 internalPixBillingId: type: string description: >- ID of a Pix charge of the organization. Not set on current transactions. example: 6710c8f1b4d3e80012c9a1d1 creditParty: type: object properties: _id: type: string description: ID of the record. Absent on received Pix. example: 6710c9a2b4d3e80012c9a1e5 name: type: string description: Name of the person or company. example: Papelaria Central Ltda document: type: string description: >- CPF or CNPJ of the person or company, digits only — partially masked when the payer's bank sends it so. example: '12345678000190' key: type: string nullable: true description: >- Pix key used, when the Pix went to a key. Can be `null`. example: financeiro@papelariacentral.com.br bankIspb: type: string description: ISPB code of the bank (8 digits). example: '60701190' branch: type: string description: Bank branch, digits only. example: '0001' accountNumber: type: string description: Account number, digits only. example: '123456' accountType: type: string description: >- Type of the account: `CACC` (checking), `SVGS` (savings), `TRAN` (payment account) or `SLRY` (salary). example: CACC street: type: string nullable: true description: >- Street of the address. `null` when present — no address is recorded. example: null city: type: string nullable: true description: City of the address. `null` when present. example: null state: type: string nullable: true description: State of the address. `null` when present. example: null postalCode: type: string nullable: true description: Postal code of the address. `null` when present. example: null required: - name - document description: Who received the money. debitParty: type: object properties: _id: type: string description: ID of the record. Absent on received Pix. example: 6710c9a2b4d3e80012c9a1e5 name: type: string description: Name of the person or company. example: Papelaria Central Ltda document: type: string description: >- CPF or CNPJ of the person or company, digits only — partially masked when the payer's bank sends it so. example: '12345678000190' key: type: string nullable: true description: >- Pix key used, when the Pix went to a key. Can be `null`. example: financeiro@papelariacentral.com.br bankIspb: type: string description: ISPB code of the bank (8 digits). example: '60701190' branch: type: string description: Bank branch, digits only. example: '0001' accountNumber: type: string description: Account number, digits only. example: '123456' accountType: type: string description: >- Type of the account: `CACC` (checking), `SVGS` (savings), `TRAN` (payment account) or `SLRY` (salary). example: CACC street: type: string nullable: true description: >- Street of the address. `null` when present — no address is recorded. example: null city: type: string nullable: true description: City of the address. `null` when present. example: null state: type: string nullable: true description: State of the address. `null` when present. example: null postalCode: type: string nullable: true description: Postal code of the address. `null` when present. example: null required: - name - document description: Who paid. payer: type: object properties: document: type: string description: CPF or CNPJ of the payer. example: '12345678909' name: type: string description: Name of the payer. example: Mariana Costa description: >- Who paid a QR code charge, when the charge recorded it. Rare. withdrawal: type: object properties: agentType: type: string nullable: true description: >- Who provides the cash, for a Pix withdrawal. `null` on a Pix that isn't one. example: null serviceProvider: type: string nullable: true description: >- ISPB of the cash provider, for a Pix withdrawal. `null` on a Pix that isn't one. example: null description: Withdrawal details, on a QR code Pix. receipt: type: object properties: endToEndId: type: string description: >- End-to-end ID of the Pix (32 characters) — the identifier both banks know it by. example: E60701190202611031520s0a1b2c3d4e required: - endToEndId description: The Pix's identifier in the Pix network. description: type: string nullable: true description: Message the payer attached to the Pix. Can be `null`. example: Pedido 1234 dueDate: type: string nullable: true description: Due date of a QR code charge with one. Can be `null`. example: null format: date-time expiresAt: type: string nullable: true description: >- When the QR code stops accepting payment. Can be `null`. example: null format: date-time txnCurrency: type: string description: >- Currency, as an ISO 4217 numeric code: always `986` (Brazilian real). example: '986' txnOriginalAmount: type: number description: Original amount of the charge, in cents. example: 15000 txnDiscountAmount: type: number description: Discount applied, in cents. example: 0 txnFineAmount: type: number description: Fine charged, in cents. example: 0 txnInterestAmount: type: number description: Interest charged, in cents. example: 0 txnPurchaseAmount: type: number description: >- Purchase part of a Pix with change (Pix Troco), in cents. `0` otherwise. example: 0 txnWithdrawalAmount: type: number description: >- Cash part of a Pix withdrawal or Pix with change, in cents. `0` otherwise. example: 0 txnUpdatedAmount: type: number description: Amount after discount, fine and interest, in cents. example: 15000 txnUpdatedAmountAuthorized: type: number description: Amount authorized, in cents. example: 15000 initiationType: type: string description: >- How the Pix was started: `DICT` (to a Pix key), `MANUAL` (to bank details), `STATIC_QRCODE`, `DYNAMIC_QRCODE`, `AUTOMATIC_PIX` (a Pix Automático charge) or `REVERSAL` (a refund of an earlier Pix). example: DICT qrCodeType: type: string description: >- Kind of QR code paid: `STATIC`, `COB` (an immediate charge) or `COBV` (a charge with a due date). Absent when no QR code was used. example: COB pixCopyPaste: type: string description: The Pix copy-and-paste code of the QR code paid. example: >- 00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5913PAPELARIA6009SAO PAULO62070503***63041D3D qrQrCodeActive: type: boolean description: Whether the QR code was still active. example: true errorDescription: type: string description: Why a Pix that failed was refused. example: Saldo insuficiente cleared: type: boolean description: Whether the Pix is settled. example: true additionalInfo: type: array items: type: object properties: _id: type: string description: ID of the record. example: 6710c9a2b4d3e80012c9a1e6 key: type: string description: Name of the information. example: Pedido value: type: string description: Value of the information. example: '1234' required: - key - value description: >- A key / value pair the recipient's QR code attached to the Pix. description: >- Key / value pairs the recipient's QR code attached. Pix sent only. linkedTransactions: type: array items: type: object properties: _id: type: string description: ID of the link. Absent on some older links. example: 66f2a7e9b4d3e80012c9a114 transactionId: type: string description: ID of the related transaction. example: 66f2a7e9b4d3e80012c9a113 linkType: type: string description: >- How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side. example: CLEARING_DEBITED_BY createdAt: type: string description: When the link was created. example: '2026-11-03T09:12:40.000Z' updatedAt: type: string description: When the link last changed. example: '2026-11-03T09:12:40.000Z' required: - transactionId - linkType - createdAt - updatedAt description: >- A link between this transaction and a related one (its settlement, a refund, …). description: Related transactions. Pix sent only. required: - creditParty - debitParty - receipt - txnCurrency - txnOriginalAmount - txnDiscountAmount - txnFineAmount - txnInterestAmount - txnPurchaseAmount - txnWithdrawalAmount - txnUpdatedAmount - txnUpdatedAmountAuthorized - initiationType description: Details of a Pix sent or received. boletoTransaction: type: object properties: _id: type: string description: >- ID of the details record. Absent on some older transactions. example: 6718b0c4b4d3e80012c9a2a8 internalBoletoId: type: string description: >- ID of the boleto payment behind a boleto PAID — use it with the boleto payment routes. example: 6718b0c4b4d3e80012c9a2a7 barcode: type: string description: >- The boleto's barcode (44 digits) or digitable line (47 or 48 digits). example: '34191790010104351004791020150008291070026000' txnCurrency: type: string description: >- Currency, as an ISO 4217 numeric code: always `986` (Brazilian real). example: '986' txnOriginalAmount: type: number description: Amount on the boleto, in cents. example: 26000 txnDiscountAmount: type: number description: Discount, in cents. example: 0 txnFineAmount: type: number description: Fine, in cents. example: 0 txnInterestAmount: type: number description: Interest, in cents. example: 0 txnUpdatedAmount: type: number description: >- Amount due after discount, fine and interest, in cents. example: 26000 txnUpdatedAmountAuthorized: type: number description: Amount authorized, in cents. example: 26000 txnMaxAmount: type: number description: Most the boleto accepts, in cents. example: 26000 txnMinAmount: type: number description: Least the boleto accepts, in cents. example: 26000 receipt: type: object properties: authentication: type: string nullable: true description: Bank authentication of the payment. Can be `null`. example: null authenticationApi: type: string description: Authentication code of the payment. example: A1B2C3D4E5F60718293A4B5C6D7E8F90 receipt: type: string nullable: true description: Payment receipt. Can be `null`. example: null description: Authentication of the payment, once paid. confirmedAt: type: string nullable: true description: When the payment was confirmed. Can be `null`. example: '2026-10-23T14:02:11.000Z' format: date-time dueDate: type: string description: Due date of the boleto. example: '2026-10-25T00:00:00.000Z' format: date-time finalPaymentAt: type: string description: Last day the boleto can be paid. example: '2026-11-24T00:00:00.000Z' format: date-time settleAt: type: string description: When the payment settles. example: '2026-10-23T00:00:00.000Z' format: date-time issuer: type: string description: Bank that issued the boleto. example: Banco Itaú payee: type: string nullable: true description: Name of the payee (who is paid). Can be `null`. example: Papelaria Central Ltda payeeDocument: type: string nullable: true description: CPF or CNPJ of the payee. Can be `null`. example: '12345678000190' payer: type: string nullable: true description: Name of the payer. Can be `null`. example: Acme Comércio Ltda payerDocument: type: string nullable: true description: CPF or CNPJ of the payer. Can be `null`. example: '98765432000110' type: type: string description: >- `GENERIC` (a bank boleto) or `UTILITY_BILL` (a utility or tax bill). example: GENERIC linkedTransactions: type: array items: type: object properties: _id: type: string description: ID of the link. Absent on some older links. example: 66f2a7e9b4d3e80012c9a114 transactionId: type: string description: ID of the related transaction. example: 66f2a7e9b4d3e80012c9a113 linkType: type: string description: >- How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side. example: CLEARING_DEBITED_BY createdAt: type: string description: When the link was created. example: '2026-11-03T09:12:40.000Z' updatedAt: type: string description: When the link last changed. example: '2026-11-03T09:12:40.000Z' required: - transactionId - linkType - createdAt - updatedAt description: >- A link between this transaction and a related one (its settlement, a refund, …). description: Related transactions. required: - internalBoletoId - barcode - txnCurrency - txnOriginalAmount - txnDiscountAmount - txnFineAmount - txnInterestAmount - txnUpdatedAmount - txnUpdatedAmountAuthorized - txnMaxAmount - txnMinAmount - issuer - type - linkedTransactions description: Details of a boleto paid or received. tedTransaction: type: object properties: _id: type: string description: ID of the details record. example: 6722a0b1b4d3e80012c9a3c0 internalTedId: type: string description: >- ID of the TED behind the transaction — use it with the TED routes. example: 6722a07eb4d3e80012c9a3bf creditParty: type: object properties: _id: type: string description: ID of the record. example: 6722a0b1b4d3e80012c9a3c1 name: type: string description: Name of the account holder. example: Papelaria Central Ltda personName: type: string description: Name of the person, when the holder is one. example: João Silva document: type: string description: CPF or CNPJ of the account holder, digits only. example: '12345678000190' bankCode: type: string description: Bank code (COMPE, 3 digits). example: '341' branch: type: string description: Bank branch. example: '0001' accountNumber: type: string description: Account number. example: '123456' accountType: type: string description: Type of the account, such as `CACC` (checking). example: CACC description: Who received the money. Can be an empty object. debitParty: type: object properties: _id: type: string description: ID of the record. example: 6722a0b1b4d3e80012c9a3c1 name: type: string description: Name of the account holder. example: Papelaria Central Ltda personName: type: string description: Name of the person, when the holder is one. example: João Silva document: type: string description: CPF or CNPJ of the account holder, digits only. example: '12345678000190' bankCode: type: string description: Bank code (COMPE, 3 digits). example: '341' branch: type: string description: Bank branch. example: '0001' accountNumber: type: string description: Account number. example: '123456' accountType: type: string description: Type of the account, such as `CACC` (checking). example: CACC description: Who paid. description: type: string description: Description of the TED. example: Pagamento fornecedor rolledback: type: object properties: reason: type: string description: Reason given for the return. example: Conta inexistente reasonCode: type: string description: Code of the reason. example: AC03 description: Why the TED was returned, when it was. txnCurrency: type: string description: >- Currency, as an ISO 4217 numeric code: always `986` (Brazilian real). example: '986' txnAmount: type: number description: Amount, in cents. example: 120000 txnAmountAuthorized: type: number description: Amount authorized, in cents. example: 120000 linkedTransactions: type: array items: type: object properties: _id: type: string description: ID of the link. Absent on some older links. example: 66f2a7e9b4d3e80012c9a114 transactionId: type: string description: ID of the related transaction. example: 66f2a7e9b4d3e80012c9a113 linkType: type: string description: >- How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side. example: CLEARING_DEBITED_BY createdAt: type: string description: When the link was created. example: '2026-11-03T09:12:40.000Z' updatedAt: type: string description: When the link last changed. example: '2026-11-03T09:12:40.000Z' required: - transactionId - linkType - createdAt - updatedAt description: >- A link between this transaction and a related one (its settlement, a refund, …). description: Related transactions. required: - txnCurrency - txnAmount - txnAmountAuthorized description: Details of a TED sent. p2pTransaction: type: object properties: _id: type: string description: >- ID of the details record. Absent on some older transactions. example: 6720f1a3b4d3e80012c9a3b2 txnCurrency: type: string description: >- Currency, as an ISO 4217 numeric code: always `986` (Brazilian real). example: '986' txnAmount: type: number description: Amount transferred, in cents. example: 50000 txnAmountAuthorized: type: number description: Amount authorized, in cents. example: 50000 payeeAccountId: type: string description: ID of the account that received the money. example: 66f2a1c7b4d3e80012c9a0b4 payeeWalletId: type: string description: ID of the wallet that received the money. example: 66f2a3d1b4d3e80012c9a0d3 payerAccountId: type: string description: ID of the account the money left. example: 66f2a1c7b4d3e80012c9a0b4 payerWalletId: type: string description: ID of the wallet the money left. example: 66f2a3d1b4d3e80012c9a0d2 linkedTransactions: type: array items: type: object properties: _id: type: string description: ID of the link. Absent on some older links. example: 66f2a7e9b4d3e80012c9a114 transactionId: type: string description: ID of the related transaction. example: 66f2a7e9b4d3e80012c9a113 linkType: type: string description: >- How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side. example: CLEARING_DEBITED_BY createdAt: type: string description: When the link was created. example: '2026-11-03T09:12:40.000Z' updatedAt: type: string description: When the link last changed. example: '2026-11-03T09:12:40.000Z' required: - transactionId - linkType - createdAt - updatedAt description: >- A link between this transaction and a related one (its settlement, a refund, …). description: Related transactions. required: - txnCurrency - txnAmount - txnAmountAuthorized - payeeAccountId - payerAccountId description: Details of a transfer between wallets at Portão 3. feeTransaction: type: object properties: _id: type: string description: >- ID of the details record. Absent on some older transactions. example: 66f2a7e9b4d3e80012c9a117 linkedTransactions: type: array items: type: object properties: _id: type: string description: ID of the link. Absent on some older links. example: 66f2a7e9b4d3e80012c9a114 transactionId: type: string description: ID of the related transaction. example: 66f2a7e9b4d3e80012c9a113 linkType: type: string description: >- How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side. example: CLEARING_DEBITED_BY createdAt: type: string description: When the link was created. example: '2026-11-03T09:12:40.000Z' updatedAt: type: string description: When the link last changed. example: '2026-11-03T09:12:40.000Z' required: - transactionId - linkType - createdAt - updatedAt description: >- A link between this transaction and a related one (its settlement, a refund, …). description: >- Related transactions, such as the purchase the fee was charged on. description: type: string description: Description of the fee. example: Tarifa de compra internacional txnCurrency: type: string description: Currency, as an ISO 4217 numeric code. example: '986' txnAmount: type: number description: Amount of the fee, in cents of `txnCurrency`. example: 664 txnAmountAuthorized: type: number description: Amount authorized, in cents of `txnCurrency`. example: 664 external: type: object properties: invoiceId: type: string description: ID of the invoice the fee belongs to. example: 66f2a8a1b4d3e80012c9a120 dealId: type: string description: ID of the deal the fee belongs to. example: 66f2a8a1b4d3e80012c9a121 contractId: type: string description: >- ID of the contract the fee belonged to, on older fees. example: 66f2a8a1b4d3e80012c9a122 description: References of the fee to what it was charged for. creditParty: type: object properties: _id: type: string description: ID of the party record. example: 66f2a7e9b4d3e80012c9a118 type: type: string description: >- `LOCAL` (a wallet at Portão 3) or `REMOTE_PIX` (a Pix key elsewhere). example: LOCAL local: type: object properties: realmId: type: string description: ID of the wallet's realm. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b organizationId: type: string description: ID of the wallet's organization. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 accountId: type: string description: ID of the wallet's account. example: 66f2a1c7b4d3e80012c9a0b4 walletId: type: string description: ID of the wallet. example: 66f2a3d1b4d3e80012c9a0d2 description: The wallet, for a `LOCAL` party. remote: type: object properties: pixKey: type: string description: The Pix key. example: financeiro@acme.com.br pixDict: type: string description: >- Type of the Pix key, such as `EMAIL` or `CNPJ`. example: EMAIL description: The Pix key, for a `REMOTE_PIX` party. required: - type description: Where the fee goes. debitParty: type: object properties: _id: type: string description: ID of the party record. example: 66f2a7e9b4d3e80012c9a118 type: type: string description: >- `LOCAL` (a wallet at Portão 3) or `REMOTE_PIX` (a Pix key elsewhere). example: LOCAL local: type: object properties: realmId: type: string description: ID of the wallet's realm. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b organizationId: type: string description: ID of the wallet's organization. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 accountId: type: string description: ID of the wallet's account. example: 66f2a1c7b4d3e80012c9a0b4 walletId: type: string description: ID of the wallet. example: 66f2a3d1b4d3e80012c9a0d2 description: The wallet, for a `LOCAL` party. remote: type: object properties: pixKey: type: string description: The Pix key. example: financeiro@acme.com.br pixDict: type: string description: >- Type of the Pix key, such as `EMAIL` or `CNPJ`. example: EMAIL description: The Pix key, for a `REMOTE_PIX` party. required: - type description: Where the fee is paid from. required: - txnCurrency - txnAmount - txnAmountAuthorized description: Details of a fee. enrichment: type: object properties: _id: type: string description: ID of the record. Absent on most transactions. example: 66f2a7e9b4d3e80012c9a116 merchant: type: string nullable: true description: >- Recognized merchant brand, such as `AMAZON` or `UBER`. `null` when none is recognized. example: null category: type: string nullable: true description: >- Spending category of the purchase, such as `ADVERTISING_AND_MARKETING`, `AIRLINES_AND_TRAVEL`, `FOOD_AND_DINING`, `OFFICE_SUPPLIES` or `UNCATEGORIZED`. `null` when it couldn't be determined. example: OFFICE_SUPPLIES rulesVersion: type: number description: Version of the recognition rules that produced this. example: 3 required: - merchant - category - rulesVersion description: >- Merchant and spending category recognized for a card purchase. Absent on older ones. customFields: anyOf: - type: object additionalProperties: {} - type: array items: type: object additionalProperties: {} description: >- Values of the organization's transaction custom fields, keyed by each field's `slug`. Absent when the transaction has none. On a few older transactions it is still an array of custom field entries, from before values were keyed by slug. --- Example: `{"cost-center":"CC-1020"}` example: cost-center: CC-1020 spendReview: type: object properties: status: type: string enum: - PENDING_APPROVAL - APPROVED - DECLINED description: >- `PENDING_APPROVAL` (waiting for the approvers), `APPROVED` or `DECLINED`. example: PENDING_APPROVAL policyId: type: string description: ID of the business policy that governs the review. example: 3f2e1d0c-9b8a-4c7d-8e6f-5a4b3c2d1e0f policyRequestId: type: string description: ID of the approval request. example: 4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a autoApproved: type: boolean description: >- `true` when the policy approved it without an approver. example: false requester: type: object properties: userId: type: string description: ID of the user. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 name: type: string description: >- Name of the user (their e-mail or ID when they have none). example: Mariana Costa email: type: string description: E-mail of the user. example: mariana.costa@acme.com.br required: - userId - name - email description: Who submitted the transaction for review. requestedAt: type: string description: When it was submitted. example: '2026-11-02T18:02:11.000Z' format: date-time approvalExpiresAt: type: string description: >- Deadline for the approvers: a month after it was submitted. A review still pending then ends `DECLINED` with `declineOutcome` `EXPIRED`. example: '2026-12-02T18:02:11.000Z' format: date-time decidedAt: type: string description: When it was approved or declined. example: '2026-11-03T10:15:00.000Z' format: date-time declineOutcome: type: string enum: - DENIED - CANCELED - EXPIRED description: >- Why a `DECLINED` review ended: `DENIED` (an approver refused it), `CANCELED` (the request was cancelled) or `EXPIRED` (nobody decided in time). example: DENIED decisionReason: type: string description: >- The approver's reason, when one was given (up to 500 characters). example: Falta o comprovante required: - status - policyId - policyRequestId - requester - requestedAt description: >- The expense review, once the transaction was submitted for approval. spendReviewSubmissionLeaseUntil: type: string description: >- Until when a submission for review is being processed. Absent otherwise. example: '2026-11-02T18:07:11.000Z' format: date-time receipts: type: string description: Receipt attached to an older transaction. example: https://files.example.com/receipt.pdf external: type: object properties: transactionId: type: string description: Identifier of a card transaction at the card issuer. example: 0F1E2D3C4B5A69788796A5B4C3D2E1F0 pixId: type: string description: Identifier of the Pix at the bank. example: b6c2a1f0-3d4e-4f5a-8b9c-0d1e2f3a4b5c paymentId: type: string description: Identifier of the payment at the bank. example: c7d3b2a1-4e5f-4a6b-9c0d-1e2f3a4b5c6d boletoId: type: string description: Identifier of the boleto payment at the bank. example: d8e4c3b2-5f6a-4b7c-8d1e-2f3a4b5c6d7e tedId: type: string description: Identifier of the TED at the bank. example: e9f5d4c3-6a7b-4c8d-9e2f-3a4b5c6d7e8f description: >- References of the transaction outside its ledger record. Absent on a transfer between wallets that failed. processingType: type: string enum: - INSTANT - DELAYED description: >- `INSTANT` (processed as it happened) or `DELAYED` (processed later, such as a payment scheduled for a later day). Absent on a few older transactions. example: INSTANT internalErrorCode: type: string description: >- Why a transaction that moved no money failed, such as `INSUFFICIENT_FUNDS`, `LIMIT_EXCEEDED` or `REJECTED_BY_ANTIFRAUD_PREVENTION_RULES`. example: LIMIT_EXCEEDED createdAt: type: string description: When the record was created. example: '2026-10-17T13:43:01.000Z' format: date-time updatedAt: type: string description: When the record last changed. example: '2026-10-17T13:43:01.000Z' format: date-time __v: type: number description: Version of the record. Absent on a few older ones. example: 0 paymentInfo: anyOf: - type: object properties: status: type: string description: >- Status of the Pix payment, such as `PAID`, `CONFIRMED` (sent, waiting for the bank), `FAILED` or `REFUNDED`. example: PAID external: type: object properties: pixId: type: string description: >- ID of the payment at Portão 3's banking partner. You never need it to call this API: identify the payment by its `_id`. Absent on some older payments. example: c7810c30-971f-4e84-8feb-b7819087d4de format: uuid platformUserId: type: string description: >- ID of the user who created the payment, on some older payments only. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 description: References of the payment at the bank. required: - status description: What the Pix payment behind a Pix sent says about it. nullable: true - type: object properties: status: type: string description: >- Status of the boleto payment, such as `PAID`, `FAILED` or `REFUNDED`. example: PAID external: type: object properties: boletoId: type: string description: The bank's ID of the payment. example: 2f8d6c1a-4b3e-4a5d-9c7b-1e0f2a3b4c5d format: uuid platformUserId: type: string description: >- ID of the user who created the payment, on some older payments only. Use `requester`. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 description: References of the payment at the bank. required: - status description: >- What the boleto payment behind a boleto paid says about it. nullable: true - type: object properties: panMasked: type: string description: The card's number, masked. example: 533612******1234 status: type: string description: >- Status of the card: `ACTIVE`, `BLOCKED` or `CANCELLED`. example: ACTIVE required: - panMasked - status description: The card behind a card transaction. nullable: true - type: object additionalProperties: {} nullable: true description: >- On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction. required: - _id - accountId - availableBalanceBefore - billingAmount - billingAmountAuthorized - createdAt - effectiveAt - environment - financialImpactType - msgType - organizationId - realmId - responseCode - txnType - updatedAt - walletId description: A transaction, with what the payment or card behind it says. '403': description: >- `FORBIDDEN_WALLET` — You are not an admin of the organization and the wallet is not shared with you. 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. `TRANSACTION_NOT_FOUND` — The wallet has no transaction 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 - TRANSACTION_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 or query parameter is invalid; `fields` lists each one. 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 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: details message: 'Invalid option: expected one of "true"|"false"' code: DETAILS_ONE_OF ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.