# Portão 3: English API Reference ## API Reference ### Overview - [API Reference](https://developers.portao3.com.br/api-reference/overview.md): How the Portão 3 API reference is organized and how to read it - [Pagination](https://developers.portao3.com.br/api-reference/pagination.md): How list endpoints return their results one page at a time ### Identity #### Authentication - [Sign in](https://developers.portao3.com.br/api-reference/identity/authentication/sign-in.md): Exchanges your API client's credentials for an access token. #### Current User - [Get the current API client](https://developers.portao3.com.br/api-reference/identity/current-user/get-the-current-api-client.md): Returns the API client the access token belongs to, with the organizations it can act on. #### Custom Fields - [List custom fields](https://developers.portao3.com.br/api-reference/identity/custom-fields/list-custom-fields.md): Lists the organization's custom-field definitions, newest first. - [Create a custom field](https://developers.portao3.com.br/api-reference/identity/custom-fields/create-a-custom-field.md): Creates a custom-field definition for the organization. - [Get a custom field](https://developers.portao3.com.br/api-reference/identity/custom-fields/get-a-custom-field.md): Returns one custom-field definition by ID, whether active or deactivated. - [Update a custom field](https://developers.portao3.com.br/api-reference/identity/custom-fields/update-a-custom-field.md): Updates a custom-field definition. Only the properties you send change. - [Activate a custom field](https://developers.portao3.com.br/api-reference/identity/custom-fields/activate-a-custom-field.md): Sets the field's `status` to `ACTIVE`, so it is rendered and validated again on the entities in `location`. Idempotent: an already-active field is returned unchanged. No request body. - [Deactivate a custom field](https://developers.portao3.com.br/api-reference/identity/custom-fields/deactivate-a-custom-field.md): Sets the field's `status` to `DEACTIVATED`: it stops being shown and required on new entries, while values already stored remain readable. Definitions are never deleted — this is the way to retire one. Idempotent: an already-deactivated field is returned unchanged. No request body. #### API Clients - [List the realm's API clients](https://developers.portao3.com.br/api-reference/identity/api-clients/list-the-realms-api-clients.md): Lists the API clients of your realm across all of its organizations, including deactivated ones, newest first by default. - [List an organization's API clients](https://developers.portao3.com.br/api-reference/identity/api-clients/list-an-organizations-api-clients.md): Lists an organization's API clients, newest first by default. Your API client must have access to the organization. - [Create an API client](https://developers.portao3.com.br/api-reference/identity/api-clients/create-an-api-client.md): Creates an API client: the `clientId` and `clientSecret` your systems exchange for an access token at `POST /auth/sign-in`. - [Deactivate an API client](https://developers.portao3.com.br/api-reference/identity/api-clients/deactivate-an-api-client.md): Deactivates an API client: it can no longer get access tokens, and requests made with tokens it already holds are rejected. #### Users - [List users](https://developers.portao3.com.br/api-reference/identity/users/list-users.md): Lists the users of your realm. - [Create a user](https://developers.portao3.com.br/api-reference/identity/users/create-a-user.md): Creates a user in your realm and e-mails them an invitation to complete onboarding. - [Get a user](https://developers.portao3.com.br/api-reference/identity/users/get-a-user.md): Returns a user of your realm. - [Update a user](https://developers.portao3.com.br/api-reference/identity/users/update-a-user.md): Updates a user's profile, and adds them to organizations or changes their level in the organizations they belong to. - [Activate a user](https://developers.portao3.com.br/api-reference/identity/users/activate-a-user.md): Restores access for a deactivated user, so they can sign in again. - [Deactivate a user](https://developers.portao3.com.br/api-reference/identity/users/deactivate-a-user.md): Removes a user's access: they can no longer sign in, and requests made with their existing tokens are rejected. - [List organization users](https://developers.portao3.com.br/api-reference/identity/users/list-organization-users.md): Lists the users of an organization. - [Assign a user to an organization](https://developers.portao3.com.br/api-reference/identity/users/assign-a-user-to-an-organization.md): Adds a user to an organization of your realm and creates their personal wallet in it. - [Revoke a user from an organization](https://developers.portao3.com.br/api-reference/identity/users/revoke-a-user-from-an-organization.md): Removes a user from an organization and blocks their personal wallet in it. - [Export organization users](https://developers.portao3.com.br/api-reference/identity/users/export-organization-users.md): Exports the organization's users as a CSV or XLSX file. #### Organizations - [Get an organization](https://developers.portao3.com.br/api-reference/identity/organizations/get-an-organization.md): Returns one of your organizations: its registration data, address, shareholders and account reference. #### Groups - [List groups](https://developers.portao3.com.br/api-reference/identity/groups/list-groups.md): Lists the organization's groups, sorted by name, with each member's details. - [Create a group](https://developers.portao3.com.br/api-reference/identity/groups/create-a-group.md): Creates a group of users in the organization, to use as an approver in business policies. - [Get a group](https://developers.portao3.com.br/api-reference/identity/groups/get-a-group.md): Returns a group with each member's details. Archived groups are returned too, with `status` `ARCHIVED`. - [Update a group](https://developers.portao3.com.br/api-reference/identity/groups/update-a-group.md): Changes a group's name, description or members. Fields you omit keep their current value. - [Archive a group](https://developers.portao3.com.br/api-reference/identity/groups/archive-a-group.md): Archives a group: it leaves the group list, can no longer be changed, and can no longer be used as an approver in business policies. #### Realms - [Get your realm](https://developers.portao3.com.br/api-reference/identity/realms/get-your-realm.md): Returns your realm, the tenant that holds all of your organizations, with its ID and name. ### Banking #### Accounts - [/realms/{realmId}/account-limits](https://developers.portao3.com.br/api-reference/banking/accounts/realms-account-limits.md) - [/realms/{realmId}/accounts](https://developers.portao3.com.br/api-reference/banking/accounts/realms-accounts.md) - [/realms/{realmId}/organizations/{organizationId}/account-limits](https://developers.portao3.com.br/api-reference/banking/accounts/realms-organizations-account-limits.md) - [/realms/{realmId}/organizations/{organizationId}/accounts](https://developers.portao3.com.br/api-reference/banking/accounts/realms-organizations-accounts.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}](https://developers.portao3.com.br/api-reference/banking/accounts/realms-organizations-accounts-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits](https://developers.portao3.com.br/api-reference/banking/accounts/realms-organizations-accounts-account-limits.md) #### Wallets - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/inquire-balance](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-inquire-balance.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets-report](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-report.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-3.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-4.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-block.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-clear-balance.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/fee](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-fee.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/inquire-balance](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-inquire-balance.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-reversals.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-schedules.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transaction-limits.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transaction-limits-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transfer-requests.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transfer-requests-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transfer-requests-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transfer-requests-3.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transfer-requests-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transfer-requests-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-transfer-requests-request.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-accounts-wallets-unblock.md) - [/realms/{realmId}/organizations/{organizationId}/wallets](https://developers.portao3.com.br/api-reference/banking/wallets/realms-organizations-wallets.md) - [/realms/{realmId}/wallets](https://developers.portao3.com.br/api-reference/banking/wallets/realms-wallets.md) #### Cards - [/realms/{realmId}/card-limit-rule](https://developers.portao3.com.br/api-reference/banking/cards/realms-card-limit-rule.md) - [/realms/{realmId}/cards](https://developers.portao3.com.br/api-reference/banking/cards/realms-cards.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-card-limit.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-card-limit-rule.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-card-limit-rule-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-card-limit-rule-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-card-limit-rule-3.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-card-limit-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-card-limit-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-cards.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-threeds.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-threedssubmit.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-3.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-block.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-card-limit.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-details.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-pin.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-transactions.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-transactions-summary.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-transactionsexport.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-accounts-wallets-cards-unblock.md) - [/realms/{realmId}/organizations/{organizationId}/card-limit-rule](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-card-limit-rule.md) - [/realms/{realmId}/organizations/{organizationId}/cards](https://developers.portao3.com.br/api-reference/banking/cards/realms-organizations-cards.md) #### PIX - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-accounts-pix.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-accounts-wallets-pix.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-accounts-wallets-pix-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-accounts-wallets-pix-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-accounts-wallets-pix-3.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-accounts-wallets-pix-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-accounts-wallets-pix-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-accounts-wallets-pix-request.md) - [/realms/{realmId}/organizations/{organizationId}/pix](https://developers.portao3.com.br/api-reference/banking/pix/realms-organizations-pix.md) - [/realms/{realmId}/pix](https://developers.portao3.com.br/api-reference/banking/pix/realms-pix.md) #### PIX Keys (DICT) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-accounts-pix-dict.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-accounts-wallets-pix-dict.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-accounts-wallets-pix-dict-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-accounts-wallets-pix-dict-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-accounts-wallets-pix-dict-remove.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-accounts-wallets-pix-dict-request-otp.md) - [/realms/{realmId}/organizations/{organizationId}/pix-dict](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-pix-dict.md) - [/realms/{realmId}/organizations/{organizationId}/pix-dict-claim](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-pix-dict-claim.md) - [/realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-pix-dict-claim-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-organizations-pix-dict-claim-confirm.md) - [/realms/{realmId}/pix-dict](https://developers.portao3.com.br/api-reference/banking/pix-keys-dict/realms-pix-dict.md) #### PIX Charges - [/pix-billing/{pixBillingId}](https://developers.portao3.com.br/api-reference/banking/pix-charges/pix-billing.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing](https://developers.portao3.com.br/api-reference/banking/pix-charges/realms-organizations-accounts-pix-billing.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing](https://developers.portao3.com.br/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing](https://developers.portao3.com.br/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}](https://developers.portao3.com.br/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel](https://developers.portao3.com.br/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/pix-billing](https://developers.portao3.com.br/api-reference/banking/pix-charges/realms-organizations-pix-billing.md) - [/realms/{realmId}/pix-billing](https://developers.portao3.com.br/api-reference/banking/pix-charges/realms-pix-billing.md) #### PIX Automatic - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-pix-billing-automatic.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automaticschedules.md) - [/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic.md) - [/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic-history.md) - [/realms/{realmId}/pix-billing-automatic](https://developers.portao3.com.br/api-reference/banking/pix-automatic/realms-pix-billing-automatic.md) #### PIX Initiation (Open Finance) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-pix-billing-initiation-request.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items-1.md) - [/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-organizations-pix-billing-initiation-request.md) - [/realms/{realmId}/pix-billing-initiation-request](https://developers.portao3.com.br/api-reference/banking/pix-initiation-open-finance/realms-pix-billing-initiation-request.md) #### PIX Infractions (MED) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction](https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/realms-organizations-accounts-pix-infraction.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction](https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/realms-organizations-accounts-wallets-pix-infraction.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction](https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/realms-organizations-accounts-wallets-transactions-pix-infraction.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction](https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/realms-organizations-accounts-wallets-transactions-pix-infraction-1.md) - [/realms/{realmId}/organizations/{organizationId}/pix-infraction](https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/realms-organizations-pix-infraction.md) - [/realms/{realmId}/pix-infraction](https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/realms-pix-infraction.md) #### Boleto - [/realms/{realmId}/boleto](https://developers.portao3.com.br/api-reference/banking/boleto/realms-boleto.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-accounts-boleto.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-accounts-wallets-boleto.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-accounts-wallets-boleto-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-accounts-wallets-boleto-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-accounts-wallets-boleto-3.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/cancel](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-accounts-wallets-boleto-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/confirm](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-accounts-wallets-boleto-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/request](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-accounts-wallets-boleto-request.md) - [/realms/{realmId}/organizations/{organizationId}/boleto](https://developers.portao3.com.br/api-reference/banking/boleto/realms-organizations-boleto.md) #### Boleto Charges - [/realms/{realmId}/boleto-billing](https://developers.portao3.com.br/api-reference/banking/boleto-charges/realms-boleto-billing.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing](https://developers.portao3.com.br/api-reference/banking/boleto-charges/realms-organizations-accounts-boleto-billing.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing](https://developers.portao3.com.br/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing](https://developers.portao3.com.br/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}](https://developers.portao3.com.br/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf](https://developers.portao3.com.br/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-downloadpdf.md) - [/realms/{realmId}/organizations/{organizationId}/boleto-billing](https://developers.portao3.com.br/api-reference/banking/boleto-charges/realms-organizations-boleto-billing.md) #### TED - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted](https://developers.portao3.com.br/api-reference/banking/ted/realms-organizations-accounts-ted.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted](https://developers.portao3.com.br/api-reference/banking/ted/realms-organizations-accounts-wallets-ted.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted](https://developers.portao3.com.br/api-reference/banking/ted/realms-organizations-accounts-wallets-ted-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}](https://developers.portao3.com.br/api-reference/banking/ted/realms-organizations-accounts-wallets-ted-2.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel](https://developers.portao3.com.br/api-reference/banking/ted/realms-organizations-accounts-wallets-ted-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm](https://developers.portao3.com.br/api-reference/banking/ted/realms-organizations-accounts-wallets-ted-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/ted](https://developers.portao3.com.br/api-reference/banking/ted/realms-organizations-ted.md) - [/realms/{realmId}/ted](https://developers.portao3.com.br/api-reference/banking/ted/realms-ted.md) #### Transfers - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/external-transfers](https://developers.portao3.com.br/api-reference/banking/transfers/realms-organizations-accounts-wallets-external-transfers.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfers-p2p](https://developers.portao3.com.br/api-reference/banking/transfers/realms-organizations-accounts-wallets-transfers-p2p.md) #### Transactions - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-aggregated-transactions.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-transactions.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-transactions-async.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-transactions-summary.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-summary.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-custom-fields.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-reversals.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-reversals-1.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-reversals-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-reversals-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-spend-review.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request](https://developers.portao3.com.br/api-reference/banking/transactions/realms-organizations-accounts-wallets-transactions-spend-reviewrequest.md) #### Cashback - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback](https://developers.portao3.com.br/api-reference/banking/cashback/realms-organizations-accounts-wallets-cashback.md) - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance](https://developers.portao3.com.br/api-reference/banking/cashback/realms-organizations-accounts-wallets-cashback-balance.md) #### Currency Codes - [/currency-codes](https://developers.portao3.com.br/api-reference/banking/currency-codes/currency-codes.md) #### Reversals - [/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals](https://developers.portao3.com.br/api-reference/banking/reversals/realms-organizations-accounts-reversals.md) - [/realms/{realmId}/organizations/{organizationId}/reversals](https://developers.portao3.com.br/api-reference/banking/reversals/realms-organizations-reversals.md) - [/realms/{realmId}/reversals](https://developers.portao3.com.br/api-reference/banking/reversals/realms-reversals.md) ### Billing #### Contracts - [Deprecated — List contracts](https://developers.portao3.com.br/api-reference/billing/contracts/deprecated-—-list-contracts.md): Deprecated: use `GET .../deals`, filtering by `debitPartyOrgIds` or `debitPartyDocuments`; contracts are being removed. - [Deprecated — Create a contract](https://developers.portao3.com.br/api-reference/billing/contracts/deprecated-—-create-a-contract.md): Deprecated: contracts are being removed; there is no replacement. - [Deprecated — Get a contract](https://developers.portao3.com.br/api-reference/billing/contracts/deprecated-—-get-a-contract.md): Deprecated: use `GET .../deals`, filtering by `debitPartyOrgIds` or `debitPartyDocuments`; contracts are being removed. - [Deprecated — Update a contract](https://developers.portao3.com.br/api-reference/billing/contracts/deprecated-—-update-a-contract.md): Deprecated: contracts are being removed; there is no replacement. - [Deprecated — Terminate a contract](https://developers.portao3.com.br/api-reference/billing/contracts/deprecated-—-terminate-a-contract.md): Deprecated: contracts are being removed; there is no replacement. #### Deals - [List deals](https://developers.portao3.com.br/api-reference/billing/deals/list-deals.md): Lists the deals of your organization, newest first by default. - [Export deals](https://developers.portao3.com.br/api-reference/billing/deals/export-deals.md): Exports the deals of your organization as a CSV or XLSX file. - [Get a deal](https://developers.portao3.com.br/api-reference/billing/deals/get-a-deal.md): Returns one deal of your organization, with its customer, totals and invoices. - [Create a deal](https://developers.portao3.com.br/api-reference/billing/deals/create-a-deal.md): Creates a deal: what your organization charges a payer for, how it is paid and when. - [Update a deal](https://developers.portao3.com.br/api-reference/billing/deals/update-a-deal.md): Changes an open deal: its description, dates, payment method, closing and due days, or parties. Send only what changes. - [Cancel a deal](https://developers.portao3.com.br/api-reference/billing/deals/cancel-a-deal.md): Cancels an open deal: it stops creating invoices. - [Deprecated — List a contract's deals](https://developers.portao3.com.br/api-reference/billing/deals/deprecated-—-list-a-contracts-deals.md): Deprecated: use `GET .../deals`, filtering by `debitPartyOrgIds` or `debitPartyDocuments`; contracts are being removed. - [Deprecated — Create a deal](https://developers.portao3.com.br/api-reference/billing/deals/deprecated-—-create-a-deal.md): Deprecated: use `POST .../deals`; contracts are being removed. - [Deprecated — Get a contract's deal](https://developers.portao3.com.br/api-reference/billing/deals/deprecated-—-get-a-contracts-deal.md): Deprecated: use `GET .../deals/{dealId}`; contracts are being removed. - [Deprecated — Update a deal](https://developers.portao3.com.br/api-reference/billing/deals/deprecated-—-update-a-deal.md): Deprecated: use `PUT .../deals/{dealId}`; contracts are being removed. - [Deprecated — Cancel a deal](https://developers.portao3.com.br/api-reference/billing/deals/deprecated-—-cancel-a-deal.md): Deprecated: use `POST .../deals/{dealId}/cancel`; contracts are being removed. #### Invoices - [List an organization's invoices](https://developers.portao3.com.br/api-reference/billing/invoices/list-an-organizations-invoices.md): Lists the invoices of your organization, newest first by default. - [List a deal's invoices](https://developers.portao3.com.br/api-reference/billing/invoices/list-a-deals-invoices.md): Lists the invoices of one deal, newest first by default. - [Create an invoice](https://developers.portao3.com.br/api-reference/billing/invoices/create-an-invoice.md): Creates an invoice for a deal of your organization. - [Get an invoice](https://developers.portao3.com.br/api-reference/billing/invoices/get-an-invoice.md): Returns one invoice, with its customer, totals, statements and products. - [Update an invoice](https://developers.portao3.com.br/api-reference/billing/invoices/update-an-invoice.md): Changes an open invoice your organization issued. - [Cancel an invoice](https://developers.portao3.com.br/api-reference/billing/invoices/cancel-an-invoice.md): Cancels a closed invoice your organization issued. - [Export invoices](https://developers.portao3.com.br/api-reference/billing/invoices/export-invoices.md): Exports the invoices your organization issued as a CSV or XLSX file. - [Deprecated — List a contract's invoices](https://developers.portao3.com.br/api-reference/billing/invoices/deprecated-—-list-a-contracts-invoices.md): Deprecated: use `GET .../invoices`, filtering by `debitPartyOrgIds` or `debitPartyDocuments`; contracts are being removed. - [Deprecated — List a deal's invoices](https://developers.portao3.com.br/api-reference/billing/invoices/deprecated-—-list-a-deals-invoices.md): Deprecated: use `GET .../deals/{dealId}/invoices`; contracts are being removed. #### Invoice Entries - [List an invoice's entries](https://developers.portao3.com.br/api-reference/billing/invoice-entries/list-an-invoices-entries.md): Lists the entries of an invoice, newest first: the products and services the payer purchased, which add up to the invoice amount. - [Add entries to an invoice](https://developers.portao3.com.br/api-reference/billing/invoice-entries/add-entries-to-an-invoice.md): Adds charges (line items) to an open invoice your organization issued: an on-demand charge for the invoice's period, on top of the entries generated from the deal's products. - [Get an entry](https://developers.portao3.com.br/api-reference/billing/invoice-entries/get-an-entry.md): Returns one entry of an invoice your organization issued. - [Delete an entry](https://developers.portao3.com.br/api-reference/billing/invoice-entries/delete-an-entry.md): Deletes an entry of an open invoice your organization issued, and takes its amount off the invoice amount. #### Invoice Statements - [List statements](https://developers.portao3.com.br/api-reference/billing/invoice-statements/list-statements.md): Lists the statements of an invoice, newest first: the amount owed, each payment instrument created for it (boleto, PIX, PIX Automático), the payments received, adjustments and manual settlements. - [Get a statement](https://developers.portao3.com.br/api-reference/billing/invoice-statements/get-a-statement.md): Returns one statement of an invoice. - [Create a statement](https://developers.portao3.com.br/api-reference/billing/invoice-statements/create-a-statement.md): Records a statement on an invoice your organization issued: an adjustment such as a discount or a fee, or a payment received outside Portão 3. - [Mark an invoice as paid](https://developers.portao3.com.br/api-reference/billing/invoice-statements/mark-an-invoice-as-paid.md): Marks an invoice your organization issued as paid, for a payment received outside Portão 3, by recording a `MANUAL_SETTLEMENT` statement for everything still owed. - [Create a boleto](https://developers.portao3.com.br/api-reference/billing/invoice-statements/create-a-boleto.md): Issues a boleto for an invoice your organization issued. - [Download a boleto PDF](https://developers.portao3.com.br/api-reference/billing/invoice-statements/download-a-boleto-pdf.md): Downloads the PDF of a boleto of an invoice your organization issued. - [Create a PIX charge](https://developers.portao3.com.br/api-reference/billing/invoice-statements/create-a-pix-charge.md): Issues a PIX charge for an invoice your organization issued. - [Charge the payer's wallet](https://developers.portao3.com.br/api-reference/billing/invoice-statements/charge-the-payers-wallet.md): Charges an invoice your organization issued from the payer's Portão 3 wallet. #### NFSe Configuration - [Get the NFSe configuration](https://developers.portao3.com.br/api-reference/billing/nfse-configuration/get-the-nfse-configuration.md): Returns the organization's NFSe configuration: which billing event issues its service invoices (NFSe) automatically, and how they are filled in. - [Create the NFSe configuration](https://developers.portao3.com.br/api-reference/billing/nfse-configuration/create-the-nfse-configuration.md): Turns on automatic NFSe issuance for the organization: from now on, each `event` you choose issues a service invoice (NFSe) through your tax issuer. - [Delete the NFSe configuration](https://developers.portao3.com.br/api-reference/billing/nfse-configuration/delete-the-nfse-configuration.md): Turns off automatic NFSe issuance for the organization by deleting its NFSe configuration. #### Payment Links - [List payment links](https://developers.portao3.com.br/api-reference/billing/payment-links/list-payment-links.md): Lists the payment links of your organization, newest first by default. - [Create a payment link](https://developers.portao3.com.br/api-reference/billing/payment-links/create-a-payment-link.md): Creates a payment link: a checkout page where payers buy the products you choose. - [Export payment links](https://developers.portao3.com.br/api-reference/billing/payment-links/export-payment-links.md): Exports the payment links of your organization as a CSV or XLSX file. - [Get a payment link](https://developers.portao3.com.br/api-reference/billing/payment-links/get-a-payment-link.md): Returns one payment link of your organization, with its products' current names and prices. - [Update a payment link](https://developers.portao3.com.br/api-reference/billing/payment-links/update-a-payment-link.md): Replaces an active payment link with the body sent. - [Activate a payment link](https://developers.portao3.com.br/api-reference/billing/payment-links/activate-a-payment-link.md): Activates a deactivated payment link: payers can check out again. - [Deactivate a payment link](https://developers.portao3.com.br/api-reference/billing/payment-links/deactivate-a-payment-link.md): Deactivates an active payment link: its checkout page stops accepting payers. ### Accounting #### Tax Issuers - [Get your tax issuer](https://developers.portao3.com.br/api-reference/accounting/tax-issuers/get-your-tax-issuer.md): Returns the tax issuer of the organization, with its test and live configurations. - [Create your tax issuer](https://developers.portao3.com.br/api-reference/accounting/tax-issuers/create-your-tax-issuer.md): Creates the tax issuer of the organization: the registration that lets it issue service invoices (NFSe). - [Update your tax issuer](https://developers.portao3.com.br/api-reference/accounting/tax-issuers/update-your-tax-issuer.md): Updates the configuration of the tax issuer of the organization, in both environments. - [Deactivate your tax issuer](https://developers.portao3.com.br/api-reference/accounting/tax-issuers/deactivate-your-tax-issuer.md): Deactivates the tax issuer of the organization. - [Upload your digital certificate](https://developers.portao3.com.br/api-reference/accounting/tax-issuers/upload-your-digital-certificate.md): Uploads the digital certificate your organization uses to sign its service invoices (NFSe). - [Upload your logo](https://developers.portao3.com.br/api-reference/accounting/tax-issuers/upload-your-logo.md): Uploads the logo printed on your service invoices (NFSe). #### Tax Documents (NFSe) - [List tax documents](https://developers.portao3.com.br/api-reference/accounting/tax-documents-nfse/list-tax-documents.md): Lists the tax documents (NFSe) of your organization, newest first. - [Issue a tax document](https://developers.portao3.com.br/api-reference/accounting/tax-documents-nfse/issue-a-tax-document.md): Issues a tax document (NFSe) for your organization. - [Issue tax documents in batch](https://developers.portao3.com.br/api-reference/accounting/tax-documents-nfse/issue-tax-documents-in-batch.md): Issues a tax document (NFSe) for every row of an uploaded CSV file. - [Download tax documents in batch](https://developers.portao3.com.br/api-reference/accounting/tax-documents-nfse/download-tax-documents-in-batch.md): Bundles the XML or PDF files of several tax documents into one zip and returns a temporary download link. - [Cancel tax documents in batch](https://developers.portao3.com.br/api-reference/accounting/tax-documents-nfse/cancel-tax-documents-in-batch.md): Requests the cancellation of every tax document listed in an uploaded CSV file. - [Download a tax document](https://developers.portao3.com.br/api-reference/accounting/tax-documents-nfse/download-a-tax-document.md): Gets a temporary link to download the PDF or the XML of a tax document. - [Cancel a tax document](https://developers.portao3.com.br/api-reference/accounting/tax-documents-nfse/cancel-a-tax-document.md): Requests the cancellation of a tax document and answers with the document. #### Tax Codes - [List a city's special tax regimes](https://developers.portao3.com.br/api-reference/accounting/tax-codes/list-a-citys-special-tax-regimes.md): Lists the special taxation regimes a city hall supports for service invoice (NFSe) issuance. ### Registry #### Customers - [List customers](https://developers.portao3.com.br/api-reference/registry/customers/list-customers.md): Lists the customers of an organization, 25 per page and oldest first by default. - [Create a customer](https://developers.portao3.com.br/api-reference/registry/customers/create-a-customer.md): Creates a customer of the organization — a person or a company you bill — and answers it. - [Export customers](https://developers.portao3.com.br/api-reference/registry/customers/export-customers.md): Exports every customer of the organization as a CSV or XLSX file. - [Get a customer](https://developers.portao3.com.br/api-reference/registry/customers/get-a-customer.md): Gets one customer of the organization, with its status and the link to its portal page. - [Update a customer](https://developers.portao3.com.br/api-reference/registry/customers/update-a-customer.md): Updates a customer's name, trade name, e-mail, phone, address or custom-field values, and answers the updated customer with `201`. - [Activate a customer](https://developers.portao3.com.br/api-reference/registry/customers/activate-a-customer.md): Sets a customer's `status` to `ACTIVE`. - [Deactivate a customer](https://developers.portao3.com.br/api-reference/registry/customers/deactivate-a-customer.md): Sets a customer's `status` to `DEACTIVATED`. #### Companies - [Search companies](https://developers.portao3.com.br/api-reference/registry/companies/search-companies.md): Searches Brazil's public company registry, one establishment (headquarters or branch) per result, in CNPJ order. - [Get a company by CNPJ](https://developers.portao3.com.br/api-reference/registry/companies/get-a-company-by-cnpj.md): Gets one establishment of Brazil's public company registry by its full CNPJ. #### People - [Get a person by CPF](https://developers.portao3.com.br/api-reference/registry/people/get-a-person-by-cpf.md): Gets a person by CPF. #### Products - [List products](https://developers.portao3.com.br/api-reference/registry/products/list-products.md): Lists the organization's products and services, newest first. - [Create a product](https://developers.portao3.com.br/api-reference/registry/products/create-a-product.md): Creates a product or service in the organization's catalog. - [Export products](https://developers.portao3.com.br/api-reference/registry/products/export-products.md): Exports the organization's products as a CSV or XLSX file. - [Get a product](https://developers.portao3.com.br/api-reference/registry/products/get-a-product.md): Gets one product of the organization's catalog. - [Update a product](https://developers.portao3.com.br/api-reference/registry/products/update-a-product.md): Updates a product. - [Activate a product](https://developers.portao3.com.br/api-reference/registry/products/activate-a-product.md): Sets a product's `status` to `ACTIVE`. - [Deactivate a product](https://developers.portao3.com.br/api-reference/registry/products/deactivate-a-product.md): Sets a product's `status` to `DEACTIVATED`. #### Suppliers - [List suppliers](https://developers.portao3.com.br/api-reference/registry/suppliers/list-suppliers.md): Lists the organization's suppliers, newest first. - [Create a supplier](https://developers.portao3.com.br/api-reference/registry/suppliers/create-a-supplier.md): Registers a supplier in the organization. - [Export suppliers](https://developers.portao3.com.br/api-reference/registry/suppliers/export-suppliers.md): Exports the organization's suppliers as a CSV or XLSX file. - [Get a supplier](https://developers.portao3.com.br/api-reference/registry/suppliers/get-a-supplier.md): Gets one supplier of the organization. - [Update a supplier](https://developers.portao3.com.br/api-reference/registry/suppliers/update-a-supplier.md): Updates a supplier. - [Activate a supplier](https://developers.portao3.com.br/api-reference/registry/suppliers/activate-a-supplier.md): Sets a supplier's `status` to `ACTIVE`. - [Deactivate a supplier](https://developers.portao3.com.br/api-reference/registry/suppliers/deactivate-a-supplier.md): Sets a supplier's `status` to `DEACTIVATED`. ### Platform #### Wallets - [Get wallet cashback](https://developers.portao3.com.br/api-reference/platform/wallets/get-wallet-cashback.md): Returns the total cashback a wallet has earned since it was created. - [/realms/{realmId}/organizations/{organizationId}/wallets](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets.md) - [/realms/{realmId}/organizations/{organizationId}/wallets](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-1.md) - [/realms/{realmId}/organizations/{organizationId}/wallets-report](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-report.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-2.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-3.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-block.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-cashback-balance.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-clear-balance.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-1.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-2.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-3.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-request.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock](https://developers.portao3.com.br/api-reference/platform/wallets/realms-organizations-wallets-unblock.md) #### Cards - [/realms/{realmId}/organizations/{organizationId}/cards](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-cards.md) - [/realms/{realmId}/organizations/{organizationId}/threeds-submit](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-threeds-submit.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-1.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-2.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-3.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-block.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-details.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-pin.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-transactions.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-transactions-summary.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-transactionsexport.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock](https://developers.portao3.com.br/api-reference/platform/cards/realms-organizations-wallets-cards-unblock.md) #### PIX - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix](https://developers.portao3.com.br/api-reference/platform/pix/realms-organizations-wallets-pix.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}](https://developers.portao3.com.br/api-reference/platform/pix/realms-organizations-wallets-pix-1.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel](https://developers.portao3.com.br/api-reference/platform/pix/realms-organizations-wallets-pix-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm](https://developers.portao3.com.br/api-reference/platform/pix/realms-organizations-wallets-pix-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request](https://developers.portao3.com.br/api-reference/platform/pix/realms-organizations-wallets-pix-request.md) #### PIX Keys (DICT) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict](https://developers.portao3.com.br/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict](https://developers.portao3.com.br/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-1.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove](https://developers.portao3.com.br/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-remove.md) #### Boleto - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}](https://developers.portao3.com.br/api-reference/platform/boleto/realms-organizations-wallets-bank-slip.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel](https://developers.portao3.com.br/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm](https://developers.portao3.com.br/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request](https://developers.portao3.com.br/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-request.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check](https://developers.portao3.com.br/api-reference/platform/boleto/realms-organizations-wallets-bank-slipcheck.md) #### Transfers - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p](https://developers.portao3.com.br/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2p.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule](https://developers.portao3.com.br/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2pschedule.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule](https://developers.portao3.com.br/api-reference/platform/transfers/realms-organizations-wallets-transfersschedule.md) #### Scheduled Payments - [/realms/{realmId}/organizations/{organizationId}/schedules](https://developers.portao3.com.br/api-reference/platform/scheduled-payments/realms-organizations-schedules.md) - [/realms/{realmId}/organizations/{organizationId}/schedules/report](https://developers.portao3.com.br/api-reference/platform/scheduled-payments/realms-organizations-schedulesreport.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules](https://developers.portao3.com.br/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}](https://developers.portao3.com.br/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-1.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}](https://developers.portao3.com.br/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-2.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report](https://developers.portao3.com.br/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedulesreport.md) #### Transactions & Statements - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-invoices-statements.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-invoices-statements-1.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-invoices-statements-2.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-invoices-statementssettlement.md) - [/realms/{realmId}/organizations/{organizationId}/statements/report](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-statementsreport.md) - [/realms/{realmId}/organizations/{organizationId}/statements/report-async](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-statementsreport-async.md) - [/realms/{realmId}/organizations/{organizationId}/transactions](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-transactions.md) - [/realms/{realmId}/organizations/{organizationId}/transactions-summary](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-transactions-summary.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-aggregated-transactions.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions-summary.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions-1.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions-custom-fields.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions-reversals.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions-reversals-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions-reversals-confirm.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions-spend-review.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request](https://developers.portao3.com.br/api-reference/platform/transactions-&-statements/realms-organizations-wallets-transactions-spend-reviewrequest.md) #### Invoices - [/realms/{realmId}/organizations/{organizationId}/invoices](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-invoices.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-invoices-1.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-invoices-2.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-invoices-create-payment.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-invoices-download-pdf.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-invoices-entries.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-invoices-entries-1.md) - [/realms/{realmId}/organizations/{organizationId}/invoices/report](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-invoicesreport.md) - [/realms/{realmId}/organizations/{organizationId}/my-invoices](https://developers.portao3.com.br/api-reference/platform/invoices/realms-organizations-my-invoices.md) #### Contracts & Deals - [Create a deal](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/create-a-deal.md): Creates a deal: what your organization charges a payer for, how it is paid and when. - [Cancel a deal](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/cancel-a-deal.md): Cancels an open deal of your organization: it stops creating invoices. - [Deprecated — List contracts](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/deprecated-—-list-contracts.md): Deprecated: contracts are being removed; there is no replacement on this API. - [Deprecated — Create a contract](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/deprecated-—-create-a-contract.md): Deprecated: contracts are being removed; create the deal directly with `POST .../deals`. - [Deprecated — Get a contract](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/deprecated-—-get-a-contract.md): Deprecated: contracts are being removed; there is no replacement on this API. - [Deprecated — Update a contract](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/deprecated-—-update-a-contract.md): Deprecated: contracts are being removed; there is no replacement. - [Deprecated — Create a deal under a contract](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/deprecated-—-create-a-deal-under-a-contract.md): Deprecated: use `POST .../deals`; contracts are being removed. - [Deprecated — Cancel a deal under a contract](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/deprecated-—-cancel-a-deal-under-a-contract.md): Deprecated: use `POST .../deals/{dealId}/cancel`; contracts are being removed. - [Deprecated — Terminate a contract](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/deprecated-—-terminate-a-contract.md): Deprecated: contracts are being removed; there is no replacement. - [Deprecated — List my contracts](https://developers.portao3.com.br/api-reference/platform/contracts-&-deals/deprecated-—-list-my-contracts.md): Deprecated: contracts are being removed; there is no replacement on this API. #### Billing - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing](https://developers.portao3.com.br/api-reference/platform/billing/realms-organizations-wallets-billing.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}](https://developers.portao3.com.br/api-reference/platform/billing/realms-organizations-wallets-billing-1.md) - [/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf](https://developers.portao3.com.br/api-reference/platform/billing/realms-organizations-wallets-billing-download-pdf.md) #### Notifications - [/realms/{realmId}/organizations/{organizationId}/notifications](https://developers.portao3.com.br/api-reference/platform/notifications/realms-organizations-notifications.md) #### Users - [/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default](https://developers.portao3.com.br/api-reference/platform/users/realms-organizations-users-walletsdefault.md) #### Vehicles - [/realms/{realmId}/organizations/{organizationId}/vehicles](https://developers.portao3.com.br/api-reference/platform/vehicles/realms-organizations-vehicles.md) - [/realms/{realmId}/organizations/{organizationId}/vehicles](https://developers.portao3.com.br/api-reference/platform/vehicles/realms-organizations-vehicles-1.md) - [/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}](https://developers.portao3.com.br/api-reference/platform/vehicles/realms-organizations-vehicles-2.md) - [/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}](https://developers.portao3.com.br/api-reference/platform/vehicles/realms-organizations-vehicles-3.md) - [/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive](https://developers.portao3.com.br/api-reference/platform/vehicles/realms-organizations-vehicles-archive.md) - [/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive](https://developers.portao3.com.br/api-reference/platform/vehicles/realms-organizations-vehicles-unarchive.md) ### Notification #### Webhooks - [List realm webhooks](https://developers.portao3.com.br/api-reference/notification/webhooks/list-realm-webhooks.md): Lists the realm-wide webhooks — the ones registered for every organization of the realm (`organizationId` is `*`), newest first. An organization's own webhooks are listed through `GET /realms/{realmId}/organizations/{organizationId}/webhooks`. - [Register a realm webhook](https://developers.portao3.com.br/api-reference/notification/webhooks/register-a-realm-webhook.md): Registers a realm-wide webhook: one URL, subscribed to the given events, which it receives for every organization of the realm. - [Activate a realm webhook event](https://developers.portao3.com.br/api-reference/notification/webhooks/activate-a-realm-webhook-event.md): Turns one event of a realm-wide webhook back on: its `status` becomes `ACTIVE` and the webhook receives the event again. Idempotent — an already active event is returned unchanged. No request body. Only realm admins can call this. - [Deactivate a realm webhook event](https://developers.portao3.com.br/api-reference/notification/webhooks/deactivate-a-realm-webhook-event.md): Turns one event of a realm-wide webhook off: its `status` becomes `INACTIVE` and the webhook stops receiving the event until it is activated again (or re-registered). The webhook itself and its other events are untouched. Idempotent. No request body. Only realm admins can call this. - [List organization webhooks](https://developers.portao3.com.br/api-reference/notification/webhooks/list-organization-webhooks.md): Lists the organization's webhooks, newest first. Realm-wide webhooks also receive the organization's events but are not listed here — see `GET /realms/{realmId}/webhooks`. - [Register an organization webhook](https://developers.portao3.com.br/api-reference/notification/webhooks/register-an-organization-webhook.md): Registers a webhook for the organization: one URL, subscribed to the given events. - [Activate an organization webhook event](https://developers.portao3.com.br/api-reference/notification/webhooks/activate-an-organization-webhook-event.md): Turns one event of an organization's webhook back on: its `status` becomes `ACTIVE` and the webhook receives the event again. Idempotent — an already active event is returned unchanged. No request body. - [Deactivate an organization webhook event](https://developers.portao3.com.br/api-reference/notification/webhooks/deactivate-an-organization-webhook-event.md): Turns one event of an organization's webhook off: its `status` becomes `INACTIVE` and the webhook stops receiving the event until it is activated again (or re-registered). The webhook itself and its other events are untouched. Idempotent. No request body. ### Rule Engine #### Business Policies - [/realms/{realmId}/organizations/{organizationId}/business-policies](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policies.md) - [/realms/{realmId}/organizations/{organizationId}/business-policies](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policies-1.md) - [/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policies-2.md) - [/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policies-3.md) - [/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policies-archive.md) - [/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-description.md) - [/realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-policy.md) - [/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policiespayment-conditions.md) - [/realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions](https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policiesspend-review-conditions.md) #### Policy Evaluations - [/realms/{realmId}/organizations/{organizationId}/policy-evaluations](https://developers.portao3.com.br/api-reference/ruleengine/policy-evaluations/realms-organizations-policy-evaluations.md) #### Policy Requests - [/realms/{realmId}/organizations/{organizationId}/policy-requests](https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests.md) - [/realms/{realmId}/organizations/{organizationId}/policy-requests](https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-1.md) - [/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}](https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-2.md) - [/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve](https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-approve.md) - [/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel](https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-cancel.md) - [/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny](https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-deny.md) - [/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve](https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-approve.md) - [/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny](https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-deny.md) ### Scheduling #### Schedules - [List organization schedules](https://developers.portao3.com.br/api-reference/scheduling/schedules/list-organization-schedules.md): Lists every schedule of the organization, across all of its wallets, newest first. - [List wallet schedules](https://developers.portao3.com.br/api-reference/scheduling/schedules/list-wallet-schedules.md): Lists the schedules a wallet pays, newest first. - [Get a schedule](https://developers.portao3.com.br/api-reference/scheduling/schedules/get-a-schedule.md): Returns a schedule and the payment behind it. - [List schedule events](https://developers.portao3.com.br/api-reference/scheduling/schedules/list-schedule-events.md): Lists what happened to a schedule, newest first. ### Travel #### Passengers - [List passengers](https://developers.portao3.com.br/api-reference/travel/passengers/list-passengers.md): Lists the organization's passengers, followed by its users who are not passengers yet. - [Create a passenger](https://developers.portao3.com.br/api-reference/travel/passengers/create-a-passenger.md): Registers a passenger in the organization, so they can be booked on trips. - [Get a passenger](https://developers.portao3.com.br/api-reference/travel/passengers/get-a-passenger.md): Returns a passenger of the organization. - [Update a passenger](https://developers.portao3.com.br/api-reference/travel/passengers/update-a-passenger.md): Replaces a passenger's data. - [Delete a passenger](https://developers.portao3.com.br/api-reference/travel/passengers/delete-a-passenger.md): Deletes a passenger from the organization. #### Trips - [List realm trips](https://developers.portao3.com.br/api-reference/travel/trips/list-realm-trips.md): Lists every trip of the realm, across its organizations, newest first. - [List organization trips](https://developers.portao3.com.br/api-reference/travel/trips/list-organization-trips.md): Lists every trip of the organization, newest first. - [Create a trip](https://developers.portao3.com.br/api-reference/travel/trips/create-a-trip.md): Books a trip: one flight, hotel stay, bus ticket or vehicle rental for the organization's passengers. To book several products, create one trip for each. - [List passenger trips](https://developers.portao3.com.br/api-reference/travel/trips/list-passenger-trips.md): Lists the trips a passenger travels on, newest first. - [Get a trip](https://developers.portao3.com.br/api-reference/travel/trips/get-a-trip.md): Returns a trip: its booked product, passengers and where the booking is. - [List trip history](https://developers.portao3.com.br/api-reference/travel/trips/list-trip-history.md): Lists the changes of a trip's state and status, oldest first. - [Issue a trip](https://developers.portao3.com.br/api-reference/travel/trips/issue-a-trip.md): Issues a reserved trip: the ticket, voucher or rental is emitted. - [List cancellation quotes](https://developers.portao3.com.br/api-reference/travel/trips/list-cancellation-quotes.md): Lists the ways to cancel a trip, each with what it would cost. - [Cancel a trip](https://developers.portao3.com.br/api-reference/travel/trips/cancel-a-trip.md): Confirms a cancellation quote, canceling the trip. #### Air search - [Search airports](https://developers.portao3.com.br/api-reference/travel/air-search/search-airports.md): Searches airports for an air search. - [Create an air search](https://developers.portao3.com.br/api-reference/travel/air-search/create-an-air-search.md): Starts a search for flights, one way or round trip. - [Get an air search and its results](https://developers.portao3.com.br/api-reference/travel/air-search/get-an-air-search-and-its-results.md): Returns an air search and, once it has finished, one page of its flights. - [Get an air search grouped by airline and price](https://developers.portao3.com.br/api-reference/travel/air-search/get-an-air-search-grouped-by-airline-and-price.md): Returns the results of an air search grouped into cards by airline and price. - [Get an air search item](https://developers.portao3.com.br/api-reference/travel/air-search/get-an-air-search-item.md): Returns the full detail of one flight of an air search: its journeys and every fare option. #### Hotel search - [Search hotel destinations](https://developers.portao3.com.br/api-reference/travel/hotel-search/search-hotel-destinations.md): Searches destinations for a hotel search. - [Create a hotel search](https://developers.portao3.com.br/api-reference/travel/hotel-search/create-a-hotel-search.md): Starts a search for hotels in a destination, for given dates and rooms. - [Get a hotel search and its results](https://developers.portao3.com.br/api-reference/travel/hotel-search/get-a-hotel-search-and-its-results.md): Returns a hotel search and, once it has finished, one page of its hotels. - [Get a hotel search as map points](https://developers.portao3.com.br/api-reference/travel/hotel-search/get-a-hotel-search-as-map-points.md): Returns every hotel of a search as a point to plot on a map. - [Get a hotel search item](https://developers.portao3.com.br/api-reference/travel/hotel-search/get-a-hotel-search-item.md): Returns the full detail of one hotel of a hotel search: the hotel record and its room combinations. #### Bus search - [Search bus stations](https://developers.portao3.com.br/api-reference/travel/bus-search/search-bus-stations.md): Searches bus stations for a bus search. - [Create a bus search](https://developers.portao3.com.br/api-reference/travel/bus-search/create-a-bus-search.md): Starts a search for bus trips between two stations, one way or round trip. - [Get a bus search and its results](https://developers.portao3.com.br/api-reference/travel/bus-search/get-a-bus-search-and-its-results.md): Returns a bus search and, once it has finished, one page of its trips. - [Get a bus search item](https://developers.portao3.com.br/api-reference/travel/bus-search/get-a-bus-search-item.md): Returns the full detail of one bus trip of a bus search: the trip and its legs, with seat maps and fares. #### Vehicle search - [Search vehicle pick-up places](https://developers.portao3.com.br/api-reference/travel/vehicle-search/search-vehicle-pick-up-places.md): Searches pick-up and drop-off places for a vehicle search. - [Create a vehicle search](https://developers.portao3.com.br/api-reference/travel/vehicle-search/create-a-vehicle-search.md): Starts a search for car rentals, from a pick-up place and time to a drop-off place and time. - [Get a vehicle search and its results](https://developers.portao3.com.br/api-reference/travel/vehicle-search/get-a-vehicle-search-and-its-results.md): Returns a vehicle search and, once it has finished, one page of its vehicles. - [Get a vehicle search item](https://developers.portao3.com.br/api-reference/travel/vehicle-search/get-a-vehicle-search-item.md): Returns the full detail of one vehicle of a vehicle search: the vehicle and every fare option. ### Vehicles #### Vehicles - [List vehicles](https://developers.portao3.com.br/api-reference/vehicle/vehicles/list-vehicles.md): Lists the organization's vehicles, newest first. - [Create a vehicle](https://developers.portao3.com.br/api-reference/vehicle/vehicles/create-a-vehicle.md): Registers a vehicle in the organization and creates its dedicated wallet. - [Get a vehicle](https://developers.portao3.com.br/api-reference/vehicle/vehicles/get-a-vehicle.md): Returns a vehicle of the organization, active or archived. - [Update a vehicle](https://developers.portao3.com.br/api-reference/vehicle/vehicles/update-a-vehicle.md): Replaces a vehicle's name, license plate, make, model and year. - [Archive a vehicle](https://developers.portao3.com.br/api-reference/vehicle/vehicles/archive-a-vehicle.md): Archives a vehicle and blocks its wallet. - [Unarchive a vehicle](https://developers.portao3.com.br/api-reference/vehicle/vehicles/unarchive-a-vehicle.md): Reactivates an archived vehicle: its wallet is unblocked. ### Attachments #### Attachments - [List realm attachments](https://developers.portao3.com.br/api-reference/attachment/attachments/list-realm-attachments.md): Lists the attachments of every organization in your realm, newest first. - [List attachments](https://developers.portao3.com.br/api-reference/attachment/attachments/list-attachments.md): Lists the organization's attachments, newest first. - [Create an attachment](https://developers.portao3.com.br/api-reference/attachment/attachments/create-an-attachment.md): Registers a file and returns the URL to upload its bytes to. - [Get an attachment](https://developers.portao3.com.br/api-reference/attachment/attachments/get-an-attachment.md): Returns an attachment and what was read from it, whatever its status. - [Delete an attachment](https://developers.portao3.com.br/api-reference/attachment/attachments/delete-an-attachment.md): Deletes an attachment. - [Download an attachment](https://developers.portao3.com.br/api-reference/attachment/attachments/download-an-attachment.md): Returns a short-lived URL to download the attachment's file. ## OpenAPI Specs - [identity.openapi](/api-reference/identity.openapi.json) - [banking.openapi](/api-reference/banking.openapi.json) - [billing.openapi](/api-reference/billing.openapi.json) - [accounting.openapi](/api-reference/accounting.openapi.json) - [registry.openapi](/api-reference/registry.openapi.json) - [platform.openapi](/api-reference/platform.openapi.json) - [notification.openapi](/api-reference/notification.openapi.json) - [ruleengine.openapi](/api-reference/ruleengine.openapi.json) - [scheduling.openapi](/api-reference/scheduling.openapi.json) - [travel.openapi](/api-reference/travel.openapi.json) - [vehicle.openapi](/api-reference/vehicle.openapi.json) - [attachment.openapi](/api-reference/attachment.openapi.json)