The organization’s business policies decide what happens next. When a policy requires approvals, the answer is 202 Accepted with the trip in status REQUESTED and the approval request in policyRequest: the approvers decide it, and an approved trip is issued automatically. When no policy requires an approval, the trip is issued right away and the answer is 202 Accepted once the issuance was accepted. Read the trip to follow it.Only flight and bus trips can be sent for approval. The trip must still be reserved, with its booking details loaded and enough time left on the reservation for the approvals to finish: the approval has to be decided at the latest 2 minutes before the reservation expires, and at least a minute of that window must be left when the trip is sent. Sending a trip that is already waiting for approval answers with it as it is. Visible to an organization admin, to the users the trip carries and to the user who booked it, like the trip itself.
A trip with what the organization's business policies say about it: the advisory policy while it can still be sent for approval, and the policyRequest once an approval request exists.
Where the booking is in its life: PENDING while the reservation is being made, RESERVED once held (until reservationExpiresAt), ISSUED once ticketed and CANCELED. It only moves forward.
Finer-grained status: it also reports work in progress (PROCESSING_*) and failures, and can change back and forth. Use state to decide what the booking is; use status to tell what is happening to it. While the booking is RESERVED it also tells where the approval is: REQUESTED while the trip waits for its approvers and DENIED once they refused it (approval has the details). Once the booking moves on, its own status shows again.
The booked product: the itinerary, stay, ticket or rental as recorded by the travel provider — journeys and flights, the hotel and its rooms, the route and boarding information, the rental — with its fares, policies and booking locators. It does not repeat the trip's own fields (state, status, the amounts, the dates) and carries no identifier of the travel provider; passengers are referenced by their id in passengers[]. Its shape depends on vertical: a flight (AIR), a hotel stay (HOTEL), a bus ticket (BUS) or a vehicle rental (VEHICLE) — see the four schemas below. Omitted until the record is first fetched.
What the organization's policies decide for the trip now. Present while the trip is reserved and can be sent for approval or issued; omitted otherwise.
The approval request of the latest attempt. Omitted until one exists.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Portão 3","colors":{"primary":"#43418E","light":"#8D8AE0","dark":"#302E65"},"logo":{"light":"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/light.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=9a15f0d9bfb0f9aeefa58cc02e0274c9","dark":"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/dark.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=47b0ed7a3645b0b5460c05d8b107963e"},"favicon":"https://mintcdn.com/porto3/dSTOaRKpfB0RS1lU/favicon.ico?fit=max\u0026auto=format\u0026n=dSTOaRKpfB0RS1lU\u0026q=85\u0026s=194badfbfde2e6414d74da0762416602","navbar":{"links":[{"href":"mailto:suporte@portao3.com.br","label":"Support"}],"primary":{"type":"button","label":"portao3.com.br","href":"https://portao3.com.br"}},"footer":{"socials":{"website":"https://portao3.com.br"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"languages":[{"language":"en","href":""},{"language":"pt-BR","href":"pt-BR"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"porto3","hasAudioNarration":false,"actualSubdomain":"porto3","customDomains":["developers.portao3.com.br"],"gitSource":{"type":"github","owner":"portao-3","repo":"portao3-backend","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"8240fd59-003e-4df3-a100-77d17155da54","liveDeploymentHistoryId":"6aeccdac5e64435eef0355f8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeccdac5e64435eef0355f8"},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6aee57b72bed2914d739cab1","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":415},{"language":"default","tag":"Banking","count":148},{"language":"default","tag":"Platform","count":92},{"language":"default","tag":"Billing","count":38},{"language":"default","tag":"Travel","count":32},{"language":"default","tag":"Identity","count":29},{"language":"default","tag":"Wallets","count":28},{"language":"default","tag":"Cards","count":27},{"language":"default","tag":"Registry","count":24},{"language":"default","tag":"Transactions \u0026 Statements","count":18},{"language":"en","tag":"Guides","count":16},{"language":"pt-BR","tag":"Guias","count":16},{"language":"en","tag":"PIX \u0026 payments","count":8},{"language":"pt-BR","tag":"PIX e pagamentos","count":8},{"language":"en","tag":"Cards","count":3},{"language":"pt-BR","tag":"Cartões","count":3},{"language":"en","tag":"API Reference","count":2},{"language":"en","tag":"Overview","count":2},{"language":"en","tag":"Getting Started","count":2},{"language":"pt-BR","tag":"Referência da API","count":2},{"language":"pt-BR","tag":"Visão geral","count":2},{"language":"pt-BR","tag":"Primeiros passos","count":2},{"language":"en","tag":"Integration guides","count":1},{"language":"en","tag":"Accounts \u0026 wallets","count":1},{"language":"en","tag":"Building your integration","count":1},{"language":"pt-BR","tag":"Guias de integração","count":1},{"language":"pt-BR","tag":"Contas e carteiras","count":1},{"language":"pt-BR","tag":"Construindo sua integração","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"api-reference.css","content":"[class*=\"param-field\"]>.py-6>.mt-4{margin-top:0!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4>*+*{margin-top:0!important}[class*=\"param-field\"]>.py-6>.mt-4 .prose>p,[class*=\"param-field\"]>.py-6>.mt-4 .prose p.whitespace-pre-line{margin-top:0!important;margin-bottom:0!important}[class*=\"param-field\"]>.py-6>.mt-4>.mt-6,.api-section .whitespace-pre-wrap.prose-sm.mt-6{margin-top:0!important}html[data-current-path^=\"/api-reference/\"] div.mt-2.text-lg.prose{font-size:1rem!important;line-height:1.5rem!important;margin-bottom:1.5rem!important}h4.api-section-heading-title{font-size:1.5rem!important;line-height:2rem!important}.api-section-heading>.border-b{border-bottom-width:0!important;padding-bottom:0!important}.api-section-heading div.font-mono.text-xs:not(:has(button)){display:none!important}.api-section-heading div.relative:has(>button[disabled]){display:none!important}html[data-current-path^=\"/api-reference/\"] .mdx-content.prose{font-size:1rem!important;line-height:1.5rem!important}[class*=\"param-field\"]>.py-6>.mt-4{display:flex!important;flex-direction:column!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child{display:contents!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child>hr{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child>hr+p{order:99!important}[class*=\"param-field\"]>.py-6>.mt-4>div:has(>div:first-child>.space-y-4:first-child>hr){display:flex!important;flex-direction:column!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child:has(>.space-y-4:first-child>hr),[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child:has(>hr){display:contents!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child>hr{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child>hr+p{order:99!important;margin-top:0.75rem!important}.param-head[id^=\"response-\"] [data-component-part=\"field-required-pill\"]{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4:has(>.space-y-4:first-child>hr)>.mt-6:has(>span+div pre),[class*=\"param-field\"]>.py-6>.mt-4>div:has(>div:first-child>.space-y-4:first-child>hr)>.mt-6:has(>span+div pre){display:none!important}"}],"page":{"pagePath":"api-reference/travel/trips/send-a-trip-for-approval","slug":"/api-reference/travel/trips/send-a-trip-for-approval","pageMetadata":{"title":"Send a trip for approval","description":"Sends a reserved trip for approval.","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/request","href":"/api-reference/travel/trips/send-a-trip-for-approval","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Sends a reserved trip for approval.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The organization’s business policies decide what happens next. When a policy requires approvals, the answer is `,_jsx(_components.code,{children:`202 Accepted`}),` with the trip in status `,_jsx(_components.code,{children:`REQUESTED`}),` and the approval request in `,_jsx(_components.code,{children:`policyRequest`}),`: the approvers decide it, and an approved trip is issued automatically. When no policy requires an approval, the trip is issued right away and the answer is `,_jsx(_components.code,{children:`202 Accepted`}),` once the issuance was accepted. Read the trip to follow it.`]}),`\n`,_jsx(_components.p,{children:`Only flight and bus trips can be sent for approval. The trip must still be reserved, with its booking details loaded and enough time left on the reservation for the approvals to finish: the approval has to be decided at the latest 2 minutes before the reservation expires, and at least a minute of that window must be left when the trip is sent. Sending a trip that is already waiting for approval answers with it as it is. Visible to an organization admin, to the users the trip carries and to the user who booked it, like the trip itself.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Send a trip for approval","description":"Sends a reserved trip for approval.","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/request","href":"/api-reference/travel/trips/send-a-trip-for-approval","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postRealmsByRealmIdOrganizationsByOrganizationIdTripsByTripIdRequest","summary":"Send a trip for approval","tags":["Trips"],"x-p3-sidebar-order":7,"description":"Sends a reserved trip for approval.","x-mint":{"content":"The organization's business policies decide what happens next. When a policy requires approvals, the answer is `202 Accepted` with the trip in status `REQUESTED` and the approval request in `policyRequest`: the approvers decide it, and an approved trip is issued automatically. When no policy requires an approval, the trip is issued right away and the answer is `202 Accepted` once the issuance was accepted. Read the trip to follow it.\n\nOnly flight and bus trips can be sent for approval. The trip must still be reserved, with its booking details loaded and enough time left on the reservation for the approvals to finish: the approval has to be decided at the latest 2 minutes before the reservation expires, and at least a minute of that window must be left when the trip is sent. Sending a trip that is already waiting for approval answers with it as it is. Visible to an organization admin, to the users the trip carries and to the user who booked it, like the trip itself."},"parameters":["ee34fb0e-b639-4e95-a1d2-5ba279cf32dd","832a338a-772e-4466-a6e3-82561a88e1fd","ae11aea5-b63c-4d9e-a5a4-5fc4bde1053c"],"responses":{"202":"b4db0ceb-9717-43d8-8bd8-0033ef2c1f2b","400":"70cdac93-dccc-44e8-b777-f5e74e4c0411","403":"0b7307ca-dfaa-4ab8-ab88-d69bbce15999","404":"2744a0dd-baa6-448b-af1a-d67ee1209d9e","409":"92f3d575-3e53-4c81-b4d8-5eb5f606ac70","422":"b3f415b2-993a-4190-a7e1-ef44ee47aaea","503":"9aefc8a6-3ae6-49bf-81ec-9b7b39d77235"},"x-p3-confidence":{"response":"generated:typed"},"method":"post","type":"path","servers":["8f4f4a8b-8ee1-4e3a-aab6-6bf757e1cac7","60ed1897-d183-4b96-8157-90e3d8c651fb"],"security":[],"path":"/realms/{realmId}/organizations/{organizationId}/trips/{tripId}/request","baseUrlOptions":["https://api.travel.v2.portao3.com.br/","https://api.travel.dev.3pers.com.br/"],"title":"Send a trip for approval","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ee34fb0e-b639-4e95-a1d2-5ba279cf32dd":{"name":"realmId","in":"path","required":true,"description":"ID of your realm.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of your realm.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"},"832a338a-772e-4466-a6e3-82561a88e1fd":{"name":"organizationId","in":"path","required":true,"description":"ID of the organization the trip belongs to.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the organization the trip belongs to.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410"},"ae11aea5-b63c-4d9e-a5a4-5fc4bde1053c":{"name":"tripId","in":"path","required":true,"description":"ID of the trip (24 hexadecimal characters).","schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","isRequired":true,"description":"ID of the trip (24 hexadecimal characters).","uniqueKey":"","typeLabel":"string"},"example":"6711b4c0d8e1a30012b7c9f2"}},"responses":{"b4db0ceb-9717-43d8-8bd8-0033ef2c1f2b":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the trip.","example":"6711b4c0d8e1a30012b7c9f2","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"realmId":{"type":"string","description":"ID of the realm the trip belongs to.","example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","format":"uuid","isRequired":true,"uniqueKey":"realmId","typeLabel":"string\u003cuuid>"},"organizationId":{"type":"string","description":"ID of the organization the trip belongs to.","example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","format":"uuid","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string\u003cuuid>"},"customFields":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"customFields.additionalProperties","typeLabel":"any"},"description":"Values of the organization's trip custom fields, keyed by the custom field's `slug`. Empty when none were set.\n\n---\n\nExample: `{\"cost-center\":\"CC-1020\"}`","example":{"cost-center":"CC-1020"},"isRequired":true,"uniqueKey":"customFields","typeLabel":"object"},"vertical":{"type":"string","enum":["AIR","HOTEL","BUS","VEHICLE"],"description":"Type of product booked. It tells which shape `productSnapshot` has.","example":"AIR","isRequired":true,"uniqueKey":"vertical","typeLabel":"enum\u003cstring>"},"state":{"type":"string","enum":["PENDING","RESERVED","ISSUED","CANCELED"],"description":"Where the booking is in its life: `PENDING` while the reservation is being made, `RESERVED` once held (until `reservationExpiresAt`), `ISSUED` once ticketed and `CANCELED`. It only moves forward.","example":"RESERVED","isRequired":true,"uniqueKey":"state","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["REQUESTED","DENIED","PROCESSING_RESERVATION","RESERVATION_FAILED","RESERVED","PROCESSING_ISSUE","ISSUED","PROCESSING_CANCELLATION","CANCELED","AWAITING_MANUAL_CANCELLATION","CANCELLATION_FAILED","FAILED","FAILED_BY_INCONSISTENT_DATA","FAILED_BY_UNAVAILABLE_RESOURCE","FAILED_BY_BUDGET_EXCEEDED","EXPIRED","BLOCKED","UNKNOWN","ISSUANCE_FAILED"],"description":"Finer-grained status: it also reports work in progress (`PROCESSING_*`) and failures, and can change back and forth. Use `state` to decide what the booking is; use `status` to tell what is happening to it. While the booking is `RESERVED` it also tells where the approval is: `REQUESTED` while the trip waits for its approvers and `DENIED` once they refused it (`approval` has the details). Once the booking moves on, its own status shows again.","example":"RESERVED","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"passengers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the passenger, as returned by the passenger endpoints.","example":"6710a3f2c9e77b0012a4d5e1","isRequired":true,"uniqueKey":"passengers.items.[INDEX].id","typeLabel":"string"},"lead":{"type":"boolean","description":"Whether this passenger is the one responsible for the reservation.","example":true,"isRequired":true,"uniqueKey":"passengers.items.[INDEX].lead","typeLabel":"boolean"},"name":{"type":"string","description":"Full name, as it appears on the passenger's travel documents.","example":"Mariana Costa","isRequired":true,"uniqueKey":"passengers.items.[INDEX].name","typeLabel":"string"},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender.","example":"FEMALE","isRequired":true,"uniqueKey":"passengers.items.[INDEX].gender","typeLabel":"enum\u003cstring>"},"birthDate":{"type":"string","description":"Date of birth (`YYYY-MM-DD`).","example":"1990-04-17","isRequired":true,"uniqueKey":"passengers.items.[INDEX].birthDate","typeLabel":"string"},"userId":{"type":"string","description":"ID of the organization user the passenger is linked to. Omitted for a passenger who is not a user. A user sees the trips they travel on.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","format":"uuid","uniqueKey":"passengers.items.[INDEX].userId","typeLabel":"string\u003cuuid>"}},"required":["id","lead","name","gender","birthDate"],"description":"A passenger of a trip: who travels, as recorded when the trip was booked. The passenger endpoints serve the full profile.","uniqueKey":"passengers.items.[INDEX]","typeLabel":"object"},"description":"The passengers booked on the trip.","isRequired":true,"uniqueKey":"passengers","typeLabel":"object[]"},"createdBy":{"type":"string","description":"ID of the user who created the trip. Omitted when a service did.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","format":"uuid","uniqueKey":"createdBy","typeLabel":"string\u003cuuid>"},"approval":{"type":"object","properties":{"status":{"type":"string","enum":["SUBMITTING","REQUESTED","ISSUING","ISSUED","DENIED","CANCELED","EXPIRED","FAILED","ISSUE_FAILED"],"description":"Where the attempt is: `SUBMITTING` while the approval request is being opened, `REQUESTED` while it waits for the approvers, `ISSUING` while the issuance is being placed and `ISSUED` once it was accepted. `DENIED`, `CANCELED` and `EXPIRED` end the attempt without an issuance; `FAILED` means the approval request could not be opened and `ISSUE_FAILED` that an approved (or directly issued) trip could not be issued — `failureCode` says why. A new attempt can start after any of them but `DENIED`.","example":"REQUESTED","isRequired":true,"uniqueKey":"approval.status","typeLabel":"enum\u003cstring>"},"policyRequestId":{"type":"string","description":"ID of the approval request of the attempt. Omitted until one exists, and for an attempt that issued directly.","example":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","format":"uuid","uniqueKey":"approval.policyRequestId","typeLabel":"string\u003cuuid>"},"failureCode":{"type":"string","description":"Why the attempt ended without an issuance (`TRIP_CHANGED_SINCE_APPROVAL`, `RESERVATION_ENDED`, or the code of the refusal). Omitted otherwise.","example":"RESERVATION_ENDED","uniqueKey":"approval.failureCode","typeLabel":"string"}},"required":["status"],"description":"The latest approval attempt. Omitted until the trip is sent for approval or issued.","uniqueKey":"approval","typeLabel":"object"},"reservationExpiresAt":{"oneOf":[{"type":"string","description":"Until when the reservation is held. Past it, a trip that was not issued expires. `null` or omitted when there is no hold.","example":"2026-10-02T13:45:12.000Z","format":"date-time","uniqueKey":"reservationExpiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Until when the reservation is held. Past it, a trip that was not issued expires. `null` or omitted when there is no hold.","example":"2026-10-02T13:45:12.000Z","format":"date-time","uniqueKey":"reservationExpiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"reservationExpiresAt","typeLabel":"string\u003cdate-time> | null"},"issuedAt":{"oneOf":[{"type":"string","description":"When the trip was issued. `null` or omitted until it is.","format":"date-time","uniqueKey":"issuedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the trip was issued. `null` or omitted until it is.","format":"date-time","uniqueKey":"issuedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"issuedAt","typeLabel":"string\u003cdate-time> | null"},"originalAmount":{"type":"number","description":"Price before discounts, in cents. Omitted until the price is known.","example":95000,"uniqueKey":"originalAmount","typeLabel":"number"},"discountAmount":{"type":"number","description":"Discount applied, in cents. Omitted until the price is known.","example":3010,"uniqueKey":"discountAmount","typeLabel":"number"},"feeAmount":{"type":"number","description":"Fees added, in cents. Omitted until the price is known.","example":0,"uniqueKey":"feeAmount","typeLabel":"number"},"totalAmount":{"type":"number","description":"Amount to pay, in cents: `originalAmount` - `discountAmount` + `feeAmount`. Omitted until the price is known.","example":91990,"uniqueKey":"totalAmount","typeLabel":"number"},"currency":{"type":"string","description":"Currency of the amounts, as the numeric ISO 4217 code (`986` is BRL).","example":"986","uniqueKey":"currency","typeLabel":"string"},"productSnapshot":{"oneOf":[{"type":"object","title":"Air trip","description":"The booked product: the itinerary, stay, ticket or rental as recorded by the travel provider — journeys and flights, the hotel and its rooms, the route and boarding information, the rental — with its fares, policies and booking locators. It does not repeat the trip's own fields (`state`, `status`, the amounts, the dates) and carries no identifier of the travel provider; passengers are referenced by their `id` in `passengers[]`. Its shape depends on `vertical`: a flight (`AIR`), a hotel stay (`HOTEL`), a bus ticket (`BUS`) or a vehicle rental (`VEHICLE`) — see the four schemas below. Omitted until the record is first fetched.","required":["journeys","tickets","locators","flightInfoUpdatedAt"],"properties":{"journeys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the journey, referenced by `tickets[].fares[].journeyId`.","example":"jour_V1StGXR8Z5jdHi6BmyT2k","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].id","typeLabel":"string"},"direction":{"type":"string","enum":["DEPARTURE","RETURN"],"description":"Whether this is the outbound leg (`DEPARTURE`) or the return leg (`RETURN`).","example":"DEPARTURE","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].direction","typeLabel":"enum\u003cstring>"},"origin":{"type":"object","properties":{"iata":{"type":"string","description":"IATA code of the airport, 3 letters.","example":"GRU","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.iata","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Official name of the airport. `null` when unknown.","example":"São Paulo/Guarulhos International Airport","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Official name of the airport. `null` when unknown.","example":"São Paulo/Guarulhos International Airport","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.name","typeLabel":"string | null"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the airport. `null` when unknown.","example":"Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the airport. `null` when unknown.","example":"Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.shortAddress","typeLabel":"string | null"},"locality":{"oneOf":[{"type":"string","description":"City the airport sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"City the airport sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.locality.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.locality","typeLabel":"string | null"},"administrativeArea":{"oneOf":[{"type":"string","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.administrativeArea.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.administrativeArea.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.administrativeArea","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133334444","uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the airport, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133334444\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin.phoneNumbers","typeLabel":"string[]"}},"required":["iata","name","shortAddress","locality","administrativeArea","phoneNumbers"],"description":"Airport the journey starts at.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].origin","typeLabel":"object"},"destination":{"type":"object","properties":{"iata":{"type":"string","description":"IATA code of the airport, 3 letters.","example":"GRU","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.iata","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Official name of the airport. `null` when unknown.","example":"São Paulo/Guarulhos International Airport","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Official name of the airport. `null` when unknown.","example":"São Paulo/Guarulhos International Airport","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.name","typeLabel":"string | null"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the airport. `null` when unknown.","example":"Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the airport. `null` when unknown.","example":"Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.shortAddress","typeLabel":"string | null"},"locality":{"oneOf":[{"type":"string","description":"City the airport sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"City the airport sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.locality.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.locality","typeLabel":"string | null"},"administrativeArea":{"oneOf":[{"type":"string","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.administrativeArea.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.administrativeArea.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.administrativeArea","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133334444","uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the airport, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133334444\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination.phoneNumbers","typeLabel":"string[]"}},"required":["iata","name","shortAddress","locality","administrativeArea","phoneNumbers"],"description":"Airport the journey ends at.","example":{"iata":"SDU","name":"Rio de Janeiro/Santos Dumont Airport","shortAddress":"Rio de Janeiro, RJ, Brazil","locality":"Rio de Janeiro","administrativeArea":"RJ","phoneNumbers":["552133339999"]},"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].destination","typeLabel":"object"},"departureDate":{"type":"string","description":"Departure date and time in the local time of the origin airport, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T08:30:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].departureDate","typeLabel":"string"},"arrivalDate":{"type":"string","description":"Arrival date and time in the local time of the destination airport, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T09:35:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].arrivalDate","typeLabel":"string"},"duration":{"type":"string","description":"Total travel time of the journey, connections included, as `HH:mm`.","example":"01:05","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].duration","typeLabel":"string"},"segments":{"type":"array","items":{"type":"object","properties":{"airline":{"type":"object","properties":{"code":{"type":"string","description":"IATA code of the airline.","example":"LA","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].airline.code","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Commercial name of the airline. `null` when unknown.","example":"LATAM Airlines","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].airline.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Commercial name of the airline. `null` when unknown.","example":"LATAM Airlines","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].airline.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].airline.name","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"URL of the airline's logo. `null` when there is none.","example":"https://cdn.example.com/airlines/LA.png","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].airline.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the airline's logo. `null` when there is none.","example":"https://cdn.example.com/airlines/LA.png","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].airline.logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].airline.logo","typeLabel":"string | null"}},"required":["code","name","logo"],"description":"Airline that sells the flight.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].airline","typeLabel":"object"},"operation":{"type":"object","properties":{"code":{"type":"string","description":"IATA code of the airline.","example":"LA","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].operation.code","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Commercial name of the airline. `null` when unknown.","example":"LATAM Airlines","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].operation.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Commercial name of the airline. `null` when unknown.","example":"LATAM Airlines","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].operation.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].operation.name","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"URL of the airline's logo. `null` when there is none.","example":"https://cdn.example.com/airlines/LA.png","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].operation.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the airline's logo. `null` when there is none.","example":"https://cdn.example.com/airlines/LA.png","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].operation.logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].operation.logo","typeLabel":"string | null"}},"required":["code","name","logo"],"description":"Airline that operates the flight. It differs from `airline` on codeshare flights.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].operation","typeLabel":"object"},"origin":{"type":"object","properties":{"iata":{"type":"string","description":"IATA code of the airport, 3 letters.","example":"GRU","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.iata","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Official name of the airport. `null` when unknown.","example":"São Paulo/Guarulhos International Airport","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Official name of the airport. `null` when unknown.","example":"São Paulo/Guarulhos International Airport","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.name","typeLabel":"string | null"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the airport. `null` when unknown.","example":"Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the airport. `null` when unknown.","example":"Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.shortAddress","typeLabel":"string | null"},"locality":{"oneOf":[{"type":"string","description":"City the airport sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"City the airport sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.locality.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.locality","typeLabel":"string | null"},"administrativeArea":{"oneOf":[{"type":"string","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.administrativeArea.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.administrativeArea.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.administrativeArea","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133334444","uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the airport, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133334444\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin.phoneNumbers","typeLabel":"string[]"}},"required":["iata","name","shortAddress","locality","administrativeArea","phoneNumbers"],"description":"Airport the flight leaves from.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].origin","typeLabel":"object"},"destination":{"type":"object","properties":{"iata":{"type":"string","description":"IATA code of the airport, 3 letters.","example":"GRU","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.iata","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Official name of the airport. `null` when unknown.","example":"São Paulo/Guarulhos International Airport","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Official name of the airport. `null` when unknown.","example":"São Paulo/Guarulhos International Airport","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.name","typeLabel":"string | null"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the airport. `null` when unknown.","example":"Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the airport. `null` when unknown.","example":"Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.shortAddress","typeLabel":"string | null"},"locality":{"oneOf":[{"type":"string","description":"City the airport sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"City the airport sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.locality.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.locality","typeLabel":"string | null"},"administrativeArea":{"oneOf":[{"type":"string","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.administrativeArea.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.administrativeArea.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.administrativeArea","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133334444","uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the airport, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133334444\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination.phoneNumbers","typeLabel":"string[]"}},"required":["iata","name","shortAddress","locality","administrativeArea","phoneNumbers"],"description":"Airport the flight arrives at.","example":{"iata":"SDU","name":"Rio de Janeiro/Santos Dumont Airport","shortAddress":"Rio de Janeiro, RJ, Brazil","locality":"Rio de Janeiro","administrativeArea":"RJ","phoneNumbers":["552133339999"]},"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].destination","typeLabel":"object"},"flightNumber":{"type":"string","description":"Number of the flight, without the airline's code.","example":"3101","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightNumber","typeLabel":"string"},"departureDate":{"type":"string","description":"Departure date and time in the local time of the departure airport, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T08:30:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].departureDate","typeLabel":"string"},"arrivalDate":{"type":"string","description":"Arrival date and time in the local time of the arrival airport, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T09:35:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].arrivalDate","typeLabel":"string"},"flightType":{"type":"string","enum":["CHARTER","ALLOTMENT","REGULAR"],"description":"Kind of flight: `REGULAR`, `CHARTER` or `ALLOTMENT`.","example":"REGULAR","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightType","typeLabel":"enum\u003cstring>"},"duration":{"type":"string","description":"Duration of the flight, as `HH:mm`.","example":"01:05","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].duration","typeLabel":"string"},"equipment":{"oneOf":[{"type":"string","description":"Aircraft scheduled for the flight, as the airline identifies it. `null` when not informed.","example":"32Q","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].equipment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Aircraft scheduled for the flight, as the airline identifies it. `null` when not informed.","example":"32Q","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].equipment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].equipment","typeLabel":"string | null"},"cabin":{"type":"string","enum":["ECONOMY","PREMIUM_ECONOMY","BUSINESS","FIRST_CLASS","UNDEFINED"],"description":"Cabin booked for the flight.","example":"ECONOMY","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].cabin","typeLabel":"enum\u003cstring>"},"class":{"oneOf":[{"type":"string","description":"Booking class (RBD) priced for the flight. Each airline defines its own codes. `null` when the airline does not expose it.","example":"Y","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].class.oneOf.0","typeLabel":"string"},{"type":"null","description":"Booking class (RBD) priced for the flight. Each airline defines its own codes. `null` when the airline does not expose it.","example":"Y","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].class.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].class","typeLabel":"string | null"},"fareBasis":{"oneOf":[{"type":"string","description":"Fare basis code priced for the flight. Each airline defines its own codes. `null` when the airline does not expose it.","example":"YOW","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].fareBasis.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fare basis code priced for the flight. Each airline defines its own codes. `null` when the airline does not expose it.","example":"YOW","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].fareBasis.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].fareBasis","typeLabel":"string | null"},"flightInfo":{"oneOf":[{"description":"Live information about the flight. `null` until it is first collected, as the departure approaches.","example":null,"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["SCHEDULED","OUT_GATE","IN_AIR","LANDED","IN_GATE","CANCELED","PROPOSED","UNKNOWN",null],"description":"Operational state of the flight. `null` when there is no live status yet.","example":"SCHEDULED","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["SCHEDULED","OUT_GATE","IN_AIR","LANDED","IN_GATE","CANCELED","PROPOSED","UNKNOWN",null],"description":"Operational state of the flight. `null` when there is no live status yet.","example":"SCHEDULED","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.state","typeLabel":"enum\u003cstring> | null"},"updatedAt":{"oneOf":[{"type":"string","description":"When the live status was captured. `null` when there is no live status yet.","example":"2026-11-01T18:00:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.updatedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the live status was captured. `null` when there is no live status yet.","example":"2026-11-01T18:00:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.updatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.updatedAt","typeLabel":"string | null"},"aircraft":{"oneOf":[{"description":"Aircraft operating the flight. `null` when not known yet.","type":"object","properties":{"registration":{"oneOf":[{"type":"string","description":"Tail registration of the aircraft. `null` when not known yet.","example":"PR-XBA","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft.oneOf.0.registration.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tail registration of the aircraft. `null` when not known yet.","example":"PR-XBA","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft.oneOf.0.registration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft.oneOf.0.registration","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"ICAO code of the aircraft type. `null` when not known yet.","example":"A21N","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"ICAO code of the aircraft type. `null` when not known yet.","example":"A21N","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft.oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft.oneOf.0.type","typeLabel":"string | null"}},"required":["registration","type"],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft.oneOf.0","typeLabel":"object"},{"description":"Aircraft operating the flight. `null` when not known yet.","type":"null","properties":{"registration":{"oneOf":[{"type":"string","description":"Tail registration of the aircraft. `null` when not known yet.","example":"PR-XBA"},{"type":"null","description":"Tail registration of the aircraft. `null` when not known yet.","example":"PR-XBA"}]},"type":{"oneOf":[{"type":"string","description":"ICAO code of the aircraft type. `null` when not known yet.","example":"A21N"},{"type":"null","description":"ICAO code of the aircraft type. `null` when not known yet.","example":"A21N"}]}},"required":["registration","type"],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.aircraft","typeLabel":"object | null"},"departure":{"type":"object","properties":{"terminal":{"oneOf":[{"type":"string","description":"Terminal at the airport. `null` when not reported yet.","example":"2","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.terminal.oneOf.0","typeLabel":"string"},{"type":"null","description":"Terminal at the airport. `null` when not reported yet.","example":"2","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.terminal.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.terminal","typeLabel":"string | null"},"gate":{"oneOf":[{"type":"string","description":"Gate at the airport. `null` when not reported yet.","example":"B12","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.gate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Gate at the airport. `null` when not reported yet.","example":"B12","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.gate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.gate","typeLabel":"string | null"},"baggage":{"oneOf":[{"type":"string","description":"Baggage belt, reported for arrivals only. `null` for departures and when not reported yet.","example":"04","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.baggage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Baggage belt, reported for arrivals only. `null` for departures and when not reported yet.","example":"04","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.baggage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.baggage","typeLabel":"string | null"},"estimatedTime":{"oneOf":[{"type":"string","description":"Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet.","example":"2026-11-02T11:30:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.estimatedTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet.","example":"2026-11-02T11:30:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.estimatedTime.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.estimatedTime","typeLabel":"string | null"},"actualTime":{"oneOf":[{"type":"string","description":"Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that.","example":"2026-11-02T11:34:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.actualTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that.","example":"2026-11-02T11:34:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.actualTime.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.actualTime","typeLabel":"string | null"},"timeliness":{"oneOf":[{"type":"string","description":"Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known.","example":"OnTime","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.timeliness.oneOf.0","typeLabel":"string"},{"type":"null","description":"Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known.","example":"OnTime","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.timeliness.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.timeliness","typeLabel":"string | null"},"delayMinutes":{"oneOf":[{"type":"number","description":"Delay in minutes; negative when the flight is ahead of schedule. `null` when not known.","example":4,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.delayMinutes.oneOf.0","typeLabel":"number"},{"type":"null","description":"Delay in minutes; negative when the flight is ahead of schedule. `null` when not known.","example":4,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.delayMinutes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure.delayMinutes","typeLabel":"number | null"}},"required":["terminal","gate","baggage","estimatedTime","actualTime","timeliness","delayMinutes"],"description":"Live status at the departure airport.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.departure","typeLabel":"object"},"arrival":{"type":"object","properties":{"terminal":{"oneOf":[{"type":"string","description":"Terminal at the airport. `null` when not reported yet.","example":"2","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.terminal.oneOf.0","typeLabel":"string"},{"type":"null","description":"Terminal at the airport. `null` when not reported yet.","example":"2","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.terminal.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.terminal","typeLabel":"string | null"},"gate":{"oneOf":[{"type":"string","description":"Gate at the airport. `null` when not reported yet.","example":"B12","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.gate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Gate at the airport. `null` when not reported yet.","example":"B12","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.gate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.gate","typeLabel":"string | null"},"baggage":{"oneOf":[{"type":"string","description":"Baggage belt, reported for arrivals only. `null` for departures and when not reported yet.","example":"04","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.baggage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Baggage belt, reported for arrivals only. `null` for departures and when not reported yet.","example":"04","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.baggage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.baggage","typeLabel":"string | null"},"estimatedTime":{"oneOf":[{"type":"string","description":"Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet.","example":"2026-11-02T11:30:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.estimatedTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet.","example":"2026-11-02T11:30:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.estimatedTime.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.estimatedTime","typeLabel":"string | null"},"actualTime":{"oneOf":[{"type":"string","description":"Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that.","example":"2026-11-02T11:34:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.actualTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that.","example":"2026-11-02T11:34:00.000Z","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.actualTime.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.actualTime","typeLabel":"string | null"},"timeliness":{"oneOf":[{"type":"string","description":"Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known.","example":"OnTime","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.timeliness.oneOf.0","typeLabel":"string"},{"type":"null","description":"Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known.","example":"OnTime","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.timeliness.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.timeliness","typeLabel":"string | null"},"delayMinutes":{"oneOf":[{"type":"number","description":"Delay in minutes; negative when the flight is ahead of schedule. `null` when not known.","example":4,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.delayMinutes.oneOf.0","typeLabel":"number"},{"type":"null","description":"Delay in minutes; negative when the flight is ahead of schedule. `null` when not known.","example":4,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.delayMinutes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival.delayMinutes","typeLabel":"number | null"}},"required":["terminal","gate","baggage","estimatedTime","actualTime","timeliness","delayMinutes"],"description":"Live status at the arrival airport.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0.arrival","typeLabel":"object"}},"required":["state","updatedAt","aircraft","departure","arrival"],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.0","typeLabel":"object"},{"description":"Live information about the flight. `null` until it is first collected, as the departure approaches.","example":null,"type":"null","properties":{"state":{"oneOf":[{"type":"string","enum":["SCHEDULED","OUT_GATE","IN_AIR","LANDED","IN_GATE","CANCELED","PROPOSED","UNKNOWN",null],"description":"Operational state of the flight. `null` when there is no live status yet.","example":"SCHEDULED"},{"type":"null","enum":["SCHEDULED","OUT_GATE","IN_AIR","LANDED","IN_GATE","CANCELED","PROPOSED","UNKNOWN",null],"description":"Operational state of the flight. `null` when there is no live status yet.","example":"SCHEDULED"}]},"updatedAt":{"oneOf":[{"type":"string","description":"When the live status was captured. `null` when there is no live status yet.","example":"2026-11-01T18:00:00.000Z"},{"type":"null","description":"When the live status was captured. `null` when there is no live status yet.","example":"2026-11-01T18:00:00.000Z"}]},"aircraft":{"oneOf":[{"description":"Aircraft operating the flight. `null` when not known yet.","type":"object","properties":{"registration":{"oneOf":[{"type":"string","description":"Tail registration of the aircraft. `null` when not known yet.","example":"PR-XBA"},{"type":"null","description":"Tail registration of the aircraft. `null` when not known yet.","example":"PR-XBA"}]},"type":{"oneOf":[{"type":"string","description":"ICAO code of the aircraft type. `null` when not known yet.","example":"A21N"},{"type":"null","description":"ICAO code of the aircraft type. `null` when not known yet.","example":"A21N"}]}},"required":["registration","type"]},{"description":"Aircraft operating the flight. `null` when not known yet.","type":"null","properties":{"registration":{"oneOf":[{"type":"string","description":"Tail registration of the aircraft. `null` when not known yet.","example":"PR-XBA"},{"type":"null","description":"Tail registration of the aircraft. `null` when not known yet.","example":"PR-XBA"}]},"type":{"oneOf":[{"type":"string","description":"ICAO code of the aircraft type. `null` when not known yet.","example":"A21N"},{"type":"null","description":"ICAO code of the aircraft type. `null` when not known yet.","example":"A21N"}]}},"required":["registration","type"]}]},"departure":{"type":"object","properties":{"terminal":{"oneOf":[{"type":"string","description":"Terminal at the airport. `null` when not reported yet.","example":"2"},{"type":"null","description":"Terminal at the airport. `null` when not reported yet.","example":"2"}]},"gate":{"oneOf":[{"type":"string","description":"Gate at the airport. `null` when not reported yet.","example":"B12"},{"type":"null","description":"Gate at the airport. `null` when not reported yet.","example":"B12"}]},"baggage":{"oneOf":[{"type":"string","description":"Baggage belt, reported for arrivals only. `null` for departures and when not reported yet.","example":"04"},{"type":"null","description":"Baggage belt, reported for arrivals only. `null` for departures and when not reported yet.","example":"04"}]},"estimatedTime":{"oneOf":[{"type":"string","description":"Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet.","example":"2026-11-02T11:30:00.000Z"},{"type":"null","description":"Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet.","example":"2026-11-02T11:30:00.000Z"}]},"actualTime":{"oneOf":[{"type":"string","description":"Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that.","example":"2026-11-02T11:34:00.000Z"},{"type":"null","description":"Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that.","example":"2026-11-02T11:34:00.000Z"}]},"timeliness":{"oneOf":[{"type":"string","description":"Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known.","example":"OnTime"},{"type":"null","description":"Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known.","example":"OnTime"}]},"delayMinutes":{"oneOf":[{"type":"number","description":"Delay in minutes; negative when the flight is ahead of schedule. `null` when not known.","example":4},{"type":"null","description":"Delay in minutes; negative when the flight is ahead of schedule. `null` when not known.","example":4}]}},"required":["terminal","gate","baggage","estimatedTime","actualTime","timeliness","delayMinutes"],"description":"Live status at the departure airport."},"arrival":{"type":"object","properties":{"terminal":{"oneOf":[{"type":"string","description":"Terminal at the airport. `null` when not reported yet.","example":"2"},{"type":"null","description":"Terminal at the airport. `null` when not reported yet.","example":"2"}]},"gate":{"oneOf":[{"type":"string","description":"Gate at the airport. `null` when not reported yet.","example":"B12"},{"type":"null","description":"Gate at the airport. `null` when not reported yet.","example":"B12"}]},"baggage":{"oneOf":[{"type":"string","description":"Baggage belt, reported for arrivals only. `null` for departures and when not reported yet.","example":"04"},{"type":"null","description":"Baggage belt, reported for arrivals only. `null` for departures and when not reported yet.","example":"04"}]},"estimatedTime":{"oneOf":[{"type":"string","description":"Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet.","example":"2026-11-02T11:30:00.000Z"},{"type":"null","description":"Estimated time at the gate, in UTC (ISO 8601). `null` when not known yet.","example":"2026-11-02T11:30:00.000Z"}]},"actualTime":{"oneOf":[{"type":"string","description":"Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that.","example":"2026-11-02T11:34:00.000Z"},{"type":"null","description":"Actual time at the gate, in UTC (ISO 8601), reported once the flight operates. `null` before that.","example":"2026-11-02T11:34:00.000Z"}]},"timeliness":{"oneOf":[{"type":"string","description":"Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known.","example":"OnTime"},{"type":"null","description":"Punctuality of the flight, such as `OnTime`, `Early` or `Delayed`. `null` when not known.","example":"OnTime"}]},"delayMinutes":{"oneOf":[{"type":"number","description":"Delay in minutes; negative when the flight is ahead of schedule. `null` when not known.","example":4},{"type":"null","description":"Delay in minutes; negative when the flight is ahead of schedule. `null` when not known.","example":4}]}},"required":["terminal","gate","baggage","estimatedTime","actualTime","timeliness","delayMinutes"],"description":"Live status at the arrival airport."}},"required":["state","updatedAt","aircraft","departure","arrival"],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX].flightInfo","typeLabel":"object | null"}},"required":["airline","operation","origin","destination","flightNumber","departureDate","arrivalDate","flightType","duration","equipment","cabin","class","fareBasis","flightInfo"],"description":"One flight of a journey. A journey with connections has several.","uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments.items.[INDEX]","typeLabel":"object"},"description":"Flights of the journey, in chronological order, connections included.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX].segments","typeLabel":"object[]"}},"required":["id","direction","origin","destination","departureDate","arrivalDate","duration","segments"],"description":"One leg of the itinerary: the whole way from an origin to a destination, connections included.","uniqueKey":"productSnapshot.oneOf.0.journeys.items.[INDEX]","typeLabel":"object"},"description":"Legs of the itinerary, in travel order: one for a one-way trip, two (outbound and return) for a round trip.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.journeys","typeLabel":"object[]"},"tickets":{"type":"array","items":{"type":"object","properties":{"fareDescription":{"type":"string","description":"Readable description of the fare of the ticket.","example":"GRU to SDU, LATAM Airlines, Economy","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fareDescription","typeLabel":"string"},"ticketNumber":{"oneOf":[{"type":"string","description":"Number of the ticket, as the airline issued it. `null` until the ticket is issued.","example":null,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].ticketNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Number of the ticket, as the airline issued it. `null` until the ticket is issued.","example":null,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].ticketNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].ticketNumber","typeLabel":"string | null"},"fares":{"type":"array","items":{"type":"object","properties":{"journeyId":{"oneOf":[{"type":"string","description":"ID of the journey this fare covers — a `journeys[].id`. `null` when the fare covers the whole itinerary.","example":"jour_V1StGXR8Z5jdHi6BmyT2k","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].journeyId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the journey this fare covers — a `journeys[].id`. `null` when the fare covers the whole itinerary.","example":"jour_V1StGXR8Z5jdHi6BmyT2k","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].journeyId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].journeyId","typeLabel":"string | null"},"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].currency","typeLabel":"string"},"originalAmount":{"type":"number","description":"Fare before discounts and fees, in cents.","example":95000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].originalAmount","typeLabel":"number"},"discountAmount":{"type":"number","description":"Discount applied to the fare, in cents.","example":3010,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].discountAmount","typeLabel":"number"},"feeAmount":{"type":"number","description":"Fees added to the fare, in cents.","example":0,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].feeAmount","typeLabel":"number"},"amount":{"type":"number","description":"Total charged for the fare, in cents: `originalAmount` - `discountAmount` + `feeAmount`.","example":91990,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].amount","typeLabel":"number"},"cancellationPolicies":{"type":"object","properties":{"refundable":{"type":"boolean","description":"Whether cancelling gives any money back.","example":true,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.refundable","typeLabel":"boolean"},"immediateFine":{"type":"boolean","description":"Whether a fine applies to a cancellation made right after the booking.","example":false,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.immediateFine","typeLabel":"boolean"},"penalties":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"First day (`YYYY-MM-DD`) on which this tier applies.","example":"2026-10-25","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.penalties.items.[INDEX].from","typeLabel":"string"},"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.penalties.items.[INDEX].currency","typeLabel":"string"},"fineAmount":{"oneOf":[{"type":"number","description":"Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available.","example":15000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.penalties.items.[INDEX].fineAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available.","example":15000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.penalties.items.[INDEX].fineAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.penalties.items.[INDEX].fineAmount","typeLabel":"number | null"}},"required":["from","currency","fineAmount"],"description":"One tier of a cancellation penalty schedule.","uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.penalties.items.[INDEX]","typeLabel":"object"},"description":"Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies.penalties","typeLabel":"object[]"}},"required":["refundable","immediateFine","penalties"],"description":"Cancellation rules of the fare.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].cancellationPolicies","typeLabel":"object"},"changePolicies":{"type":"object","properties":{"canChange":{"type":"boolean","description":"Whether the fare allows the booking to be changed.","example":true,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.canChange","typeLabel":"boolean"},"immediateFine":{"type":"boolean","description":"Whether a fine applies to a change made right after the booking.","example":false,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.immediateFine","typeLabel":"boolean"},"penalties":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"First day (`YYYY-MM-DD`) on which this tier applies.","example":"2026-10-25","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.penalties.items.[INDEX].from","typeLabel":"string"},"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.penalties.items.[INDEX].currency","typeLabel":"string"},"fineAmount":{"oneOf":[{"type":"number","description":"Fine charged for changing the booking from `from` onward, in cents. `null` when the amount is not available.","example":8000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.penalties.items.[INDEX].fineAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Fine charged for changing the booking from `from` onward, in cents. `null` when the amount is not available.","example":8000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.penalties.items.[INDEX].fineAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.penalties.items.[INDEX].fineAmount","typeLabel":"number | null"}},"required":["from","currency","fineAmount"],"description":"One tier of a change penalty schedule.","uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.penalties.items.[INDEX]","typeLabel":"object"},"description":"Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies.penalties","typeLabel":"object[]"}},"required":["canChange","immediateFine","penalties"],"description":"Change rules of the fare.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX].changePolicies","typeLabel":"object"}},"required":["journeyId","currency","originalAmount","discountAmount","feeAmount","amount","cancellationPolicies","changePolicies"],"description":"The fare of a ticket for one journey, or for the whole itinerary. Amounts are integers in cents.","uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares.items.[INDEX]","typeLabel":"object"},"description":"Fares of the ticket: one per journey, or a single one for the whole itinerary.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].fares","typeLabel":"object[]"},"segments":{"type":"array","items":{"type":"object","properties":{"flightNumber":{"type":"string","description":"Number of the flight this ticket covers, without the airline's code. It matches the `flightNumber` of one of the journeys' `segments`.","example":"3101","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].flightNumber","typeLabel":"string"},"cabin":{"type":"string","enum":["ECONOMY","PREMIUM_ECONOMY","BUSINESS","FIRST_CLASS","UNDEFINED"],"description":"Cabin of the ticket on this flight.","example":"ECONOMY","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].cabin","typeLabel":"enum\u003cstring>"},"class":{"oneOf":[{"type":"string","description":"Booking class (RBD) of the ticket on this flight. Each airline defines its own codes. `null` when the airline does not expose it.","example":"Y","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].class.oneOf.0","typeLabel":"string"},{"type":"null","description":"Booking class (RBD) of the ticket on this flight. Each airline defines its own codes. `null` when the airline does not expose it.","example":"Y","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].class.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].class","typeLabel":"string | null"},"fareBasis":{"oneOf":[{"type":"string","description":"Fare basis code of the ticket on this flight. Each airline defines its own codes. `null` when the airline does not expose it.","example":"YOW","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].fareBasis.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fare basis code of the ticket on this flight. Each airline defines its own codes. `null` when the airline does not expose it.","example":"YOW","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].fareBasis.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].fareBasis","typeLabel":"string | null"},"baggages":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"number","description":"Number of pieces included in the allowance.","example":1,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].baggages.items.[INDEX].quantity","typeLabel":"number"},"weight":{"oneOf":[{"type":"number","description":"Weight allowed per piece, in kg. `null` when the airline sets no weight limit per piece.","example":23,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].baggages.items.[INDEX].weight.oneOf.0","typeLabel":"number"},{"type":"null","description":"Weight allowed per piece, in kg. `null` when the airline sets no weight limit per piece.","example":23,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].baggages.items.[INDEX].weight.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].baggages.items.[INDEX].weight","typeLabel":"number | null"},"type":{"type":"string","enum":["CHECKED","CARRY_ON","PERSONAL_ITEM"],"description":"Kind of baggage: `CHECKED`, `CARRY_ON` or `PERSONAL_ITEM`.","example":"CHECKED","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].baggages.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["quantity","weight","type"],"description":"A baggage allowance of a ticket on one flight.","uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].baggages.items.[INDEX]","typeLabel":"object"},"description":"Baggage allowance of the ticket on this flight. Empty for an infant on an adult's lap.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX].baggages","typeLabel":"object[]"}},"required":["flightNumber","cabin","class","fareBasis","baggages"],"description":"What a ticket covers on one flight of the itinerary: the cabin, the fare codes and the baggage allowance.","uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments.items.[INDEX]","typeLabel":"object"},"description":"What the ticket covers on each flight of the itinerary.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].segments","typeLabel":"object[]"},"passengerId":{"type":"string","description":"ID of the passenger holding this ticket — one of the trip's `passengers[]`. Omitted only if the passenger could not be matched to the trip's passengers.","example":"6710a3f2c9e77b0012a4d5e1","uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX].passengerId","typeLabel":"string"}},"required":["fareDescription","ticketNumber","fares","segments"],"description":"The ticket of one passenger. It covers the whole itinerary, with a fare per journey or a single fare for all of it.","uniqueKey":"productSnapshot.oneOf.0.tickets.items.[INDEX]","typeLabel":"object"},"description":"Tickets of the booking, one per passenger, each covering the whole itinerary.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.tickets","typeLabel":"object[]"},"locators":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Kind of reference, such as `PNR` for an airline's booking code.","example":"PNR","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.locators.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"The reference itself, as the supplier issued it.","example":"ABC123","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.locators.items.[INDEX].code","typeLabel":"string"}},"required":["type","code"],"description":"A reference that identifies the booking with the supplier, such as an airline's booking code.","uniqueKey":"productSnapshot.oneOf.0.locators.items.[INDEX]","typeLabel":"object"},"description":"Booking references issued by the airlines. Empty until the reservation is confirmed.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.locators","typeLabel":"object[]"},"flightInfoUpdatedAt":{"oneOf":[{"type":"string","description":"When the live flight information was last collected. `null` until it is first collected.","example":null,"format":"date-time","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.flightInfoUpdatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the live flight information was last collected. `null` until it is first collected.","example":null,"format":"date-time","isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.flightInfoUpdatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.0.flightInfoUpdatedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"productSnapshot.oneOf.0","typeLabel":"Air trip · object"},{"type":"object","title":"Hotel trip","description":"The booked product: the itinerary, stay, ticket or rental as recorded by the travel provider — journeys and flights, the hotel and its rooms, the route and boarding information, the rental — with its fares, policies and booking locators. It does not repeat the trip's own fields (`state`, `status`, the amounts, the dates) and carries no identifier of the travel provider; passengers are referenced by their `id` in `passengers[]`. Its shape depends on `vertical`: a flight (`AIR`), a hotel stay (`HOTEL`), a bus ticket (`BUS`) or a vehicle rental (`VEHICLE`) — see the four schemas below. Omitted until the record is first fetched.","required":["hotel","checkIn","checkOut","rooms","locators"],"properties":{"hotel":{"type":"object","properties":{"name":{"type":"string","description":"Official name of the hotel.","example":"Hotel Paulista Plaza","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.name","typeLabel":"string"},"chain":{"type":"object","properties":{"brandName":{"oneOf":[{"type":"string","description":"Brand within the chain. `null` when not informed.","example":"Ibis","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.brandName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brand within the chain. `null` when not informed.","example":"Ibis","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.brandName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.brandName","typeLabel":"string | null"},"chainName":{"oneOf":[{"type":"string","description":"Name of the chain. `null` for an independent hotel.","example":"Accor","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.chainName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the chain. `null` for an independent hotel.","example":"Accor","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.chainName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.chainName","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"URL of the chain's logo. `null` when the hotel has no chain with a registered logo.","example":"https://cdn.example.com/hotels/ibis.svg","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the chain's logo. `null` when the hotel has no chain with a registered logo.","example":"https://cdn.example.com/hotels/ibis.svg","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain.logo","typeLabel":"string | null"}},"required":["brandName","chainName","logo"],"description":"Chain and brand of the hotel.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.chain","typeLabel":"object"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the hotel. `null` when unknown.","example":"Av. Paulista, 1500, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the hotel. `null` when unknown.","example":"Av. Paulista, 1500, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.shortAddress","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133335555","uniqueKey":"productSnapshot.oneOf.1.hotel.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the hotel, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133335555\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.phoneNumbers","typeLabel":"string[]"},"locality":{"oneOf":[{"type":"string","description":"City the hotel sits in. `null` when unknown.","example":"São Paulo","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"City the hotel sits in. `null` when unknown.","example":"São Paulo","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.locality.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.locality","typeLabel":"string | null"},"administrativeArea":{"oneOf":[{"type":"string","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.administrativeArea.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.administrativeArea.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.administrativeArea","typeLabel":"string | null"},"checkInTime":{"oneOf":[{"type":"string","description":"Time of day, in the hotel's local time (`HH:mm`), from which guests can check in. `null` when unknown.","example":"14:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.checkInTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time of day, in the hotel's local time (`HH:mm`), from which guests can check in. `null` when unknown.","example":"14:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.checkInTime.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.checkInTime","typeLabel":"string | null"},"checkOutTime":{"oneOf":[{"type":"string","description":"Time of day, in the hotel's local time (`HH:mm`), by which guests must check out. `null` when unknown.","example":"12:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.checkOutTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time of day, in the hotel's local time (`HH:mm`), by which guests must check out. `null` when unknown.","example":"12:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.checkOutTime.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel.checkOutTime","typeLabel":"string | null"}},"required":["name","chain","shortAddress","phoneNumbers","locality","administrativeArea","checkInTime","checkOutTime"],"description":"Hotel where the stay is booked.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.hotel","typeLabel":"object"},"checkIn":{"type":"string","description":"Check-in date (`YYYY-MM-DD`).","example":"2026-11-02","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.checkIn","typeLabel":"string"},"checkOut":{"type":"string","description":"Check-out date (`YYYY-MM-DD`).","example":"2026-11-04","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.checkOut","typeLabel":"string"},"rooms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the room, as the hotel offers it.","example":"Standard Room, 1 Queen Bed","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].name","typeLabel":"string"},"fare":{"type":"object","properties":{"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.currency","typeLabel":"string"},"originalAmount":{"type":"number","description":"Fare before discounts and fees, in cents.","example":120000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.originalAmount","typeLabel":"number"},"discountAmount":{"type":"number","description":"Discount applied to the fare, in cents.","example":8000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.discountAmount","typeLabel":"number"},"feeAmount":{"type":"number","description":"Fees added to the fare, in cents.","example":0,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.feeAmount","typeLabel":"number"},"amount":{"type":"number","description":"Total charged for the fare, in cents: `originalAmount` - `discountAmount` + `feeAmount`.","example":112000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.amount","typeLabel":"number"},"boardType":{"type":"string","enum":["ONLY_ROOM","BREAKFAST","HALF_BOARD","FULL_BOARD","ALL_INCLUSIVE"],"description":"Meals included in the fare.","example":"BREAKFAST","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.boardType","typeLabel":"enum\u003cstring>"},"cancellationPolicies":{"type":"object","properties":{"refundable":{"type":"boolean","description":"Whether cancelling gives any money back.","example":true,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.refundable","typeLabel":"boolean"},"immediateFine":{"type":"boolean","description":"Whether a fine applies to a cancellation made right after the booking.","example":false,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.immediateFine","typeLabel":"boolean"},"penalties":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"First day (`YYYY-MM-DD`) on which this tier applies.","example":"2026-10-25","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].from","typeLabel":"string"},"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].currency","typeLabel":"string"},"fineAmount":{"oneOf":[{"type":"number","description":"Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available.","example":15000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available.","example":15000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount","typeLabel":"number | null"}},"required":["from","currency","fineAmount"],"description":"One tier of a cancellation penalty schedule.","uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX]","typeLabel":"object"},"description":"Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies.penalties","typeLabel":"object[]"}},"required":["refundable","immediateFine","penalties"],"description":"Cancellation rules of the fare.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare.cancellationPolicies","typeLabel":"object"}},"required":["currency","originalAmount","discountAmount","feeAmount","amount","boardType","cancellationPolicies"],"description":"Fare of the room.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].fare","typeLabel":"object"},"passengersId":{"type":"array","items":{"type":"string","example":"6710a3f2c9e77b0012a4d5e1","uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].passengersId.items.[INDEX]","typeLabel":"string"},"description":"IDs of the passengers staying in this room — the trip's `passengers[]`.\n\n---\n\nExample: `[\"6710a3f2c9e77b0012a4d5e1\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX].passengersId","typeLabel":"string[]"}},"required":["name","fare","passengersId"],"description":"A booked room.","uniqueKey":"productSnapshot.oneOf.1.rooms.items.[INDEX]","typeLabel":"object"},"description":"Rooms booked for the stay.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.rooms","typeLabel":"object[]"},"locators":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Kind of reference, such as `PNR` for an airline's booking code.","example":"PNR","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.locators.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"The reference itself, as the supplier issued it.","example":"ABC123","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.locators.items.[INDEX].code","typeLabel":"string"}},"required":["type","code"],"description":"A reference that identifies the booking with the supplier, such as an airline's booking code.","uniqueKey":"productSnapshot.oneOf.1.locators.items.[INDEX]","typeLabel":"object"},"description":"Booking references issued by the hotel. Empty until the reservation is confirmed.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.1.locators","typeLabel":"object[]"}},"uniqueKey":"productSnapshot.oneOf.1","typeLabel":"Hotel trip · object"},{"type":"object","title":"Bus trip","description":"The booked product: the itinerary, stay, ticket or rental as recorded by the travel provider — journeys and flights, the hotel and its rooms, the route and boarding information, the rental — with its fares, policies and booking locators. It does not repeat the trip's own fields (`state`, `status`, the amounts, the dates) and carries no identifier of the travel provider; passengers are referenced by their `id` in `passengers[]`. Its shape depends on `vertical`: a flight (`AIR`), a hotel stay (`HOTEL`), a bus ticket (`BUS`) or a vehicle rental (`VEHICLE`) — see the four schemas below. Omitted until the record is first fetched.","required":["type","origin","destination","departureDate","arrivalDate","company","segments","routeDirection","boardingInfo"],"properties":{"type":{"type":"string","enum":["DIRECT","CONNECTION","ONE_STOP"],"description":"Kind of trip: `DIRECT`, `CONNECTION` or `ONE_STOP`.","example":"DIRECT","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.type","typeLabel":"enum\u003cstring>"},"origin":{"type":"object","properties":{"locality":{"type":"string","description":"City the station sits in.","example":"São Paulo","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.locality","typeLabel":"string"},"administrativeArea":{"type":"string","description":"State, as its short code.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.administrativeArea","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Official name of the station. `null` when unknown.","example":"Terminal Rodoviário Tietê","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Official name of the station. `null` when unknown.","example":"Terminal Rodoviário Tietê","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.name","typeLabel":"string | null"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the station. `null` when unknown.","example":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the station. `null` when unknown.","example":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.shortAddress","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133336666","uniqueKey":"productSnapshot.oneOf.2.origin.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the station, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133336666\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin.phoneNumbers","typeLabel":"string[]"}},"required":["locality","administrativeArea","name","shortAddress","phoneNumbers"],"description":"Station the trip starts at.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.origin","typeLabel":"object"},"destination":{"type":"object","properties":{"locality":{"type":"string","description":"City the station sits in.","example":"São Paulo","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.locality","typeLabel":"string"},"administrativeArea":{"type":"string","description":"State, as its short code.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.administrativeArea","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Official name of the station. `null` when unknown.","example":"Terminal Rodoviário Tietê","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Official name of the station. `null` when unknown.","example":"Terminal Rodoviário Tietê","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.name","typeLabel":"string | null"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the station. `null` when unknown.","example":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the station. `null` when unknown.","example":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.shortAddress","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133336666","uniqueKey":"productSnapshot.oneOf.2.destination.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the station, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133336666\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination.phoneNumbers","typeLabel":"string[]"}},"required":["locality","administrativeArea","name","shortAddress","phoneNumbers"],"description":"Station the trip ends at.","example":{"locality":"Rio de Janeiro","administrativeArea":"RJ","name":"Rodoviária Novo Rio","shortAddress":"Av. Francisco Bicalho, 1, Rio de Janeiro, RJ, Brazil","phoneNumbers":["552133338888"]},"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.destination","typeLabel":"object"},"departureDate":{"type":"string","description":"Departure date and time in the local time of the origin station, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T08:30:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.departureDate","typeLabel":"string"},"arrivalDate":{"type":"string","description":"Arrival date and time in the local time of the destination station, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T14:45:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.arrivalDate","typeLabel":"string"},"company":{"type":"object","properties":{"name":{"type":"string","description":"Commercial name of the company.","example":"Expresso Brasileiro","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.company.name","typeLabel":"string"},"logo":{"oneOf":[{"type":"string","description":"URL of the company's logo. `null` when there is none.","example":"https://cdn.example.com/bus/expresso-brasileiro.png","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.company.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the company's logo. `null` when there is none.","example":"https://cdn.example.com/bus/expresso-brasileiro.png","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.company.logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.company.logo","typeLabel":"string | null"}},"required":["name","logo"],"description":"Company that operates the trip.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.company","typeLabel":"object"},"segments":{"type":"array","items":{"type":"object","properties":{"seatNumber":{"type":"number","description":"Seat reserved on the segment.","example":12,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].seatNumber","typeLabel":"number"},"serviceClass":{"type":"string","enum":["SLEEPER_BED","BED","SEMI_BED","EXECUTIVE","CONVENTIONAL","UNDEFINED"],"description":"Class of service booked for the segment.","example":"EXECUTIVE","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].serviceClass","typeLabel":"enum\u003cstring>"},"origin":{"type":"object","properties":{"locality":{"type":"string","description":"City the station sits in.","example":"São Paulo","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.locality","typeLabel":"string"},"administrativeArea":{"type":"string","description":"State, as its short code.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.administrativeArea","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Official name of the station. `null` when unknown.","example":"Terminal Rodoviário Tietê","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Official name of the station. `null` when unknown.","example":"Terminal Rodoviário Tietê","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.name","typeLabel":"string | null"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the station. `null` when unknown.","example":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the station. `null` when unknown.","example":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.shortAddress","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133336666","uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the station, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133336666\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin.phoneNumbers","typeLabel":"string[]"}},"required":["locality","administrativeArea","name","shortAddress","phoneNumbers"],"description":"Station the segment leaves from.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].origin","typeLabel":"object"},"destination":{"type":"object","properties":{"locality":{"type":"string","description":"City the station sits in.","example":"São Paulo","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.locality","typeLabel":"string"},"administrativeArea":{"type":"string","description":"State, as its short code.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.administrativeArea","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Official name of the station. `null` when unknown.","example":"Terminal Rodoviário Tietê","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Official name of the station. `null` when unknown.","example":"Terminal Rodoviário Tietê","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.name","typeLabel":"string | null"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the station. `null` when unknown.","example":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the station. `null` when unknown.","example":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.shortAddress","typeLabel":"string | null"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133336666","uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the station, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133336666\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination.phoneNumbers","typeLabel":"string[]"}},"required":["locality","administrativeArea","name","shortAddress","phoneNumbers"],"description":"Station the segment arrives at.","example":{"locality":"Rio de Janeiro","administrativeArea":"RJ","name":"Rodoviária Novo Rio","shortAddress":"Av. Francisco Bicalho, 1, Rio de Janeiro, RJ, Brazil","phoneNumbers":["552133338888"]},"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].destination","typeLabel":"object"},"departureDate":{"type":"string","description":"Departure date and time in the local time of the origin station, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T08:30:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].departureDate","typeLabel":"string"},"arrivalDate":{"type":"string","description":"Arrival date and time in the local time of the destination station, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T14:45:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].arrivalDate","typeLabel":"string"},"duration":{"oneOf":[{"type":"string","description":"Duration of the leg, as `HH:mm`. `null` when not available.","example":"06:15","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].duration.oneOf.0","typeLabel":"string"},{"type":"null","description":"Duration of the leg, as `HH:mm`. `null` when not available.","example":"06:15","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].duration","typeLabel":"string | null"},"fare":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Fare before discounts and fees, in cents.","example":18000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.originalAmount","typeLabel":"number"},"discountAmount":{"type":"number","description":"Discount applied to the fare, in cents.","example":1000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.discountAmount","typeLabel":"number"},"feeAmount":{"type":"number","description":"Fees added to the fare, in cents.","example":500,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.feeAmount","typeLabel":"number"},"amount":{"type":"number","description":"Total charged for the fare, in cents: `originalAmount` - `discountAmount` + `feeAmount`.","example":17500,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.amount","typeLabel":"number"},"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.currency","typeLabel":"string"},"cancellationPolicies":{"type":"object","properties":{"refundable":{"type":"boolean","description":"Whether cancelling gives any money back.","example":true,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.refundable","typeLabel":"boolean"},"immediateFine":{"type":"boolean","description":"Whether a fine applies to a cancellation made right after the booking.","example":false,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.immediateFine","typeLabel":"boolean"},"penalties":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"First day (`YYYY-MM-DD`) on which this tier applies.","example":"2026-10-25","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].from","typeLabel":"string"},"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].currency","typeLabel":"string"},"fineAmount":{"oneOf":[{"type":"number","description":"Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available.","example":15000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available.","example":15000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount","typeLabel":"number | null"}},"required":["from","currency","fineAmount"],"description":"One tier of a cancellation penalty schedule.","uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX]","typeLabel":"object"},"description":"Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies.penalties","typeLabel":"object[]"}},"required":["refundable","immediateFine","penalties"],"description":"Cancellation rules of the fare.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare.cancellationPolicies","typeLabel":"object"}},"required":["originalAmount","discountAmount","feeAmount","amount","currency","cancellationPolicies"],"description":"Fare of the segment.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].fare","typeLabel":"object"},"company":{"type":"object","properties":{"name":{"type":"string","description":"Commercial name of the company.","example":"Expresso Brasileiro","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].company.name","typeLabel":"string"},"logo":{"oneOf":[{"type":"string","description":"URL of the company's logo. `null` when there is none.","example":"https://cdn.example.com/bus/expresso-brasileiro.png","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].company.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the company's logo. `null` when there is none.","example":"https://cdn.example.com/bus/expresso-brasileiro.png","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].company.logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].company.logo","typeLabel":"string | null"}},"required":["name","logo"],"description":"Operator running this leg.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX].company","typeLabel":"object"}},"required":["seatNumber","serviceClass","origin","destination","departureDate","arrivalDate","duration","fare","company"],"description":"One leg of the bus trip, with the seat booked on it.","uniqueKey":"productSnapshot.oneOf.2.segments.items.[INDEX]","typeLabel":"object"},"description":"Segments of the trip, one per leg, each with its seat, fare and operator.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.segments","typeLabel":"object[]"},"routeDirection":{"type":"string","enum":["DEPARTURE","RETURN"],"description":"Whether this booking is the outbound trip (`DEPARTURE`) or the return trip (`RETURN`).","example":"DEPARTURE","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.routeDirection","typeLabel":"enum\u003cstring>"},"boardingInfo":{"oneOf":[{"description":"Boarding pass and, per leg, platform and ticket codes. `null` until it is first collected, as the departure approaches.","example":null,"type":"object","properties":{"boardingPass":{"oneOf":[{"type":"string","description":"The boarding pass PDF, base64-encoded. `null` when not available yet.","example":"JVBERi0xLjcK","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.boardingPass.oneOf.0","typeLabel":"string"},{"type":"null","description":"The boarding pass PDF, base64-encoded. `null` when not available yet.","example":"JVBERi0xLjcK","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.boardingPass.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.boardingPass","typeLabel":"string | null"},"routes":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","description":"City the leg starts in.","example":"São Paulo","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].origin","typeLabel":"string"},"destination":{"type":"string","description":"City the leg ends in.","example":"Rio de Janeiro","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].destination","typeLabel":"string"},"platform":{"oneOf":[{"type":"string","description":"Boarding platform at the origin station. `null` when not assigned or not applicable.","example":"14","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].platform.oneOf.0","typeLabel":"string"},{"type":"null","description":"Boarding platform at the origin station. `null` when not assigned or not applicable.","example":"14","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].platform.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].platform","typeLabel":"string | null"},"departureDate":{"type":"string","description":"Departure date and time in local time, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T08:30:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].departureDate","typeLabel":"string"},"arrivalDate":{"type":"string","description":"Arrival date and time in local time, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T14:45:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].arrivalDate","typeLabel":"string"},"tickets":{"type":"array","items":{"type":"object","properties":{"locators":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Kind of reference, such as `PNR` for an airline's booking code.","example":"PNR","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].locators.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"The reference itself, as the supplier issued it.","example":"ABC123","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].locators.items.[INDEX].code","typeLabel":"string"}},"required":["type","code"],"description":"A reference that identifies the booking with the supplier, such as an airline's booking code.","uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].locators.items.[INDEX]","typeLabel":"object"},"description":"Booking references of the ticket. Empty when none is available.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].locators","typeLabel":"object[]"},"ticketCode":{"oneOf":[{"type":"string","description":"Code of the ticket. `null` when not available.","example":"EB123456","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].ticketCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code of the ticket. `null` when not available.","example":"EB123456","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].ticketCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].ticketCode","typeLabel":"string | null"},"qrCode":{"oneOf":[{"type":"string","description":"The boarding QR code image, base64-encoded. `null` when not available.","example":"iVBORw0KGgo=","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].qrCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The boarding QR code image, base64-encoded. `null` when not available.","example":"iVBORw0KGgo=","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].qrCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].qrCode","typeLabel":"string | null"},"bpeNumber":{"oneOf":[{"type":"string","description":"Number of the electronic bus ticket (BP-e). `null` when not available.","example":"35261112345678000190630010000123451000123456","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].bpeNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Number of the electronic bus ticket (BP-e). `null` when not available.","example":"35261112345678000190630010000123451000123456","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].bpeNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].bpeNumber","typeLabel":"string | null"},"passengerId":{"type":"string","description":"ID of the passenger the ticket belongs to — one of the trip's `passengers[]`. Omitted only if the passenger could not be matched to the trip's passengers.","example":"6710a3f2c9e77b0012a4d5e1","uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX].passengerId","typeLabel":"string"}},"required":["locators","ticketCode","qrCode","bpeNumber"],"description":"The boarding ticket of one passenger on one leg.","uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets.items.[INDEX]","typeLabel":"object"},"description":"Tickets of the leg, one per passenger.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX].tickets","typeLabel":"object[]"}},"required":["origin","destination","platform","departureDate","arrivalDate","tickets"],"description":"The boarding details of one leg of the trip.","uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes.items.[INDEX]","typeLabel":"object"},"description":"Boarding details per leg. A connection has two legs; direct and one-stop trips have one.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0.routes","typeLabel":"object[]"}},"required":["boardingPass","routes"],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.0","typeLabel":"object"},{"description":"Boarding pass and, per leg, platform and ticket codes. `null` until it is first collected, as the departure approaches.","example":null,"type":"null","properties":{"boardingPass":{"oneOf":[{"type":"string","description":"The boarding pass PDF, base64-encoded. `null` when not available yet.","example":"JVBERi0xLjcK"},{"type":"null","description":"The boarding pass PDF, base64-encoded. `null` when not available yet.","example":"JVBERi0xLjcK"}]},"routes":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","description":"City the leg starts in.","example":"São Paulo"},"destination":{"type":"string","description":"City the leg ends in.","example":"Rio de Janeiro"},"platform":{"oneOf":[{"type":"string","description":"Boarding platform at the origin station. `null` when not assigned or not applicable.","example":"14"},{"type":"null","description":"Boarding platform at the origin station. `null` when not assigned or not applicable.","example":"14"}]},"departureDate":{"type":"string","description":"Departure date and time in local time, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T08:30:00"},"arrivalDate":{"type":"string","description":"Arrival date and time in local time, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T14:45:00"},"tickets":{"type":"array","items":{"type":"object","properties":{"passengerId":{"type":"string","description":"ID of the passenger the ticket belongs to — one of the trip's `passengers[]`. Omitted only if the passenger could not be matched to the trip's passengers.","example":"6710a3f2c9e77b0012a4d5e1"},"locators":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Kind of reference, such as `PNR` for an airline's booking code.","example":"PNR"},"code":{"type":"string","description":"The reference itself, as the supplier issued it.","example":"ABC123"}},"required":["type","code"],"description":"A reference that identifies the booking with the supplier, such as an airline's booking code."},"description":"Booking references of the ticket. Empty when none is available."},"ticketCode":{"oneOf":[{"type":"string","description":"Code of the ticket. `null` when not available.","example":"EB123456"},{"type":"null","description":"Code of the ticket. `null` when not available.","example":"EB123456"}]},"qrCode":{"oneOf":[{"type":"string","description":"The boarding QR code image, base64-encoded. `null` when not available.","example":"iVBORw0KGgo="},{"type":"null","description":"The boarding QR code image, base64-encoded. `null` when not available.","example":"iVBORw0KGgo="}]},"bpeNumber":{"oneOf":[{"type":"string","description":"Number of the electronic bus ticket (BP-e). `null` when not available.","example":"35261112345678000190630010000123451000123456"},{"type":"null","description":"Number of the electronic bus ticket (BP-e). `null` when not available.","example":"35261112345678000190630010000123451000123456"}]}},"required":["locators","ticketCode","qrCode","bpeNumber"],"description":"The boarding ticket of one passenger on one leg."},"description":"Tickets of the leg, one per passenger."}},"required":["origin","destination","platform","departureDate","arrivalDate","tickets"],"description":"The boarding details of one leg of the trip."},"description":"Boarding details per leg. A connection has two legs; direct and one-stop trips have one."}},"required":["boardingPass","routes"],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.2.boardingInfo","typeLabel":"object | null"},"passengerId":{"type":"string","description":"ID of the passenger travelling on this ticket — one of the trip's `passengers[]`. Omitted only if the passenger could not be matched to the trip's passengers.","example":"6710a3f2c9e77b0012a4d5e1","uniqueKey":"productSnapshot.oneOf.2.passengerId","typeLabel":"string"}},"uniqueKey":"productSnapshot.oneOf.2","typeLabel":"Bus trip · object"},{"type":"object","title":"Vehicle trip","description":"The booked product: the itinerary, stay, ticket or rental as recorded by the travel provider — journeys and flights, the hotel and its rooms, the route and boarding information, the rental — with its fares, policies and booking locators. It does not repeat the trip's own fields (`state`, `status`, the amounts, the dates) and carries no identifier of the travel provider; passengers are referenced by their `id` in `passengers[]`. Its shape depends on `vertical`: a flight (`AIR`), a hotel stay (`HOTEL`), a bus ticket (`BUS`) or a vehicle rental (`VEHICLE`) — see the four schemas below. Omitted until the record is first fetched.","required":["groupName","class","name","sipp","rentalCompany","pickUpLocation","dropOffLocation","pickUpDate","dropOffDate","rentals","locators"],"properties":{"groupName":{"type":"string","description":"Commercial group the vehicle belongs to, such as `ECONOMY` or `SUV`.","example":"ECONOMY","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.groupName","typeLabel":"string"},"class":{"type":"string","description":"Class of the vehicle within its group.","example":"INTERMEDIATE","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.class","typeLabel":"string"},"name":{"type":"string","description":"Name of the vehicle, as the rental company displays it.","example":"Fiat Mobi","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.name","typeLabel":"string"},"sipp":{"type":"string","description":"SIPP code that classifies the vehicle by size, doors, transmission and fuel.","example":"ECMR","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.sipp","typeLabel":"string"},"rentalCompany":{"type":"object","properties":{"code":{"type":"string","description":"Code of the rental company.","example":"LOC","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentalCompany.code","typeLabel":"string"},"name":{"type":"string","description":"Commercial name of the rental company.","example":"Localiza","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentalCompany.name","typeLabel":"string"},"logo":{"oneOf":[{"type":"string","description":"URL of the rental company's logo. `null` when the company has no registered logo.","example":"https://cdn.example.com/rentals/localiza.svg","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentalCompany.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the rental company's logo. `null` when the company has no registered logo.","example":"https://cdn.example.com/rentals/localiza.svg","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentalCompany.logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentalCompany.logo","typeLabel":"string | null"}},"required":["code","name","logo"],"description":"Rental company that holds the booking.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentalCompany","typeLabel":"object"},"pickUpLocation":{"type":"object","properties":{"name":{"type":"string","description":"Name of the rental location.","example":"Localiza Aeroporto Guarulhos (GRU)","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.name","typeLabel":"string"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133337777","uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the location, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133337777\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.phoneNumbers","typeLabel":"string[]"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the location. `null` when unknown.","example":"Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the location. `null` when unknown.","example":"Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.shortAddress","typeLabel":"string | null"},"locality":{"oneOf":[{"type":"string","description":"City the location sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"City the location sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.locality.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.locality","typeLabel":"string | null"},"administrativeArea":{"oneOf":[{"type":"string","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.administrativeArea.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.administrativeArea.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation.administrativeArea","typeLabel":"string | null"}},"required":["name","phoneNumbers","shortAddress","locality","administrativeArea"],"description":"Where the vehicle is picked up.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpLocation","typeLabel":"object"},"dropOffLocation":{"type":"object","properties":{"name":{"type":"string","description":"Name of the rental location.","example":"Localiza Aeroporto Guarulhos (GRU)","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.name","typeLabel":"string"},"phoneNumbers":{"type":"array","items":{"type":"string","example":"551133337777","uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"Contact phone numbers of the location, digits only. Empty when none is registered.\n\n---\n\nExample: `[\"551133337777\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.phoneNumbers","typeLabel":"string[]"},"shortAddress":{"oneOf":[{"type":"string","description":"Readable single-line address of the location. `null` when unknown.","example":"Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.shortAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable single-line address of the location. `null` when unknown.","example":"Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.shortAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.shortAddress","typeLabel":"string | null"},"locality":{"oneOf":[{"type":"string","description":"City the location sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"City the location sits in. `null` when unknown.","example":"Guarulhos","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.locality.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.locality","typeLabel":"string | null"},"administrativeArea":{"oneOf":[{"type":"string","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.administrativeArea.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, as its short code. `null` when unknown.","example":"SP","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.administrativeArea.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation.administrativeArea","typeLabel":"string | null"}},"required":["name","phoneNumbers","shortAddress","locality","administrativeArea"],"description":"Where the vehicle is dropped off.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffLocation","typeLabel":"object"},"pickUpDate":{"type":"string","description":"Pick-up date and time in the local time of the pick-up location, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-02T10:00:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.pickUpDate","typeLabel":"string"},"dropOffDate":{"type":"string","description":"Drop-off date and time in the local time of the drop-off location, as `YYYY-MM-DDTHH:mm:ss` with no time zone.","example":"2026-11-04T10:00:00","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.dropOffDate","typeLabel":"string"},"rentals":{"type":"array","items":{"type":"object","properties":{"description":{"oneOf":[{"type":"string","description":"Readable description of the rental option. `null` when not provided.","example":"Compact car, air conditioning, unlimited mileage","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Readable description of the rental option. `null` when not provided.","example":"Compact car, air conditioning, unlimited mileage","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].description","typeLabel":"string | null"},"fare":{"type":"object","properties":{"originalAmount":{"type":"number","description":"Fare before discounts and fees, in cents.","example":36000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.originalAmount","typeLabel":"number"},"discountAmount":{"type":"number","description":"Discount applied to the fare, in cents.","example":2000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.discountAmount","typeLabel":"number"},"feeAmount":{"type":"number","description":"Fees added to the fare, in cents.","example":0,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.feeAmount","typeLabel":"number"},"amount":{"type":"number","description":"Total charged for the fare, in cents: `originalAmount` - `discountAmount` + `feeAmount`.","example":34000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.amount","typeLabel":"number"},"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.currency","typeLabel":"string"},"cancellationPolicies":{"type":"object","properties":{"refundable":{"type":"boolean","description":"Whether cancelling gives any money back.","example":true,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.refundable","typeLabel":"boolean"},"immediateFine":{"type":"boolean","description":"Whether a fine applies to a cancellation made right after the booking.","example":false,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.immediateFine","typeLabel":"boolean"},"penalties":{"type":"array","items":{"type":"object","properties":{"from":{"oneOf":[{"type":"string","description":"First day (`YYYY-MM-DD`) on which this tier applies. `null` when the supplier gave no date.","example":"2026-10-31","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].from.oneOf.0","typeLabel":"string"},{"type":"null","description":"First day (`YYYY-MM-DD`) on which this tier applies. `null` when the supplier gave no date.","example":"2026-10-31","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].from.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].from","typeLabel":"string | null"},"currency":{"type":"string","description":"Currency, as the ISO 4217 alphabetic code.","example":"BRL","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].currency","typeLabel":"string"},"fineAmount":{"oneOf":[{"type":"number","description":"Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available.","example":12000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Fine charged for cancelling from `from` onward, in cents. `null` when the amount is not available.","example":12000,"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX].fineAmount","typeLabel":"number | null"}},"required":["from","currency","fineAmount"],"description":"One tier of the cancellation penalty schedule of a rental.","uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties.items.[INDEX]","typeLabel":"object"},"description":"Penalty tiers, each in effect from its own date. Empty when no scheduled penalty applies.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies.penalties","typeLabel":"object[]"}},"required":["refundable","immediateFine","penalties"],"description":"Cancellation rules of the fare.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare.cancellationPolicies","typeLabel":"object"}},"required":["originalAmount","discountAmount","feeAmount","amount","currency","cancellationPolicies"],"description":"Fare of the rental.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].fare","typeLabel":"object"},"passengersId":{"type":"array","items":{"type":"string","example":"6710a3f2c9e77b0012a4d5e1","uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].passengersId.items.[INDEX]","typeLabel":"string"},"description":"IDs of the passengers travelling on this rental — the trip's `passengers[]`. Empty when none was assigned.\n\n---\n\nExample: `[\"6710a3f2c9e77b0012a4d5e1\"]`","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].passengersId","typeLabel":"string[]"},"locators":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Kind of reference, such as `PNR` for an airline's booking code.","example":"PNR","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].locators.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"The reference itself, as the supplier issued it.","example":"ABC123","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].locators.items.[INDEX].code","typeLabel":"string"}},"required":["type","code"],"description":"A reference that identifies the booking with the supplier, such as an airline's booking code.","uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].locators.items.[INDEX]","typeLabel":"object"},"description":"Booking references of the rental with the rental company. Empty until the reservation is confirmed.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX].locators","typeLabel":"object[]"}},"required":["description","fare","passengersId","locators"],"description":"A booked rental.","uniqueKey":"productSnapshot.oneOf.3.rentals.items.[INDEX]","typeLabel":"object"},"description":"Rentals booked under this record.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.rentals","typeLabel":"object[]"},"locators":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Kind of reference, such as `PNR` for an airline's booking code.","example":"PNR","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.locators.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"The reference itself, as the supplier issued it.","example":"ABC123","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.locators.items.[INDEX].code","typeLabel":"string"}},"required":["type","code"],"description":"A reference that identifies the booking with the supplier, such as an airline's booking code.","uniqueKey":"productSnapshot.oneOf.3.locators.items.[INDEX]","typeLabel":"object"},"description":"Booking references of the reservation as a whole. Empty until the reservation is confirmed.","isRequired":true,"uniqueKey":"productSnapshot.oneOf.3.locators","typeLabel":"object[]"}},"uniqueKey":"productSnapshot.oneOf.3","typeLabel":"Vehicle trip · object"}],"uniqueKey":"productSnapshot","typeLabel":"Air trip · object | Hotel trip · object | Bus trip · object | Vehicle trip · object"},"cancellation":{"type":"object","properties":{"quoteId":{"type":"string","description":"ID of the confirmed cancellation quote.","isRequired":true,"uniqueKey":"cancellation.quoteId","typeLabel":"string"},"cancelType":{"type":"string","enum":["CREDIT","REFUND","MANUAL_CANCEL","VOID"],"description":"Kind of cancellation: `VOID` for a trip not issued yet, `REFUND` or `CREDIT` for an issued one, `MANUAL_CANCEL` when the amounts are settled outside the system.","isRequired":true,"uniqueKey":"cancellation.cancelType","typeLabel":"enum\u003cstring>"},"originalAmount":{"oneOf":[{"type":"number","description":"What the trip cost, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`.","uniqueKey":"cancellation.originalAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the trip cost, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`.","uniqueKey":"cancellation.originalAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.originalAmount","typeLabel":"number | null"},"remainingAmount":{"oneOf":[{"type":"number","description":"What is given back after the fine, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`.","uniqueKey":"cancellation.remainingAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"What is given back after the fine, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`.","uniqueKey":"cancellation.remainingAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.remainingAmount","typeLabel":"number | null"},"fineAmount":{"oneOf":[{"type":"number","description":"Cancellation fine, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`.","uniqueKey":"cancellation.fineAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Cancellation fine, in cents. Omitted when it couldn't be recorded; `null` for `MANUAL_CANCEL`.","uniqueKey":"cancellation.fineAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.fineAmount","typeLabel":"number | null"},"currency":{"type":"string","description":"Currency of the amounts, as the numeric ISO 4217 code (`986` is BRL).","uniqueKey":"cancellation.currency","typeLabel":"string"},"status":{"type":"string","description":"Status of the quote when it was confirmed.","uniqueKey":"cancellation.status","typeLabel":"string"},"expiresAt":{"type":"string","description":"When the quote would have expired.","format":"date-time","uniqueKey":"cancellation.expiresAt","typeLabel":"string\u003cdate-time>"},"confirmedAt":{"type":"string","description":"When the cancellation was confirmed.","format":"date-time","uniqueKey":"cancellation.confirmedAt","typeLabel":"string\u003cdate-time>"},"confirmedBy":{"type":"string","description":"ID of the user who confirmed the cancellation. Omitted when a service did.","uniqueKey":"cancellation.confirmedBy","typeLabel":"string"}},"required":["quoteId","cancelType"],"description":"The confirmed cancellation. Omitted until one is confirmed.","uniqueKey":"cancellation","typeLabel":"object"},"createdAt":{"type":"string","description":"When the trip was created.","example":"2026-10-01T13:45:12.000Z","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"When the trip last changed.","example":"2026-10-01T13:46:03.000Z","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"policy":{"type":"object","properties":{"id":{"type":"string","description":"ID of the policy that matched. Omitted when no policy matched.","example":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","format":"uuid","uniqueKey":"policy.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name of the policy that matched. Omitted when no policy matched.","example":"Flights above R$ 1,000.00","uniqueKey":"policy.name","typeLabel":"string"},"actions":{"type":"object","properties":{"autoAction":{"type":"string","enum":["APPROVE","DENY","NONE"],"description":"The decision: `APPROVE` — the trip needs no approval (also the answer when no policy matches); `DENY` — the trip is refused; `NONE` — the trip needs the approval of `approvals`.","example":"NONE","isRequired":true,"uniqueKey":"policy.actions.autoAction","typeLabel":"enum\u003cstring>"},"hierarchy":{"type":"boolean","description":"Whether the approvers decide one by one, in the order of `approvals`. Omitted when no policy matched.","example":false,"uniqueKey":"policy.actions.hierarchy","typeLabel":"boolean"},"approvals":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["USER","GROUP"],"description":"Whether the approver is a user or a group of users.","example":"USER","isRequired":true,"uniqueKey":"policy.actions.approvals.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"ID of the user or of the group.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","format":"uuid","isRequired":true,"uniqueKey":"policy.actions.approvals.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name of the user or group. Omitted when it could not be looked up in time.","example":"Carlos Andrade","uniqueKey":"policy.actions.approvals.items.[INDEX].name","typeLabel":"string"}},"required":["type","id"],"description":"An approver the policy asks for.","uniqueKey":"policy.actions.approvals.items.[INDEX]","typeLabel":"object"},"description":"Who must approve. Present when `autoAction` is `NONE`.","uniqueKey":"policy.actions.approvals","typeLabel":"object[]"}},"required":["autoAction"],"description":"The decision. Omitted when `error` is set.","uniqueKey":"policy.actions","typeLabel":"object"},"error":{"type":"string","enum":["POLICY_EVALUATION_UNAVAILABLE"],"description":"Set instead of the rest when the policies could not be evaluated right now; try again later.","example":"POLICY_EVALUATION_UNAVAILABLE","uniqueKey":"policy.error","typeLabel":"enum\u003cstring>"}},"description":"What the organization's policies decide for the trip now. Present while the trip is reserved and can be sent for approval or issued; omitted otherwise.","uniqueKey":"policy","typeLabel":"object"},"policyRequest":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval request.","example":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","format":"uuid","uniqueKey":"policyRequest.id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["REQUESTED","APPROVED","DENIED","CANCELED","EXPIRED"],"description":"Where the request is: `REQUESTED` while it waits for the approvers, then `APPROVED`, `DENIED`, `CANCELED` or `EXPIRED`.","example":"REQUESTED","uniqueKey":"policyRequest.status","typeLabel":"enum\u003cstring>"},"resolution":{"type":"string","description":"`AUTO` when the policy approved the trip by itself, without approvers. Omitted for a request decided by people.","example":"AUTO","uniqueKey":"policyRequest.resolution","typeLabel":"string"},"policyId":{"type":"string","description":"ID of the policy that asked for the approval.","example":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","format":"uuid","uniqueKey":"policyRequest.policyId","typeLabel":"string\u003cuuid>"},"requester":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","format":"uuid","isRequired":true,"uniqueKey":"policyRequest.requester.userId","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name of the user.","example":"Rafael Lima","isRequired":true,"uniqueKey":"policyRequest.requester.name","typeLabel":"string"},"email":{"type":"string","description":"E-mail of the user.","example":"rafael.lima@example.com","isRequired":true,"uniqueKey":"policyRequest.requester.email","typeLabel":"string"}},"required":["userId","name","email"],"description":"The person the request was opened for: who booked the trip.","uniqueKey":"policyRequest.requester","typeLabel":"object"},"approvalHierarchy":{"type":"boolean","description":"Whether the approvers decide one by one, in the order of `approvals`.","example":false,"uniqueKey":"policyRequest.approvalHierarchy","typeLabel":"boolean"},"approvals":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["USER","GROUP"],"description":"Whether the approval comes from a user or a group.","example":"USER","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"ID of the user or group.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","format":"uuid","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name of the user or group.","example":"Carlos Andrade","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["WAITING","REQUESTED","APPROVED","DENIED","CANCELED"],"description":"Status of this approval.","example":"REQUESTED","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"users":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","format":"uuid","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].users.items.[INDEX].userId","typeLabel":"string\u003cuuid>"},"userName":{"type":"string","description":"Name of the user.","example":"Carlos Andrade","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].users.items.[INDEX].userName","typeLabel":"string"},"userEmail":{"type":"string","description":"E-mail of the user.","example":"carlos.andrade@example.com","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].users.items.[INDEX].userEmail","typeLabel":"string"},"status":{"type":"string","enum":["WAITING","REQUESTED","APPROVED","DENIED","CANCELED"],"description":"The user's decision: `WAITING` until their turn, `REQUESTED` while they can decide, then `APPROVED`, `DENIED` or `CANCELED`.","example":"REQUESTED","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].users.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["userId","userName","userEmail","status"],"description":"One approver's decision on an approval request.","uniqueKey":"policyRequest.approvals.items.[INDEX].users.items.[INDEX]","typeLabel":"object"},"description":"The users who can decide it: one for a user, the members for a group.","isRequired":true,"uniqueKey":"policyRequest.approvals.items.[INDEX].users","typeLabel":"object[]"},"requestedAt":{"type":"string","description":"When the approval became available to its approvers.","example":"2026-10-01T13:46:10.000Z","format":"date-time","uniqueKey":"policyRequest.approvals.items.[INDEX].requestedAt","typeLabel":"string\u003cdate-time>"},"decisionAt":{"type":"string","description":"When it was decided.","format":"date-time","uniqueKey":"policyRequest.approvals.items.[INDEX].decisionAt","typeLabel":"string\u003cdate-time>"},"decisionReason":{"type":"string","description":"The reason the approver gave with the decision.","example":"Within the travel budget","uniqueKey":"policyRequest.approvals.items.[INDEX].decisionReason","typeLabel":"string"}},"required":["type","id","name","status","users"],"description":"One approval the request needs: a user, or a group of users.","uniqueKey":"policyRequest.approvals.items.[INDEX]","typeLabel":"object"},"description":"The approvals the request needs and where each one is.","uniqueKey":"policyRequest.approvals","typeLabel":"object[]"},"denialReason":{"type":"string","description":"The reason the request was denied, when the approver gave one.","example":"Over the monthly budget","uniqueKey":"policyRequest.denialReason","typeLabel":"string"},"approvalDeadline":{"type":"string","description":"When the request expires if nobody decides it.","example":"2026-10-02T12:30:00.000Z","format":"date-time","uniqueKey":"policyRequest.approvalDeadline","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","description":"When the request was created.","example":"2026-10-01T13:46:10.000Z","format":"date-time","uniqueKey":"policyRequest.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"When the request last changed.","example":"2026-10-01T14:02:31.000Z","format":"date-time","uniqueKey":"policyRequest.updatedAt","typeLabel":"string\u003cdate-time>"},"error":{"type":"string","enum":["POLICY_REQUEST_UNAVAILABLE"],"description":"Set instead of the rest when the request could not be read right now; read the trip again later.","example":"POLICY_REQUEST_UNAVAILABLE","uniqueKey":"policyRequest.error","typeLabel":"enum\u003cstring>"}},"description":"The approval request of the latest attempt. Omitted until one exists.","uniqueKey":"policyRequest","typeLabel":"object"}},"required":["customFields","id","organizationId","passengers","realmId","state","status","vertical"],"description":"A trip with what the organization's business policies say about it: the advisory `policy` while it can still be sent for approval, and the `policyRequest` once an approval request exists.","uniqueKey":"","typeLabel":"object"},"examples":{"air-trip":{"title":"air-trip","value":{"id":"6711b4c0d8e1a30012b7c9f2","realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","createdBy":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","customFields":{"cost-center":"CC-1020"},"vertical":"AIR","state":"RESERVED","status":"RESERVED","approval":{"status":"REQUESTED","policyRequestId":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","failureCode":"RESERVATION_ENDED"},"reservationExpiresAt":"2026-10-02T13:45:12.000Z","originalAmount":95000,"discountAmount":3010,"feeAmount":0,"totalAmount":91990,"currency":"986","passengers":[{"id":"6710a3f2c9e77b0012a4d5e1","userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","lead":true,"name":"Mariana Costa","gender":"FEMALE","birthDate":"1990-04-17"}],"productSnapshot":{"journeys":[{"id":"jour_V1StGXR8Z5jdHi6BmyT2k","direction":"DEPARTURE","origin":{"iata":"GRU","name":"São Paulo/Guarulhos International Airport","shortAddress":"Guarulhos, SP, Brazil","locality":"Guarulhos","administrativeArea":"SP","phoneNumbers":["551133334444"]},"destination":{"iata":"SDU","name":"Rio de Janeiro/Santos Dumont Airport","shortAddress":"Rio de Janeiro, RJ, Brazil","locality":"Rio de Janeiro","administrativeArea":"RJ","phoneNumbers":["552133339999"]},"departureDate":"2026-11-02T08:30:00","arrivalDate":"2026-11-02T09:35:00","duration":"01:05","segments":[{"airline":{"code":"LA","name":"LATAM Airlines","logo":"https://cdn.example.com/airlines/LA.png"},"operation":{"code":"LA","name":"LATAM Airlines","logo":"https://cdn.example.com/airlines/LA.png"},"origin":{"iata":"GRU","name":"São Paulo/Guarulhos International Airport","shortAddress":"Guarulhos, SP, Brazil","locality":"Guarulhos","administrativeArea":"SP","phoneNumbers":["551133334444"]},"destination":{"iata":"SDU","name":"Rio de Janeiro/Santos Dumont Airport","shortAddress":"Rio de Janeiro, RJ, Brazil","locality":"Rio de Janeiro","administrativeArea":"RJ","phoneNumbers":["552133339999"]},"flightNumber":"3101","departureDate":"2026-11-02T08:30:00","arrivalDate":"2026-11-02T09:35:00","flightType":"REGULAR","duration":"01:05","equipment":"32Q","cabin":"ECONOMY","class":"Y","fareBasis":"YOW","flightInfo":null}]}],"tickets":[{"passengerId":"6710a3f2c9e77b0012a4d5e1","fareDescription":"GRU to SDU, LATAM Airlines, Economy","ticketNumber":null,"fares":[{"journeyId":"jour_V1StGXR8Z5jdHi6BmyT2k","currency":"BRL","originalAmount":95000,"discountAmount":3010,"feeAmount":0,"amount":91990,"cancellationPolicies":{"refundable":true,"immediateFine":false,"penalties":[{"from":"2026-10-25","currency":"BRL","fineAmount":15000}]},"changePolicies":{"canChange":true,"immediateFine":false,"penalties":[{"from":"2026-10-25","currency":"BRL","fineAmount":8000}]}}],"segments":[{"flightNumber":"3101","cabin":"ECONOMY","class":"Y","fareBasis":"YOW","baggages":[{"quantity":1,"weight":23,"type":"CHECKED"}]}]}],"locators":[{"type":"PNR","code":"ABC123"}],"flightInfoUpdatedAt":null},"createdAt":"2026-10-01T13:45:12.000Z","updatedAt":"2026-10-01T13:46:03.000Z","policy":{"id":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","name":"Flights above R$ 1,000.00","actions":{"autoAction":"NONE","hierarchy":false,"approvals":[{"type":"USER","id":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Carlos Andrade"}]},"error":"POLICY_EVALUATION_UNAVAILABLE"},"policyRequest":{"id":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","status":"REQUESTED","resolution":"AUTO","policyId":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","requester":{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Rafael Lima","email":"rafael.lima@example.com"},"approvalHierarchy":false,"approvals":[{"type":"USER","id":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Carlos Andrade","status":"REQUESTED","users":[{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","userName":"Carlos Andrade","userEmail":"carlos.andrade@example.com","status":"REQUESTED"}],"requestedAt":"2026-10-01T13:46:10.000Z","decisionReason":"Within the travel budget"}],"denialReason":"Over the monthly budget","approvalDeadline":"2026-10-02T12:30:00.000Z","createdAt":"2026-10-01T13:46:10.000Z","updatedAt":"2026-10-01T14:02:31.000Z","error":"POLICY_REQUEST_UNAVAILABLE"}}},"hotel-trip":{"title":"hotel-trip","value":{"id":"6711b4c0d8e1a30012b7c9f2","realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","createdBy":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","customFields":{"cost-center":"CC-1020"},"vertical":"HOTEL","state":"RESERVED","status":"RESERVED","approval":{"status":"REQUESTED","policyRequestId":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","failureCode":"RESERVATION_ENDED"},"reservationExpiresAt":"2026-10-02T13:45:12.000Z","originalAmount":95000,"discountAmount":3010,"feeAmount":0,"totalAmount":91990,"currency":"986","passengers":[{"id":"6710a3f2c9e77b0012a4d5e1","userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","lead":true,"name":"Mariana Costa","gender":"FEMALE","birthDate":"1990-04-17"}],"productSnapshot":{"hotel":{"name":"Hotel Paulista Plaza","chain":{"brandName":"Ibis","chainName":"Accor","logo":"https://cdn.example.com/hotels/ibis.svg"},"shortAddress":"Av. Paulista, 1500, São Paulo, SP, Brazil","phoneNumbers":["551133335555"],"locality":"São Paulo","administrativeArea":"SP","checkInTime":"14:00","checkOutTime":"12:00"},"checkIn":"2026-11-02","checkOut":"2026-11-04","rooms":[{"name":"Standard Room, 1 Queen Bed","fare":{"currency":"BRL","originalAmount":120000,"discountAmount":8000,"feeAmount":0,"amount":112000,"boardType":"BREAKFAST","cancellationPolicies":{"refundable":true,"immediateFine":false,"penalties":[{"from":"2026-10-25","currency":"BRL","fineAmount":15000}]}},"passengersId":["6710a3f2c9e77b0012a4d5e1"]}],"locators":[{"type":"PNR","code":"ABC123"}]},"createdAt":"2026-10-01T13:45:12.000Z","updatedAt":"2026-10-01T13:46:03.000Z","policy":{"id":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","name":"Flights above R$ 1,000.00","actions":{"autoAction":"NONE","hierarchy":false,"approvals":[{"type":"USER","id":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Carlos Andrade"}]},"error":"POLICY_EVALUATION_UNAVAILABLE"},"policyRequest":{"id":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","status":"REQUESTED","resolution":"AUTO","policyId":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","requester":{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Rafael Lima","email":"rafael.lima@example.com"},"approvalHierarchy":false,"approvals":[{"type":"USER","id":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Carlos Andrade","status":"REQUESTED","users":[{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","userName":"Carlos Andrade","userEmail":"carlos.andrade@example.com","status":"REQUESTED"}],"requestedAt":"2026-10-01T13:46:10.000Z","decisionReason":"Within the travel budget"}],"denialReason":"Over the monthly budget","approvalDeadline":"2026-10-02T12:30:00.000Z","createdAt":"2026-10-01T13:46:10.000Z","updatedAt":"2026-10-01T14:02:31.000Z","error":"POLICY_REQUEST_UNAVAILABLE"}}},"bus-trip":{"title":"bus-trip","value":{"id":"6711b4c0d8e1a30012b7c9f2","realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","createdBy":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","customFields":{"cost-center":"CC-1020"},"vertical":"BUS","state":"RESERVED","status":"RESERVED","approval":{"status":"REQUESTED","policyRequestId":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","failureCode":"RESERVATION_ENDED"},"reservationExpiresAt":"2026-10-02T13:45:12.000Z","originalAmount":95000,"discountAmount":3010,"feeAmount":0,"totalAmount":91990,"currency":"986","passengers":[{"id":"6710a3f2c9e77b0012a4d5e1","userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","lead":true,"name":"Mariana Costa","gender":"FEMALE","birthDate":"1990-04-17"}],"productSnapshot":{"type":"DIRECT","origin":{"locality":"São Paulo","administrativeArea":"SP","name":"Terminal Rodoviário Tietê","shortAddress":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","phoneNumbers":["551133336666"]},"destination":{"locality":"Rio de Janeiro","administrativeArea":"RJ","name":"Rodoviária Novo Rio","shortAddress":"Av. Francisco Bicalho, 1, Rio de Janeiro, RJ, Brazil","phoneNumbers":["552133338888"]},"departureDate":"2026-11-02T08:30:00","arrivalDate":"2026-11-02T14:45:00","company":{"name":"Expresso Brasileiro","logo":"https://cdn.example.com/bus/expresso-brasileiro.png"},"passengerId":"6710a3f2c9e77b0012a4d5e1","segments":[{"seatNumber":12,"serviceClass":"EXECUTIVE","origin":{"locality":"São Paulo","administrativeArea":"SP","name":"Terminal Rodoviário Tietê","shortAddress":"Av. Cruzeiro do Sul, 1800, São Paulo, SP, Brazil","phoneNumbers":["551133336666"]},"destination":{"locality":"Rio de Janeiro","administrativeArea":"RJ","name":"Rodoviária Novo Rio","shortAddress":"Av. Francisco Bicalho, 1, Rio de Janeiro, RJ, Brazil","phoneNumbers":["552133338888"]},"departureDate":"2026-11-02T08:30:00","arrivalDate":"2026-11-02T14:45:00","duration":"06:15","fare":{"originalAmount":18000,"discountAmount":1000,"feeAmount":500,"amount":17500,"currency":"BRL","cancellationPolicies":{"refundable":true,"immediateFine":false,"penalties":[{"from":"2026-10-25","currency":"BRL","fineAmount":15000}]}},"company":{"name":"Expresso Brasileiro","logo":"https://cdn.example.com/bus/expresso-brasileiro.png"}}],"routeDirection":"DEPARTURE","boardingInfo":null},"createdAt":"2026-10-01T13:45:12.000Z","updatedAt":"2026-10-01T13:46:03.000Z","policy":{"id":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","name":"Flights above R$ 1,000.00","actions":{"autoAction":"NONE","hierarchy":false,"approvals":[{"type":"USER","id":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Carlos Andrade"}]},"error":"POLICY_EVALUATION_UNAVAILABLE"},"policyRequest":{"id":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","status":"REQUESTED","resolution":"AUTO","policyId":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","requester":{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Rafael Lima","email":"rafael.lima@example.com"},"approvalHierarchy":false,"approvals":[{"type":"USER","id":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Carlos Andrade","status":"REQUESTED","users":[{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","userName":"Carlos Andrade","userEmail":"carlos.andrade@example.com","status":"REQUESTED"}],"requestedAt":"2026-10-01T13:46:10.000Z","decisionReason":"Within the travel budget"}],"denialReason":"Over the monthly budget","approvalDeadline":"2026-10-02T12:30:00.000Z","createdAt":"2026-10-01T13:46:10.000Z","updatedAt":"2026-10-01T14:02:31.000Z","error":"POLICY_REQUEST_UNAVAILABLE"}}},"vehicle-trip":{"title":"vehicle-trip","value":{"id":"6711b4c0d8e1a30012b7c9f2","realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","createdBy":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","customFields":{"cost-center":"CC-1020"},"vertical":"VEHICLE","state":"RESERVED","status":"RESERVED","approval":{"status":"REQUESTED","policyRequestId":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","failureCode":"RESERVATION_ENDED"},"reservationExpiresAt":"2026-10-02T13:45:12.000Z","originalAmount":95000,"discountAmount":3010,"feeAmount":0,"totalAmount":91990,"currency":"986","passengers":[{"id":"6710a3f2c9e77b0012a4d5e1","userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","lead":true,"name":"Mariana Costa","gender":"FEMALE","birthDate":"1990-04-17"}],"productSnapshot":{"groupName":"ECONOMY","class":"INTERMEDIATE","name":"Fiat Mobi","sipp":"ECMR","rentalCompany":{"code":"LOC","name":"Localiza","logo":"https://cdn.example.com/rentals/localiza.svg"},"pickUpLocation":{"name":"Localiza Aeroporto Guarulhos (GRU)","phoneNumbers":["551133337777"],"shortAddress":"Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil","locality":"Guarulhos","administrativeArea":"SP"},"dropOffLocation":{"name":"Localiza Aeroporto Guarulhos (GRU)","phoneNumbers":["551133337777"],"shortAddress":"Rod. Hélio Smidt, s/n, Guarulhos, SP, Brazil","locality":"Guarulhos","administrativeArea":"SP"},"pickUpDate":"2026-11-02T10:00:00","dropOffDate":"2026-11-04T10:00:00","rentals":[{"description":"Compact car, air conditioning, unlimited mileage","fare":{"originalAmount":36000,"discountAmount":2000,"feeAmount":0,"amount":34000,"currency":"BRL","cancellationPolicies":{"refundable":true,"immediateFine":false,"penalties":[{"from":"2026-10-31","currency":"BRL","fineAmount":12000}]}},"passengersId":["6710a3f2c9e77b0012a4d5e1"],"locators":[{"type":"PNR","code":"ABC123"}]}],"locators":[{"type":"PNR","code":"ABC123"}]},"createdAt":"2026-10-01T13:45:12.000Z","updatedAt":"2026-10-01T13:46:03.000Z","policy":{"id":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","name":"Flights above R$ 1,000.00","actions":{"autoAction":"NONE","hierarchy":false,"approvals":[{"type":"USER","id":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Carlos Andrade"}]},"error":"POLICY_EVALUATION_UNAVAILABLE"},"policyRequest":{"id":"b7f1c0d2-4e3a-4f8b-9c21-7a6d5e4f3b2a","status":"REQUESTED","resolution":"AUTO","policyId":"3c9e5a17-8d24-4b6f-a0e1-52f7c1d8b9a3","requester":{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Rafael Lima","email":"rafael.lima@example.com"},"approvalHierarchy":false,"approvals":[{"type":"USER","id":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Carlos Andrade","status":"REQUESTED","users":[{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","userName":"Carlos Andrade","userEmail":"carlos.andrade@example.com","status":"REQUESTED"}],"requestedAt":"2026-10-01T13:46:10.000Z","decisionReason":"Within the travel budget"}],"denialReason":"Over the monthly budget","approvalDeadline":"2026-10-02T12:30:00.000Z","createdAt":"2026-10-01T13:46:10.000Z","updatedAt":"2026-10-01T14:02:31.000Z","error":"POLICY_REQUEST_UNAVAILABLE"}}}},"exampleType":"examples"}},"exampleType":"examples"},"70cdac93-dccc-44e8-b777-f5e74e4c0411":{"description":"`TRIP_NOT_RESERVED` — No policy requires an approval, so the trip was issued directly, but its reservation ended before that could happen.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["TRIP_NOT_RESERVED"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["TRAVEL"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_NOT_RESERVED","origin":"TRAVEL","message":"Trip not reserved"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_NOT_RESERVED","origin":"TRAVEL","message":"Trip not reserved"}}},"exampleType":"examples"}},"exampleType":"examples"},"0b7307ca-dfaa-4ab8-ab88-d69bbce15999":{"description":"`TRIP_POLICY_DENIED` — A business policy refuses this trip outright; it can't be sent for approval.\n\n`TRIP_CALLER_FORBIDDEN` — Only users and operators can send a trip for approval.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["TRIP_POLICY_DENIED","TRIP_CALLER_FORBIDDEN"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["TRAVEL"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_POLICY_DENIED","origin":"TRAVEL","message":"A business policy of the organization doesn't allow this trip"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_POLICY_DENIED","origin":"TRAVEL","message":"A business policy of the organization doesn't allow this trip"}}},"exampleType":"examples"}},"exampleType":"examples"},"2744a0dd-baa6-448b-af1a-d67ee1209d9e":{"description":"`TRIP_NOT_FOUND` — No trip with this ID is visible to you in the organization: it doesn't exist, belongs to another organization, or you are neither an organization admin, a passenger on it nor the user who booked it.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["TRIP_NOT_FOUND"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["TRAVEL"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_NOT_FOUND","origin":"TRAVEL","message":"Trip not found"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_NOT_FOUND","origin":"TRAVEL","message":"Trip not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"92f3d575-3e53-4c81-b4d8-5eb5f606ac70":{"description":"`TRIP_NOT_REQUESTABLE` — The trip can't be sent for approval: it is not reserved, it is not a flight or bus trip, its booking details are not loaded yet, or its reservation expires too soon for an approval to finish, or it is already being issued. The message says which.\n\n`TRIP_APPROVAL_DENIED` — The approval of this trip was already denied.\n\n`TRIP_ISSUE_IN_PROGRESS` — The trip is already being issued.\n\n`TRIP_CHANGED_SINCE_APPROVAL` — The booking changed while the request was being processed, so the evaluation no longer describes it. Send it again.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["TRIP_NOT_REQUESTABLE","TRIP_APPROVAL_DENIED","TRIP_ISSUE_IN_PROGRESS","TRIP_CHANGED_SINCE_APPROVAL"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["TRAVEL"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_NOT_REQUESTABLE","origin":"TRAVEL","message":"The trip is not reserved, so it can't be sent for approval (it must be reserved and not yet issued or canceled)"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_NOT_REQUESTABLE","origin":"TRAVEL","message":"The trip is not reserved, so it can't be sent for approval (it must be reserved and not yet issued or canceled)"}}},"exampleType":"examples"}},"exampleType":"examples"},"b3f415b2-993a-4190-a7e1-ef44ee47aaea":{"description":"`TRIP_REQUESTER_UNRESOLVABLE` — The trip has no recorded requester and the user who booked it could not be found.\n\n`BAD_REQUEST` — A path parameter is not a valid ID; `fields` lists each one.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["TRIP_REQUESTER_UNRESOLVABLE","BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["TRAVEL"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"fields":{"type":"array","description":"One entry per invalid request field (validation errors only).","items":{"type":"object","properties":{"field":{"type":"string","description":"Path of the invalid field, e.g. `label` or `values[0].value`.","example":"label","isRequired":true,"uniqueKey":"fields.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Why the field was rejected.","example":"label is required","isRequired":true,"uniqueKey":"fields.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"`\u003cFIELD>_\u003cREASON>` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.","example":"LABEL_REQUIRED","isRequired":true,"uniqueKey":"fields.items.[INDEX].code","typeLabel":"string"},"values":{"type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"description":"The accepted values, when the field is an enumeration.","uniqueKey":"fields.items.[INDEX].values","typeLabel":"string[]"}},"required":["field","message","code"],"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields","typeLabel":"object[]"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_REQUESTER_UNRESOLVABLE","origin":"TRAVEL","message":"The user who booked the trip could not be resolved, so it can't be sent for approval"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"TRIP_REQUESTER_UNRESOLVABLE","origin":"TRAVEL","message":"The user who booked the trip could not be resolved, so it can't be sent for approval"}}},"exampleType":"examples"}},"exampleType":"examples"},"9aefc8a6-3ae6-49bf-81ec-9b7b39d77235":{"description":"`POLICY_EVALUATION_UNAVAILABLE` — The business policies could not be evaluated. Nothing was issued; retry later.\n\n`PROVIDER_UNAVAILABLE` — The travel provider could not be reached. Retry later.\n\n`TRIP_CONCURRENT_UPDATE` — The trip kept changing while the request was processed. Retry.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["POLICY_EVALUATION_UNAVAILABLE","PROVIDER_UNAVAILABLE","TRIP_CONCURRENT_UPDATE"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["TRAVEL"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"POLICY_EVALUATION_UNAVAILABLE","origin":"TRAVEL","message":"Business policy evaluation temporarily unavailable, please retry."},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"POLICY_EVALUATION_UNAVAILABLE","origin":"TRAVEL","message":"Business policy evaluation temporarily unavailable, please retry."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"8f4f4a8b-8ee1-4e3a-aab6-6bf757e1cac7":{"url":"https://api.travel.v2.portao3.com.br/","description":"production"},"60ed1897-d183-4b96-8157-90e3d8c651fb":{"url":"https://api.travel.dev.3pers.com.br/","description":"development"}}},"originalFileLocation":"api-reference/travel.openapi.json"},"subdomain":"porto3","siteName":"Portão 3","title":"Send a trip for approval - Portão 3","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/travel/trips/send-a-trip-for-approval","matchLevel":0},"pt-BR":{"href":"/api-reference/travel/trips/send-a-trip-for-approval","matchLevel":0}}},"lastModified":"2026-11-06T22:42:40.422Z","originalFileLocation":"api-reference/travel/trips/send-a-trip-for-approval.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Sends a reserved trip for approval.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Portão 3\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send a trip for approval - Portão 3\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sends a reserved trip for approval.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Portão 3\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://porto3.mintlify.site/_mintlify/api/og/v2?division=Trips\u0026amp;title=Send+a+trip+for+approval\u0026amp;description=Sends+a+reserved+trip+for+approval.\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=9ec6ce4559610aff4484d261f474e4ee5982e09f1a80d6c53956bf4b6b2e66a5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Send a trip for approval - Portão 3\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sends a reserved trip for approval.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://porto3.mintlify.site/_mintlify/api/og/v2?division=Trips\u0026amp;title=Send+a+trip+for+approval\u0026amp;description=Sends+a+reserved+trip+for+approval.\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=9ec6ce4559610aff4484d261f474e4ee5982e09f1a80d6c53956bf4b6b2e66a5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Portão 3\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#43418E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/travel/trips/send-a-trip-for-approval.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.portao3.com.br/#organization\",\"name\":\"Portão 3\",\"url\":\"https://developers.portao3.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/light.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=9a15f0d9bfb0f9aeefa58cc02e0274c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.portao3.com.br#website\",\"name\":\"Portão 3\",\"url\":\"https://developers.portao3.com.br\",\"publisher\":{\"@id\":\"https://developers.portao3.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval#webpage\",\"url\":\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval\",\"name\":\"Send a trip for approval\",\"description\":\"Sends a reserved trip for approval.\",\"dateModified\":\"2026-11-06T22:42:40.422Z\",\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Travel\",\"item\":\"https://developers.portao3.com.br/api-reference/travel/passengers/list-an-organizations-passengers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Trips\",\"item\":\"https://developers.portao3.com.br/api-reference/travel/trips/list-the-realms-trips\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Send a trip for approval\",\"item\":\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval#apireference\",\"headline\":\"Send a trip for approval\",\"name\":\"Send a trip for approval\",\"description\":\"Sends a reserved trip for approval.\",\"url\":\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval\",\"mainEntityOfPage\":{\"@id\":\"https://developers.portao3.com.br/api-reference/travel/trips/send-a-trip-for-approval#webpage\"},\"dateModified\":\"2026-11-06T22:42:40.422Z\",\"publisher\":{\"@id\":\"https://developers.portao3.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Portão 3\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Portão 3","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"},{"title":"Pagination","href":"/api-reference/pagination"}]},{"group":"Identity","pages":[{"group":"Authentication","pages":[{"title":"Sign in","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /auth/sign-in","href":"/api-reference/identity/authentication/sign-in"}]},{"group":"Current User","pages":[{"title":"Get the current API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /me","href":"/api-reference/identity/current-user/get-the-current-api-client"}]},{"group":"Custom Fields","pages":[{"title":"List an organization's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/list-an-organizations-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/create-a-custom-field"},{"title":"Get a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/get-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/update-a-custom-field"},{"title":"Activate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/activate","href":"/api-reference/identity/custom-fields/activate-a-custom-field"},{"title":"Deactivate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/deactivate","href":"/api-reference/identity/custom-fields/deactivate-a-custom-field"}]},{"group":"API Clients","pages":[{"title":"List the realm's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/list-the-realms-api-clients"},{"title":"List an organization's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients","href":"/api-reference/identity/api-clients/list-an-organizations-api-clients"},{"title":"Create an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/create-an-api-client"},{"title":"Deactivate an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients/{appClientId}/deactivate","href":"/api-reference/identity/api-clients/deactivate-an-api-client"}]},{"group":"Users","pages":[{"title":"List the realm's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users","href":"/api-reference/identity/users/list-the-realms-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users","href":"/api-reference/identity/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json patch /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/update-a-user"},{"title":"Activate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/activate","href":"/api-reference/identity/users/activate-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/deactivate","href":"/api-reference/identity/users/deactivate-a-user"},{"title":"List an organization's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users","href":"/api-reference/identity/users/list-an-organizations-users"},{"title":"Assign a user to an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/assign","href":"/api-reference/identity/users/assign-a-user-to-an-organization"},{"title":"Revoke a user from an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/revoke","href":"/api-reference/identity/users/revoke-a-user-from-an-organization"},{"title":"Export organization users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/report","href":"/api-reference/identity/users/export-organization-users"}]},{"group":"Organizations","pages":[{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}","href":"/api-reference/identity/organizations/get-an-organization"}]},{"group":"Groups","pages":[{"title":"List an organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/list-an-organizations-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/create-a-group"},{"title":"Get a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/get-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/update-a-group"},{"title":"Archive a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups/{groupId}/archive","href":"/api-reference/identity/groups/archive-a-group"}]},{"group":"Realms","pages":[{"title":"Get your realm","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}","href":"/api-reference/identity/realms/get-your-realm"}]}]},{"group":"Banking","pages":[{"group":"Accounts","pages":[{"title":"List the realm's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/accounts","href":"/api-reference/banking/accounts/list-the-realms-accounts"},{"title":"List an organization's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts","href":"/api-reference/banking/accounts/list-an-organizations-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}","href":"/api-reference/banking/accounts/get-an-account"},{"title":"Get an account's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/balance","href":"/api-reference/banking/accounts/get-an-accounts-closing-balance"},{"title":"Get a wallet's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/balance","href":"/api-reference/banking/accounts/get-a-wallets-closing-balance"}]},{"group":"Account Limits","pages":[{"title":"List the realm's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/account-limits","href":"/api-reference/banking/account-limits/list-the-realms-account-limits"},{"title":"List an organization's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/account-limits","href":"/api-reference/banking/account-limits/list-an-organizations-account-limits"},{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits","href":"/api-reference/banking/account-limits/get-account-limits"}]},{"group":"Wallets","pages":[{"title":"List the realm's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/wallets","href":"/api-reference/banking/wallets/list-the-realms-wallets"},{"title":"List an organization's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/banking/wallets/list-an-organizations-wallets"},{"title":"List an account's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/list-an-accounts-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/create-a-wallet"},{"title":"Export wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/export","href":"/api-reference/banking/wallets/export-wallets"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/update-a-wallet"},{"title":"Cancel a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cancel","href":"/api-reference/banking/wallets/cancel-a-wallet"},{"title":"Block a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block","href":"/api-reference/banking/wallets/block-a-wallet"},{"title":"Unblock a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock","href":"/api-reference/banking/wallets/unblock-a-wallet"},{"title":"Empty a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance","href":"/api-reference/banking/wallets/empty-a-wallet"}]},{"group":"Transaction Limits","pages":[{"title":"Get transaction limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/get-transaction-limits"},{"title":"Update a transaction limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/update-a-transaction-limit"}]},{"group":"Transfers","pages":[{"title":"List a wallet's transfer requests","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/list-a-wallets-transfer-requests"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/create-a-transfer-request"},{"title":"Get a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/get-a-transfer-request"},{"title":"Update a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/update-a-transfer-request"},{"title":"Send a transfer request for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/banking/transfers/send-a-transfer-request-for-approval"},{"title":"Confirm a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/banking/transfers/confirm-a-transfer-request"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/banking/transfers/cancel-a-transfer-request"}]},{"group":"Cards","pages":[{"title":"List the realm's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/cards","href":"/api-reference/banking/cards/list-the-realms-cards"},{"title":"List an organization's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/banking/cards/list-an-organizations-cards"},{"title":"List an account's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards","href":"/api-reference/banking/cards/list-an-accounts-cards"},{"title":"List a wallet's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/list-a-wallets-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/update-a-card"},{"title":"Get card details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/banking/cards/get-card-details"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/banking/cards/block-a-card"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/banking/cards/unblock-a-card"},{"title":"Set a card's PIN","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/banking/cards/set-a-cards-pin"},{"title":"List a card's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/banking/cards/list-a-cards-transactions"},{"title":"Get a card's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/banking/cards/get-a-cards-transaction-totals"},{"title":"Export card transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/banking/cards/export-card-transactions"}]},{"group":"Card Limits","pages":[{"title":"List the realm's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-the-realms-card-limit-rules"},{"title":"List an organization's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-organizations-card-limit-rules"},{"title":"List an account's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-accounts-card-limit-rules"},{"title":"Create a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/create-a-card-limit-rule"},{"title":"Get a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/get-a-card-limit-rule"},{"title":"Update a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/update-a-card-limit-rule"},{"title":"Create a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit","href":"/api-reference/banking/card-limits/create-a-card-limit"},{"title":"Get a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/get-a-card-limit"},{"title":"Delete a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/delete-a-card-limit"},{"title":"List a card's limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit","href":"/api-reference/banking/card-limits/list-a-cards-limits"}]},{"group":"Cards 3DS","pages":[{"title":"List an account's 3D Secure challenges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds","href":"/api-reference/banking/cards-3ds/list-an-accounts-3d-secure-challenges"},{"title":"Answer a 3D Secure challenge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit","href":"/api-reference/banking/cards-3ds/answer-a-3d-secure-challenge"}]},{"group":"Pix Payments","pages":[{"title":"List the realm's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix","href":"/api-reference/banking/pix-payments/list-the-realms-pix-payments"},{"title":"List an organization's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix","href":"/api-reference/banking/pix-payments/list-an-organizations-pix-payments"},{"title":"List an account's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix","href":"/api-reference/banking/pix-payments/list-an-accounts-pix-payments"},{"title":"List a wallet's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/list-a-wallets-pix-payments"},{"title":"Create a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/create-a-pix-payment"},{"title":"Get a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/get-a-pix-payment"},{"title":"Set a Pix payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/set-a-pix-payments-details"},{"title":"Send a Pix payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/banking/pix-payments/send-a-pix-payment-for-approval"},{"title":"Confirm a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/banking/pix-payments/confirm-a-pix-payment"},{"title":"Cancel a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/banking/pix-payments/cancel-a-pix-payment"}]},{"group":"Pix Keys","pages":[{"title":"List the realm's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-dict","href":"/api-reference/banking/pix-keys/list-the-realms-pix-keys"},{"title":"List an organization's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-keys"},{"title":"List an account's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-accounts-pix-keys"},{"title":"List a wallet's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/list-a-wallets-pix-keys"},{"title":"Register a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/register-a-pix-key"},{"title":"Request a Pix key confirmation code","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp","href":"/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code"},{"title":"Confirm a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key"},{"title":"Remove a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove","href":"/api-reference/banking/pix-keys/remove-a-pix-key"},{"title":"List an organization's Pix key claims","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict-claim","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-key-claims"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel","href":"/api-reference/banking/pix-keys/cancel-a-pix-key-claim"}]},{"group":"Pix Billing","pages":[{"title":"List the realm's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-billing/list-the-realms-pix-charges"},{"title":"List an organization's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-billing/list-an-organizations-pix-charges"},{"title":"List an account's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-billing/list-an-accounts-pix-charges"},{"title":"List a wallet's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-billing/list-a-wallets-pix-charges"},{"title":"Create a Pix charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-billing/create-a-pix-charge"},{"title":"Get a Pix charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","href":"/api-reference/banking/pix-billing/get-a-pix-charge"},{"title":"Cancel a Pix charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","href":"/api-reference/banking/pix-billing/cancel-a-pix-charge"},{"title":"Get a Pix charge for its payment page","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-billing/get-a-pix-charge-for-its-payment-page"}]},{"group":"PIX Automatic","pages":[{"title":"List the realm's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-the-realms-pix-automatic-authorizations"},{"title":"List an organization's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-an-organizations-pix-automatic-authorizations"},{"title":"List an account's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-an-accounts-pix-automatic-authorizations"},{"title":"List a wallet's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-a-wallets-pix-automatic-authorizations"},{"title":"Create a Pix Automatic authorization","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/create-a-pix-automatic-authorization"},{"title":"List a wallet's Pix Automatic charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","href":"/api-reference/banking/pix-automatic/list-a-wallets-pix-automatic-charges"},{"title":"Get a Pix Automatic authorization","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","href":"/api-reference/banking/pix-automatic/get-a-pix-automatic-authorization"},{"title":"Cancel a Pix Automatic authorization","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","href":"/api-reference/banking/pix-automatic/cancel-a-pix-automatic-authorization"},{"title":"List an authorization's charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","href":"/api-reference/banking/pix-automatic/list-an-authorizations-charges"},{"title":"Get a Pix Automatic charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/get-a-pix-automatic-charge"},{"title":"Update a Pix Automatic charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/update-a-pix-automatic-charge"},{"title":"Cancel a Pix Automatic charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","href":"/api-reference/banking/pix-automatic/cancel-a-pix-automatic-charge"},{"title":"List an authorization's history","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","href":"/api-reference/banking/pix-automatic/list-an-authorizations-history"}]},{"group":"PIX Infractions (MED)","pages":[{"title":"List the realm's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions"},{"title":"List an organization's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-organizations-pix-infractions"},{"title":"List an account's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-accounts-pix-infractions"},{"title":"List a wallet's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-a-wallets-pix-infractions"},{"title":"Get a transaction's Pix infraction","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/get-a-transactions-pix-infraction"},{"title":"Report a Pix as a fraud","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud"}]},{"group":"Boleto Payments","pages":[{"title":"List the realm's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto","href":"/api-reference/banking/boleto-payments/list-the-realms-boleto-payments"},{"title":"List an organization's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto","href":"/api-reference/banking/boleto-payments/list-an-organizations-boleto-payments"},{"title":"List an account's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto","href":"/api-reference/banking/boleto-payments/list-an-accounts-boleto-payments"},{"title":"List a wallet's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto","href":"/api-reference/banking/boleto-payments/list-a-wallets-boleto-payments"},{"title":"Create a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto","href":"/api-reference/banking/boleto-payments/create-a-boleto-payment"},{"title":"Get a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}","href":"/api-reference/banking/boleto-payments/get-a-boleto-payment"},{"title":"Set a boleto payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}","href":"/api-reference/banking/boleto-payments/set-a-boleto-payments-details"},{"title":"Send a boleto payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/request","href":"/api-reference/banking/boleto-payments/send-a-boleto-payment-for-approval"},{"title":"Confirm a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/confirm","href":"/api-reference/banking/boleto-payments/confirm-a-boleto-payment"},{"title":"Cancel a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/cancel","href":"/api-reference/banking/boleto-payments/cancel-a-boleto-payment"}]},{"group":"Boleto Billing","pages":[{"title":"List the realm's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-the-realms-boleto-charges"},{"title":"List an organization's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-an-organizations-boleto-charges"},{"title":"List an account's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-an-accounts-boleto-charges"},{"title":"List a wallet's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-a-wallets-boleto-charges"},{"title":"Create a boleto charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-billing/create-a-boleto-charge"},{"title":"Get a boleto charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","href":"/api-reference/banking/boleto-billing/get-a-boleto-charge"},{"title":"Download a boleto charge's PDF","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","href":"/api-reference/banking/boleto-billing/download-a-boleto-charges-pdf"}]},{"group":"TED Payments","pages":[{"title":"List the realm's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/ted","href":"/api-reference/banking/ted-payments/list-the-realms-ted-payments"},{"title":"List an organization's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/ted","href":"/api-reference/banking/ted-payments/list-an-organizations-ted-payments"},{"title":"List an account's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted","href":"/api-reference/banking/ted-payments/list-an-accounts-ted-payments"},{"title":"List a wallet's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/list-a-wallets-ted-payments"},{"title":"Create a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/create-a-ted-payment"},{"title":"Get a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}","href":"/api-reference/banking/ted-payments/get-a-ted-payment"},{"title":"Confirm a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm","href":"/api-reference/banking/ted-payments/confirm-a-ted-payment"},{"title":"Cancel a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel","href":"/api-reference/banking/ted-payments/cancel-a-ted-payment"}]},{"group":"Transactions","pages":[{"title":"List an account's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions","href":"/api-reference/banking/transactions/list-an-accounts-transactions"},{"title":"Get an account's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary","href":"/api-reference/banking/transactions/get-an-accounts-transaction-totals"},{"title":"Chart an account's weekly spending","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions","href":"/api-reference/banking/transactions/chart-an-accounts-weekly-spending"},{"title":"Export an account's transactions by e-mail","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async","href":"/api-reference/banking/transactions/export-an-accounts-transactions-by-e-mail"},{"title":"List a wallet's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions","href":"/api-reference/banking/transactions/list-a-wallets-transactions"},{"title":"Get a wallet's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary","href":"/api-reference/banking/transactions/get-a-wallets-transaction-totals"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/banking/transactions/get-a-transaction"},{"title":"Update a transaction's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/banking/transactions/update-a-transactions-custom-fields"}]},{"group":"Transaction Reversals","pages":[{"title":"List the realm's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/reversals","href":"/api-reference/banking/transaction-reversals/list-the-realms-pix-refunds"},{"title":"List an organization's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-organizations-pix-refunds"},{"title":"List an account's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-accounts-pix-refunds"},{"title":"List a wallet's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-wallets-pix-refunds"},{"title":"List a transaction's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-transactions-pix-refunds"},{"title":"Start a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/start-a-pix-refund"},{"title":"Confirm a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/banking/transaction-reversals/confirm-a-pix-refund"},{"title":"Cancel a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/banking/transaction-reversals/cancel-a-pix-refund"}]},{"group":"Spend Review","pages":[{"title":"Preview a transaction's spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/banking/spend-review/preview-a-transactions-spend-review"},{"title":"Submit a transaction for spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/banking/spend-review/submit-a-transaction-for-spend-review"}]},{"group":"Cashback","pages":[{"title":"Get a wallet's earned cashback","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/banking/cashback/get-a-wallets-earned-cashback"},{"title":"Get a wallet's cashback balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance","href":"/api-reference/banking/cashback/get-a-wallets-cashback-balance"}]},{"group":"Currency Codes","pages":[{"title":"List currency codes","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /currency-codes","href":"/api-reference/banking/currency-codes/list-currency-codes"}]}]},{"group":"Billing","pages":[{"group":"Deals","pages":[{"title":"List an organization's deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/list-an-organizations-deals"},{"title":"Export deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/export","href":"/api-reference/billing/deals/export-deals"},{"title":"Get a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/get-a-deal"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/create-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/update-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/billing/deals/cancel-a-deal"}]},{"group":"Invoices","pages":[{"title":"List an organization's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/list-an-organizations-invoices"},{"title":"List a deal's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/invoices","href":"/api-reference/billing/invoices/list-a-deals-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/cancel","href":"/api-reference/billing/invoices/cancel-an-invoice"},{"title":"Export invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/export","href":"/api-reference/billing/invoices/export-invoices"}]},{"group":"Invoice Entries","pages":[{"title":"List an invoice's entries","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/list-an-invoices-entries"},{"title":"Add entries to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/add-entries-to-an-invoice"},{"title":"Get an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}","href":"/api-reference/billing/invoice-entries/get-an-entry"},{"title":"Delete an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete","href":"/api-reference/billing/invoice-entries/delete-an-entry"}]},{"group":"Invoice Statements","pages":[{"title":"List an invoice's statements","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/list-an-invoices-statements"},{"title":"Get a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/billing/invoice-statements/get-a-statement"},{"title":"Create a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/create-a-statement"},{"title":"Mark an invoice as paid","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/billing/invoice-statements/mark-an-invoice-as-paid"},{"title":"Create a boleto","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/bank-slip","href":"/api-reference/billing/invoice-statements/create-a-boleto"},{"title":"Download a boleto PDF","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/billing/invoice-statements/download-a-boleto-pdf"},{"title":"Create a PIX charge","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/pix-billing","href":"/api-reference/billing/invoice-statements/create-a-pix-charge"},{"title":"Charge the payer's wallet","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/p2p-billing","href":"/api-reference/billing/invoice-statements/charge-the-payers-wallet"}]},{"group":"NFSe Configuration","pages":[{"title":"Get the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/get-the-nfse-configuration"},{"title":"Create the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/create-the-nfse-configuration"},{"title":"Delete the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json delete /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/delete-the-nfse-configuration"}]},{"group":"Payment Links","pages":[{"title":"List an organization's payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/list-an-organizations-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/create-a-payment-link"},{"title":"Export payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/report","href":"/api-reference/billing/payment-links/export-payment-links"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/get-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/update-a-payment-link"},{"title":"Activate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/activate","href":"/api-reference/billing/payment-links/activate-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate","href":"/api-reference/billing/payment-links/deactivate-a-payment-link"}]}]},{"group":"Accounting","pages":[{"group":"Tax Issuers","pages":[{"title":"Get your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/get-your-tax-issuer"},{"title":"Create your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/create-your-tax-issuer"},{"title":"Update your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json patch /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/update-your-tax-issuer"},{"title":"Deactivate your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/deactivate-your-tax-issuer"},{"title":"Upload your digital certificate","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/secrets","href":"/api-reference/accounting/tax-issuers/upload-your-digital-certificate"},{"title":"Upload your logo","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/logotype","href":"/api-reference/accounting/tax-issuers/upload-your-logo"}]},{"group":"Tax Documents (NFSe)","pages":[{"title":"List an organization's tax documents","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/list-an-organizations-tax-documents"},{"title":"Issue a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/issue-a-tax-document"},{"title":"Issue tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch","href":"/api-reference/accounting/tax-documents-nfse/issue-tax-documents-in-batch"},{"title":"Download tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/download-batch","href":"/api-reference/accounting/tax-documents-nfse/download-tax-documents-in-batch"},{"title":"Cancel tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch-cancel","href":"/api-reference/accounting/tax-documents-nfse/cancel-tax-documents-in-batch"},{"title":"Download a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}/download","href":"/api-reference/accounting/tax-documents-nfse/download-a-tax-document"},{"title":"Cancel a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}","href":"/api-reference/accounting/tax-documents-nfse/cancel-a-tax-document"}]},{"group":"Tax Codes","pages":[{"title":"List a city's special tax regimes","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /taxCode/{specialTaxCode}","href":"/api-reference/accounting/tax-codes/list-a-citys-special-tax-regimes"}]}]},{"group":"Registry","pages":[{"group":"Customers","pages":[{"title":"List an organization's customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/list-an-organizations-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/create-a-customer"},{"title":"Export customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customers/report","href":"/api-reference/registry/customers/export-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/update-a-customer"},{"title":"Activate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate","href":"/api-reference/registry/customers/activate-a-customer"},{"title":"Deactivate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/deactivate","href":"/api-reference/registry/customers/deactivate-a-customer"}]},{"group":"Companies","pages":[{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies","href":"/api-reference/registry/companies/search-companies"},{"title":"Get a company by CNPJ","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies/{document}","href":"/api-reference/registry/companies/get-a-company-by-cnpj"}]},{"group":"People","pages":[{"title":"Get a person by CPF","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/people/{document}","href":"/api-reference/registry/people/get-a-person-by-cpf"}]},{"group":"Products","pages":[{"title":"List an organization's products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/list-an-organizations-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/create-a-product"},{"title":"Export products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/report","href":"/api-reference/registry/products/export-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/update-a-product"},{"title":"Activate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/activate","href":"/api-reference/registry/products/activate-a-product"},{"title":"Deactivate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate","href":"/api-reference/registry/products/deactivate-a-product"}]},{"group":"Suppliers","pages":[{"title":"List an organization's suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/list-an-organizations-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/create-a-supplier"},{"title":"Export suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/suppliers/report","href":"/api-reference/registry/suppliers/export-suppliers"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/get-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/update-a-supplier"},{"title":"Activate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/activate","href":"/api-reference/registry/suppliers/activate-a-supplier"},{"title":"Deactivate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/deactivate","href":"/api-reference/registry/suppliers/deactivate-a-supplier"}]}]},{"group":"Platform","pages":[{"group":"Wallets","pages":[{"title":"Get wallet cashback","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/platform/wallets/get-wallet-cashback"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets-report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets-report","href":"/api-reference/platform/wallets/realms-organizations-wallets-report"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","href":"/api-reference/platform/wallets/realms-organizations-wallets-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-cashback-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-clear-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","href":"/api-reference/platform/wallets/realms-organizations-wallets-unblock"}]},{"group":"Cards","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/platform/cards/realms-organizations-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/threeds-submit","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/threeds-submit","href":"/api-reference/platform/cards/realms-organizations-threeds-submit"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-details"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-pin"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactionsexport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-unblock"}]},{"group":"PIX","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","href":"/api-reference/platform/pix/realms-organizations-wallets-pix"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-request"}]},{"group":"PIX Keys (DICT)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-remove"}]},{"group":"Boleto","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slipcheck"}]},{"group":"Transfers","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2p"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2pschedule"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfersschedule"}]},{"group":"Scheduled Payments","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedulesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json delete /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedulesreport"}]},{"group":"Transactions \u0026 Statements","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statementssettlement"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report-async","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report-async","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport-async"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-aggregated-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-custom-fields"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-review"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-reviewrequest"}]},{"group":"Invoices","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/platform/invoices/realms-organizations-invoices"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","href":"/api-reference/platform/invoices/realms-organizations-invoices-create-payment"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/platform/invoices/realms-organizations-invoices-download-pdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/report","href":"/api-reference/platform/invoices/realms-organizations-invoicesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/my-invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/my-invoices","href":"/api-reference/platform/invoices/realms-organizations-my-invoices"}]},{"group":"Deals","pages":[{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/platform/deals/create-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/platform/deals/cancel-a-deal"}]},{"group":"Billing","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","href":"/api-reference/platform/billing/realms-organizations-wallets-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-download-pdf"}]},{"group":"Notifications","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/notifications","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/notifications","href":"/api-reference/platform/notifications/realms-organizations-notifications"}]},{"group":"Users","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","href":"/api-reference/platform/users/realms-organizations-users-walletsdefault"}]},{"group":"Vehicles","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-unarchive"}]}]},{"group":"Notification","pages":[{"group":"Webhooks","pages":[{"title":"List the realm's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/list-the-realms-webhooks"},{"title":"Register a realm webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/register-a-realm-webhook"},{"title":"Activate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-a-realm-webhook-event"},{"title":"Deactivate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-a-realm-webhook-event"},{"title":"List an organization's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/list-an-organizations-webhooks"},{"title":"Register an organization webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/register-an-organization-webhook"},{"title":"Activate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-an-organization-webhook-event"},{"title":"Deactivate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-an-organization-webhook-event"}]}]},{"group":"Rule Engine","pages":[{"group":"Business Policies","pages":[{"title":"List an organization's business policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/list-an-organizations-business-policies"},{"title":"Create a business policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/create-a-business-policy"},{"title":"List an organization's payment policy conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","href":"/api-reference/ruleengine/business-policies/list-an-organizations-payment-policy-conditions"},{"title":"List an organization's spend review policy conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","href":"/api-reference/ruleengine/business-policies/list-an-organizations-spend-review-policy-conditions"},{"title":"List an organization's travel policy conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions","href":"/api-reference/ruleengine/business-policies/list-an-organizations-travel-policy-conditions"},{"title":"Generate a business policy draft","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","href":"/api-reference/ruleengine/business-policies/generate-a-business-policy-draft"},{"title":"Generate a business policy description","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","href":"/api-reference/ruleengine/business-policies/generate-a-business-policy-description"},{"title":"Get a business policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/get-a-business-policy"},{"title":"Update a business policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json put /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/update-a-business-policy"},{"title":"Archive a business policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","href":"/api-reference/ruleengine/business-policies/archive-a-business-policy"}]},{"group":"Policy Requests","pages":[{"title":"List an organization's policy requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/list-an-organizations-policy-requests"},{"title":"Get a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/get-a-policy-request"},{"title":"Approve a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","href":"/api-reference/ruleengine/policy-requests/approve-a-policy-request"},{"title":"Deny a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","href":"/api-reference/ruleengine/policy-requests/deny-a-policy-request"},{"title":"Cancel a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","href":"/api-reference/ruleengine/policy-requests/cancel-a-policy-request"},{"title":"Force-approve a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","href":"/api-reference/ruleengine/policy-requests/force-approve-a-policy-request"},{"title":"Force-deny a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","href":"/api-reference/ruleengine/policy-requests/force-deny-a-policy-request"}]}]},{"group":"Scheduling","pages":[{"group":"Schedules","pages":[{"title":"List an organization's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/scheduling/schedules/list-an-organizations-schedules"},{"title":"List a wallet's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules","href":"/api-reference/scheduling/schedules/list-a-wallets-schedules"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/scheduling/schedules/get-a-schedule"},{"title":"List a schedule's events","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/logs","href":"/api-reference/scheduling/schedules/list-a-schedules-events"},{"title":"Cancel a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/cancel","href":"/api-reference/scheduling/schedules/cancel-a-schedule"}]}]},{"group":"Travel","pages":[{"group":"Passengers","pages":[{"title":"List an organization's passengers","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/list-an-organizations-passengers"},{"title":"Create a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/create-a-passenger"},{"title":"Get a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/get-a-passenger"},{"title":"Update a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json put /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/update-a-passenger"},{"title":"Delete a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json delete /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/delete-a-passenger"}]},{"group":"Trips","pages":[{"title":"List the realm's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/trips","href":"/api-reference/travel/trips/list-the-realms-trips"},{"title":"List an organization's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/list-an-organizations-trips"},{"title":"Create a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/create-a-trip"},{"title":"List a passenger's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}/trips","href":"/api-reference/travel/trips/list-a-passengers-trips"},{"title":"Get a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}","href":"/api-reference/travel/trips/get-a-trip"},{"title":"List a trip's history","description":"Lists the changes of a trip's state and status, oldest first.","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/history","href":"/api-reference/travel/trips/list-a-trips-history"},{"title":"Send a trip for approval","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/request","href":"/api-reference/travel/trips/send-a-trip-for-approval"},{"title":"Withdraw a trip's approval request","description":"Withdraws the approval request of a trip.","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/request/cancel","href":"/api-reference/travel/trips/withdraw-a-trips-approval-request"},{"title":"Issue a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/issue","href":"/api-reference/travel/trips/issue-a-trip"},{"title":"List a trip's cancellation quotes","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/list-a-trips-cancellation-quotes"},{"title":"Cancel a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/cancel-a-trip"}]},{"group":"Air search","pages":[{"title":"Search airports","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/locations","href":"/api-reference/travel/air-search/search-airports"},{"title":"Create an air search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/air/searches","href":"/api-reference/travel/air-search/create-an-air-search"},{"title":"Get an air search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}","href":"/api-reference/travel/air-search/get-an-air-search-and-its-results"},{"title":"Get an air search grouped by airline and price","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/aggregate","href":"/api-reference/travel/air-search/get-an-air-search-grouped-by-airline-and-price"},{"title":"Get an air search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/air-search/get-an-air-search-item"}]},{"group":"Hotel search","pages":[{"title":"Search hotel destinations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/locations","href":"/api-reference/travel/hotel-search/search-hotel-destinations"},{"title":"Create a hotel search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/hotel/searches","href":"/api-reference/travel/hotel-search/create-a-hotel-search"},{"title":"Get a hotel search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-and-its-results"},{"title":"Get a hotel search as map points","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map","href":"/api-reference/travel/hotel-search/get-a-hotel-search-as-map-points"},{"title":"Get a hotel search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-item"}]},{"group":"Bus search","pages":[{"title":"Search bus stations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/locations","href":"/api-reference/travel/bus-search/search-bus-stations"},{"title":"Create a bus search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/bus/searches","href":"/api-reference/travel/bus-search/create-a-bus-search"},{"title":"Get a bus search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}","href":"/api-reference/travel/bus-search/get-a-bus-search-and-its-results"},{"title":"Get a bus search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/bus-search/get-a-bus-search-item"}]},{"group":"Vehicle search","pages":[{"title":"Search vehicle pick-up places","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/locations","href":"/api-reference/travel/vehicle-search/search-vehicle-pick-up-places"},{"title":"Create a vehicle search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicle/searches","href":"/api-reference/travel/vehicle-search/create-a-vehicle-search"},{"title":"Get a vehicle search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-and-its-results"},{"title":"Get a vehicle search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-item"}]}]},{"group":"Vehicles","pages":[{"group":"Vehicles","pages":[{"title":"List an organization's vehicles","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/list-an-organizations-vehicles"},{"title":"Create a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/create-a-vehicle"},{"title":"Get a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/get-a-vehicle"},{"title":"Update a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/update-a-vehicle"},{"title":"Archive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/vehicle/vehicles/archive-a-vehicle"},{"title":"Unarchive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/vehicle/vehicles/unarchive-a-vehicle"}]}]},{"group":"Attachments","pages":[{"group":"Attachments","pages":[{"title":"List the realm's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/attachments","href":"/api-reference/attachment/attachments/list-the-realms-attachments"},{"title":"List an organization's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/list-an-organizations-attachments"},{"title":"Create an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json post /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/create-an-attachment"},{"title":"Get an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/get-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json delete /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/delete-an-attachment"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}/download","href":"/api-reference/attachment/attachments/download-an-attachment"}]}]}]}]},{"language":"pt-BR","tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR"}]},{"tab":"Referência da API","groups":[{"group":"Visão geral","pages":[{"title":"Referência da API","href":"/pt-BR/api-reference/overview"},{"title":"Paginação","href":"/pt-BR/api-reference/pagination"}]},{"group":"Identity","pages":[{"group":"Authentication","pages":[{"title":"Sign in","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /auth/sign-in","href":"/api-reference/identity/authentication/sign-in"}]},{"group":"Current User","pages":[{"title":"Get the current API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /me","href":"/api-reference/identity/current-user/get-the-current-api-client"}]},{"group":"Custom Fields","pages":[{"title":"List an organization's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/list-an-organizations-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/create-a-custom-field"},{"title":"Get a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/get-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/update-a-custom-field"},{"title":"Activate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/activate","href":"/api-reference/identity/custom-fields/activate-a-custom-field"},{"title":"Deactivate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/deactivate","href":"/api-reference/identity/custom-fields/deactivate-a-custom-field"}]},{"group":"API Clients","pages":[{"title":"List the realm's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/list-the-realms-api-clients"},{"title":"List an organization's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients","href":"/api-reference/identity/api-clients/list-an-organizations-api-clients"},{"title":"Create an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/create-an-api-client"},{"title":"Deactivate an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients/{appClientId}/deactivate","href":"/api-reference/identity/api-clients/deactivate-an-api-client"}]},{"group":"Users","pages":[{"title":"List the realm's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users","href":"/api-reference/identity/users/list-the-realms-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users","href":"/api-reference/identity/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json patch /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/update-a-user"},{"title":"Activate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/activate","href":"/api-reference/identity/users/activate-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/deactivate","href":"/api-reference/identity/users/deactivate-a-user"},{"title":"List an organization's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users","href":"/api-reference/identity/users/list-an-organizations-users"},{"title":"Assign a user to an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/assign","href":"/api-reference/identity/users/assign-a-user-to-an-organization"},{"title":"Revoke a user from an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/revoke","href":"/api-reference/identity/users/revoke-a-user-from-an-organization"},{"title":"Export organization users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/report","href":"/api-reference/identity/users/export-organization-users"}]},{"group":"Organizations","pages":[{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}","href":"/api-reference/identity/organizations/get-an-organization"}]},{"group":"Groups","pages":[{"title":"List an organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/list-an-organizations-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/create-a-group"},{"title":"Get a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/get-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/update-a-group"},{"title":"Archive a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups/{groupId}/archive","href":"/api-reference/identity/groups/archive-a-group"}]},{"group":"Realms","pages":[{"title":"Get your realm","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}","href":"/api-reference/identity/realms/get-your-realm"}]}]},{"group":"Banking","pages":[{"group":"Accounts","pages":[{"title":"List the realm's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/accounts","href":"/api-reference/banking/accounts/list-the-realms-accounts"},{"title":"List an organization's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts","href":"/api-reference/banking/accounts/list-an-organizations-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}","href":"/api-reference/banking/accounts/get-an-account"},{"title":"Get an account's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/balance","href":"/api-reference/banking/accounts/get-an-accounts-closing-balance"},{"title":"Get a wallet's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/balance","href":"/api-reference/banking/accounts/get-a-wallets-closing-balance"}]},{"group":"Account Limits","pages":[{"title":"List the realm's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/account-limits","href":"/api-reference/banking/account-limits/list-the-realms-account-limits"},{"title":"List an organization's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/account-limits","href":"/api-reference/banking/account-limits/list-an-organizations-account-limits"},{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits","href":"/api-reference/banking/account-limits/get-account-limits"}]},{"group":"Wallets","pages":[{"title":"List the realm's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/wallets","href":"/api-reference/banking/wallets/list-the-realms-wallets"},{"title":"List an organization's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/banking/wallets/list-an-organizations-wallets"},{"title":"List an account's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/list-an-accounts-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/create-a-wallet"},{"title":"Export wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/export","href":"/api-reference/banking/wallets/export-wallets"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/update-a-wallet"},{"title":"Cancel a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cancel","href":"/api-reference/banking/wallets/cancel-a-wallet"},{"title":"Block a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block","href":"/api-reference/banking/wallets/block-a-wallet"},{"title":"Unblock a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock","href":"/api-reference/banking/wallets/unblock-a-wallet"},{"title":"Empty a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance","href":"/api-reference/banking/wallets/empty-a-wallet"}]},{"group":"Transaction Limits","pages":[{"title":"Get transaction limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/get-transaction-limits"},{"title":"Update a transaction limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/update-a-transaction-limit"}]},{"group":"Transfers","pages":[{"title":"List a wallet's transfer requests","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/list-a-wallets-transfer-requests"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/create-a-transfer-request"},{"title":"Get a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/get-a-transfer-request"},{"title":"Update a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/update-a-transfer-request"},{"title":"Send a transfer request for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/banking/transfers/send-a-transfer-request-for-approval"},{"title":"Confirm a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/banking/transfers/confirm-a-transfer-request"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/banking/transfers/cancel-a-transfer-request"}]},{"group":"Cards","pages":[{"title":"List the realm's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/cards","href":"/api-reference/banking/cards/list-the-realms-cards"},{"title":"List an organization's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/banking/cards/list-an-organizations-cards"},{"title":"List an account's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards","href":"/api-reference/banking/cards/list-an-accounts-cards"},{"title":"List a wallet's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/list-a-wallets-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/update-a-card"},{"title":"Get card details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/banking/cards/get-card-details"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/banking/cards/block-a-card"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/banking/cards/unblock-a-card"},{"title":"Set a card's PIN","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/banking/cards/set-a-cards-pin"},{"title":"List a card's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/banking/cards/list-a-cards-transactions"},{"title":"Get a card's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/banking/cards/get-a-cards-transaction-totals"},{"title":"Export card transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/banking/cards/export-card-transactions"}]},{"group":"Card Limits","pages":[{"title":"List the realm's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-the-realms-card-limit-rules"},{"title":"List an organization's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-organizations-card-limit-rules"},{"title":"List an account's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-accounts-card-limit-rules"},{"title":"Create a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/create-a-card-limit-rule"},{"title":"Get a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/get-a-card-limit-rule"},{"title":"Update a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/update-a-card-limit-rule"},{"title":"Create a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit","href":"/api-reference/banking/card-limits/create-a-card-limit"},{"title":"Get a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/get-a-card-limit"},{"title":"Delete a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/delete-a-card-limit"},{"title":"List a card's limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit","href":"/api-reference/banking/card-limits/list-a-cards-limits"}]},{"group":"Cards 3DS","pages":[{"title":"List an account's 3D Secure challenges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds","href":"/api-reference/banking/cards-3ds/list-an-accounts-3d-secure-challenges"},{"title":"Answer a 3D Secure challenge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit","href":"/api-reference/banking/cards-3ds/answer-a-3d-secure-challenge"}]},{"group":"Pix Payments","pages":[{"title":"List the realm's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix","href":"/api-reference/banking/pix-payments/list-the-realms-pix-payments"},{"title":"List an organization's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix","href":"/api-reference/banking/pix-payments/list-an-organizations-pix-payments"},{"title":"List an account's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix","href":"/api-reference/banking/pix-payments/list-an-accounts-pix-payments"},{"title":"List a wallet's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/list-a-wallets-pix-payments"},{"title":"Create a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/create-a-pix-payment"},{"title":"Get a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/get-a-pix-payment"},{"title":"Set a Pix payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/set-a-pix-payments-details"},{"title":"Send a Pix payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/banking/pix-payments/send-a-pix-payment-for-approval"},{"title":"Confirm a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/banking/pix-payments/confirm-a-pix-payment"},{"title":"Cancel a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/banking/pix-payments/cancel-a-pix-payment"}]},{"group":"Pix Keys","pages":[{"title":"List the realm's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-dict","href":"/api-reference/banking/pix-keys/list-the-realms-pix-keys"},{"title":"List an organization's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-keys"},{"title":"List an account's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-accounts-pix-keys"},{"title":"List a wallet's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/list-a-wallets-pix-keys"},{"title":"Register a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/register-a-pix-key"},{"title":"Request a Pix key confirmation code","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp","href":"/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code"},{"title":"Confirm a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key"},{"title":"Remove a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove","href":"/api-reference/banking/pix-keys/remove-a-pix-key"},{"title":"List an organization's Pix key claims","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict-claim","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-key-claims"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel","href":"/api-reference/banking/pix-keys/cancel-a-pix-key-claim"}]},{"group":"Pix Billing","pages":[{"title":"List the realm's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-billing/list-the-realms-pix-charges"},{"title":"List an organization's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-billing/list-an-organizations-pix-charges"},{"title":"List an account's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-billing/list-an-accounts-pix-charges"},{"title":"List a wallet's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-billing/list-a-wallets-pix-charges"},{"title":"Create a Pix charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-billing/create-a-pix-charge"},{"title":"Get a Pix charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","href":"/api-reference/banking/pix-billing/get-a-pix-charge"},{"title":"Cancel a Pix charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","href":"/api-reference/banking/pix-billing/cancel-a-pix-charge"},{"title":"Get a Pix charge for its payment page","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-billing/get-a-pix-charge-for-its-payment-page"}]},{"group":"PIX Automatic","pages":[{"title":"List the realm's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-the-realms-pix-automatic-authorizations"},{"title":"List an organization's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-an-organizations-pix-automatic-authorizations"},{"title":"List an account's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-an-accounts-pix-automatic-authorizations"},{"title":"List a wallet's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-a-wallets-pix-automatic-authorizations"},{"title":"Create a Pix Automatic authorization","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/create-a-pix-automatic-authorization"},{"title":"List a wallet's Pix Automatic charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","href":"/api-reference/banking/pix-automatic/list-a-wallets-pix-automatic-charges"},{"title":"Get a Pix Automatic authorization","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","href":"/api-reference/banking/pix-automatic/get-a-pix-automatic-authorization"},{"title":"Cancel a Pix Automatic authorization","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","href":"/api-reference/banking/pix-automatic/cancel-a-pix-automatic-authorization"},{"title":"List an authorization's charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","href":"/api-reference/banking/pix-automatic/list-an-authorizations-charges"},{"title":"Get a Pix Automatic charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/get-a-pix-automatic-charge"},{"title":"Update a Pix Automatic charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/update-a-pix-automatic-charge"},{"title":"Cancel a Pix Automatic charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","href":"/api-reference/banking/pix-automatic/cancel-a-pix-automatic-charge"},{"title":"List an authorization's history","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","href":"/api-reference/banking/pix-automatic/list-an-authorizations-history"}]},{"group":"PIX Infractions (MED)","pages":[{"title":"List the realm's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions"},{"title":"List an organization's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-organizations-pix-infractions"},{"title":"List an account's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-accounts-pix-infractions"},{"title":"List a wallet's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-a-wallets-pix-infractions"},{"title":"Get a transaction's Pix infraction","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/get-a-transactions-pix-infraction"},{"title":"Report a Pix as a fraud","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud"}]},{"group":"Boleto Payments","pages":[{"title":"List the realm's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto","href":"/api-reference/banking/boleto-payments/list-the-realms-boleto-payments"},{"title":"List an organization's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto","href":"/api-reference/banking/boleto-payments/list-an-organizations-boleto-payments"},{"title":"List an account's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto","href":"/api-reference/banking/boleto-payments/list-an-accounts-boleto-payments"},{"title":"List a wallet's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto","href":"/api-reference/banking/boleto-payments/list-a-wallets-boleto-payments"},{"title":"Create a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto","href":"/api-reference/banking/boleto-payments/create-a-boleto-payment"},{"title":"Get a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}","href":"/api-reference/banking/boleto-payments/get-a-boleto-payment"},{"title":"Set a boleto payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}","href":"/api-reference/banking/boleto-payments/set-a-boleto-payments-details"},{"title":"Send a boleto payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/request","href":"/api-reference/banking/boleto-payments/send-a-boleto-payment-for-approval"},{"title":"Confirm a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/confirm","href":"/api-reference/banking/boleto-payments/confirm-a-boleto-payment"},{"title":"Cancel a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/cancel","href":"/api-reference/banking/boleto-payments/cancel-a-boleto-payment"}]},{"group":"Boleto Billing","pages":[{"title":"List the realm's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-the-realms-boleto-charges"},{"title":"List an organization's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-an-organizations-boleto-charges"},{"title":"List an account's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-an-accounts-boleto-charges"},{"title":"List a wallet's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-a-wallets-boleto-charges"},{"title":"Create a boleto charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-billing/create-a-boleto-charge"},{"title":"Get a boleto charge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","href":"/api-reference/banking/boleto-billing/get-a-boleto-charge"},{"title":"Download a boleto charge's PDF","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","href":"/api-reference/banking/boleto-billing/download-a-boleto-charges-pdf"}]},{"group":"TED Payments","pages":[{"title":"List the realm's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/ted","href":"/api-reference/banking/ted-payments/list-the-realms-ted-payments"},{"title":"List an organization's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/ted","href":"/api-reference/banking/ted-payments/list-an-organizations-ted-payments"},{"title":"List an account's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted","href":"/api-reference/banking/ted-payments/list-an-accounts-ted-payments"},{"title":"List a wallet's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/list-a-wallets-ted-payments"},{"title":"Create a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/create-a-ted-payment"},{"title":"Get a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}","href":"/api-reference/banking/ted-payments/get-a-ted-payment"},{"title":"Confirm a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm","href":"/api-reference/banking/ted-payments/confirm-a-ted-payment"},{"title":"Cancel a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel","href":"/api-reference/banking/ted-payments/cancel-a-ted-payment"}]},{"group":"Transactions","pages":[{"title":"List an account's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions","href":"/api-reference/banking/transactions/list-an-accounts-transactions"},{"title":"Get an account's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary","href":"/api-reference/banking/transactions/get-an-accounts-transaction-totals"},{"title":"Chart an account's weekly spending","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions","href":"/api-reference/banking/transactions/chart-an-accounts-weekly-spending"},{"title":"Export an account's transactions by e-mail","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async","href":"/api-reference/banking/transactions/export-an-accounts-transactions-by-e-mail"},{"title":"List a wallet's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions","href":"/api-reference/banking/transactions/list-a-wallets-transactions"},{"title":"Get a wallet's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary","href":"/api-reference/banking/transactions/get-a-wallets-transaction-totals"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/banking/transactions/get-a-transaction"},{"title":"Update a transaction's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/banking/transactions/update-a-transactions-custom-fields"}]},{"group":"Transaction Reversals","pages":[{"title":"List the realm's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/reversals","href":"/api-reference/banking/transaction-reversals/list-the-realms-pix-refunds"},{"title":"List an organization's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-organizations-pix-refunds"},{"title":"List an account's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-accounts-pix-refunds"},{"title":"List a wallet's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-wallets-pix-refunds"},{"title":"List a transaction's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-transactions-pix-refunds"},{"title":"Start a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/start-a-pix-refund"},{"title":"Confirm a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/banking/transaction-reversals/confirm-a-pix-refund"},{"title":"Cancel a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/banking/transaction-reversals/cancel-a-pix-refund"}]},{"group":"Spend Review","pages":[{"title":"Preview a transaction's spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/banking/spend-review/preview-a-transactions-spend-review"},{"title":"Submit a transaction for spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/banking/spend-review/submit-a-transaction-for-spend-review"}]},{"group":"Cashback","pages":[{"title":"Get a wallet's earned cashback","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/banking/cashback/get-a-wallets-earned-cashback"},{"title":"Get a wallet's cashback balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance","href":"/api-reference/banking/cashback/get-a-wallets-cashback-balance"}]},{"group":"Currency Codes","pages":[{"title":"List currency codes","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /currency-codes","href":"/api-reference/banking/currency-codes/list-currency-codes"}]}]},{"group":"Billing","pages":[{"group":"Deals","pages":[{"title":"List an organization's deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/list-an-organizations-deals"},{"title":"Export deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/export","href":"/api-reference/billing/deals/export-deals"},{"title":"Get a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/get-a-deal"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/create-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/update-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/billing/deals/cancel-a-deal"}]},{"group":"Invoices","pages":[{"title":"List an organization's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/list-an-organizations-invoices"},{"title":"List a deal's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/invoices","href":"/api-reference/billing/invoices/list-a-deals-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/cancel","href":"/api-reference/billing/invoices/cancel-an-invoice"},{"title":"Export invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/export","href":"/api-reference/billing/invoices/export-invoices"}]},{"group":"Invoice Entries","pages":[{"title":"List an invoice's entries","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/list-an-invoices-entries"},{"title":"Add entries to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/add-entries-to-an-invoice"},{"title":"Get an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}","href":"/api-reference/billing/invoice-entries/get-an-entry"},{"title":"Delete an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete","href":"/api-reference/billing/invoice-entries/delete-an-entry"}]},{"group":"Invoice Statements","pages":[{"title":"List an invoice's statements","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/list-an-invoices-statements"},{"title":"Get a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/billing/invoice-statements/get-a-statement"},{"title":"Create a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/create-a-statement"},{"title":"Mark an invoice as paid","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/billing/invoice-statements/mark-an-invoice-as-paid"},{"title":"Create a boleto","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/bank-slip","href":"/api-reference/billing/invoice-statements/create-a-boleto"},{"title":"Download a boleto PDF","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/billing/invoice-statements/download-a-boleto-pdf"},{"title":"Create a PIX charge","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/pix-billing","href":"/api-reference/billing/invoice-statements/create-a-pix-charge"},{"title":"Charge the payer's wallet","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/p2p-billing","href":"/api-reference/billing/invoice-statements/charge-the-payers-wallet"}]},{"group":"NFSe Configuration","pages":[{"title":"Get the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/get-the-nfse-configuration"},{"title":"Create the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/create-the-nfse-configuration"},{"title":"Delete the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json delete /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/delete-the-nfse-configuration"}]},{"group":"Payment Links","pages":[{"title":"List an organization's payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/list-an-organizations-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/create-a-payment-link"},{"title":"Export payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/report","href":"/api-reference/billing/payment-links/export-payment-links"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/get-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/update-a-payment-link"},{"title":"Activate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/activate","href":"/api-reference/billing/payment-links/activate-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate","href":"/api-reference/billing/payment-links/deactivate-a-payment-link"}]}]},{"group":"Accounting","pages":[{"group":"Tax Issuers","pages":[{"title":"Get your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/get-your-tax-issuer"},{"title":"Create your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/create-your-tax-issuer"},{"title":"Update your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json patch /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/update-your-tax-issuer"},{"title":"Deactivate your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/deactivate-your-tax-issuer"},{"title":"Upload your digital certificate","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/secrets","href":"/api-reference/accounting/tax-issuers/upload-your-digital-certificate"},{"title":"Upload your logo","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/logotype","href":"/api-reference/accounting/tax-issuers/upload-your-logo"}]},{"group":"Tax Documents (NFSe)","pages":[{"title":"List an organization's tax documents","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/list-an-organizations-tax-documents"},{"title":"Issue a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/issue-a-tax-document"},{"title":"Issue tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch","href":"/api-reference/accounting/tax-documents-nfse/issue-tax-documents-in-batch"},{"title":"Download tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/download-batch","href":"/api-reference/accounting/tax-documents-nfse/download-tax-documents-in-batch"},{"title":"Cancel tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch-cancel","href":"/api-reference/accounting/tax-documents-nfse/cancel-tax-documents-in-batch"},{"title":"Download a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}/download","href":"/api-reference/accounting/tax-documents-nfse/download-a-tax-document"},{"title":"Cancel a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}","href":"/api-reference/accounting/tax-documents-nfse/cancel-a-tax-document"}]},{"group":"Tax Codes","pages":[{"title":"List a city's special tax regimes","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /taxCode/{specialTaxCode}","href":"/api-reference/accounting/tax-codes/list-a-citys-special-tax-regimes"}]}]},{"group":"Registry","pages":[{"group":"Customers","pages":[{"title":"List an organization's customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/list-an-organizations-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/create-a-customer"},{"title":"Export customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customers/report","href":"/api-reference/registry/customers/export-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/update-a-customer"},{"title":"Activate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate","href":"/api-reference/registry/customers/activate-a-customer"},{"title":"Deactivate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/deactivate","href":"/api-reference/registry/customers/deactivate-a-customer"}]},{"group":"Companies","pages":[{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies","href":"/api-reference/registry/companies/search-companies"},{"title":"Get a company by CNPJ","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies/{document}","href":"/api-reference/registry/companies/get-a-company-by-cnpj"}]},{"group":"People","pages":[{"title":"Get a person by CPF","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/people/{document}","href":"/api-reference/registry/people/get-a-person-by-cpf"}]},{"group":"Products","pages":[{"title":"List an organization's products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/list-an-organizations-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/create-a-product"},{"title":"Export products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/report","href":"/api-reference/registry/products/export-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/update-a-product"},{"title":"Activate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/activate","href":"/api-reference/registry/products/activate-a-product"},{"title":"Deactivate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate","href":"/api-reference/registry/products/deactivate-a-product"}]},{"group":"Suppliers","pages":[{"title":"List an organization's suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/list-an-organizations-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/create-a-supplier"},{"title":"Export suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/suppliers/report","href":"/api-reference/registry/suppliers/export-suppliers"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/get-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/update-a-supplier"},{"title":"Activate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/activate","href":"/api-reference/registry/suppliers/activate-a-supplier"},{"title":"Deactivate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/deactivate","href":"/api-reference/registry/suppliers/deactivate-a-supplier"}]}]},{"group":"Platform","pages":[{"group":"Wallets","pages":[{"title":"Get wallet cashback","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/platform/wallets/get-wallet-cashback"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets-report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets-report","href":"/api-reference/platform/wallets/realms-organizations-wallets-report"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","href":"/api-reference/platform/wallets/realms-organizations-wallets-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-cashback-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-clear-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","href":"/api-reference/platform/wallets/realms-organizations-wallets-unblock"}]},{"group":"Cards","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/platform/cards/realms-organizations-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/threeds-submit","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/threeds-submit","href":"/api-reference/platform/cards/realms-organizations-threeds-submit"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-details"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-pin"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactionsexport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-unblock"}]},{"group":"PIX","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","href":"/api-reference/platform/pix/realms-organizations-wallets-pix"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-request"}]},{"group":"PIX Keys (DICT)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-remove"}]},{"group":"Boleto","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slipcheck"}]},{"group":"Transfers","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2p"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2pschedule"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfersschedule"}]},{"group":"Scheduled Payments","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedulesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json delete /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedulesreport"}]},{"group":"Transactions \u0026 Statements","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statementssettlement"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report-async","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report-async","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport-async"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-aggregated-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-custom-fields"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-review"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-reviewrequest"}]},{"group":"Invoices","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/platform/invoices/realms-organizations-invoices"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","href":"/api-reference/platform/invoices/realms-organizations-invoices-create-payment"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/platform/invoices/realms-organizations-invoices-download-pdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/report","href":"/api-reference/platform/invoices/realms-organizations-invoicesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/my-invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/my-invoices","href":"/api-reference/platform/invoices/realms-organizations-my-invoices"}]},{"group":"Deals","pages":[{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/platform/deals/create-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/platform/deals/cancel-a-deal"}]},{"group":"Billing","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","href":"/api-reference/platform/billing/realms-organizations-wallets-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-download-pdf"}]},{"group":"Notifications","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/notifications","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/notifications","href":"/api-reference/platform/notifications/realms-organizations-notifications"}]},{"group":"Users","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","href":"/api-reference/platform/users/realms-organizations-users-walletsdefault"}]},{"group":"Vehicles","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-unarchive"}]}]},{"group":"Notification","pages":[{"group":"Webhooks","pages":[{"title":"List the realm's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/list-the-realms-webhooks"},{"title":"Register a realm webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/register-a-realm-webhook"},{"title":"Activate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-a-realm-webhook-event"},{"title":"Deactivate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-a-realm-webhook-event"},{"title":"List an organization's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/list-an-organizations-webhooks"},{"title":"Register an organization webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/register-an-organization-webhook"},{"title":"Activate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-an-organization-webhook-event"},{"title":"Deactivate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-an-organization-webhook-event"}]}]},{"group":"Rule Engine","pages":[{"group":"Business Policies","pages":[{"title":"List an organization's business policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/list-an-organizations-business-policies"},{"title":"Create a business policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/create-a-business-policy"},{"title":"List an organization's payment policy conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","href":"/api-reference/ruleengine/business-policies/list-an-organizations-payment-policy-conditions"},{"title":"List an organization's spend review policy conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","href":"/api-reference/ruleengine/business-policies/list-an-organizations-spend-review-policy-conditions"},{"title":"List an organization's travel policy conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/travel-conditions","href":"/api-reference/ruleengine/business-policies/list-an-organizations-travel-policy-conditions"},{"title":"Generate a business policy draft","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","href":"/api-reference/ruleengine/business-policies/generate-a-business-policy-draft"},{"title":"Generate a business policy description","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","href":"/api-reference/ruleengine/business-policies/generate-a-business-policy-description"},{"title":"Get a business policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/get-a-business-policy"},{"title":"Update a business policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json put /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/update-a-business-policy"},{"title":"Archive a business policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","href":"/api-reference/ruleengine/business-policies/archive-a-business-policy"}]},{"group":"Policy Requests","pages":[{"title":"List an organization's policy requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/list-an-organizations-policy-requests"},{"title":"Get a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/get-a-policy-request"},{"title":"Approve a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","href":"/api-reference/ruleengine/policy-requests/approve-a-policy-request"},{"title":"Deny a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","href":"/api-reference/ruleengine/policy-requests/deny-a-policy-request"},{"title":"Cancel a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","href":"/api-reference/ruleengine/policy-requests/cancel-a-policy-request"},{"title":"Force-approve a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","href":"/api-reference/ruleengine/policy-requests/force-approve-a-policy-request"},{"title":"Force-deny a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","href":"/api-reference/ruleengine/policy-requests/force-deny-a-policy-request"}]}]},{"group":"Scheduling","pages":[{"group":"Schedules","pages":[{"title":"List an organization's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/scheduling/schedules/list-an-organizations-schedules"},{"title":"List a wallet's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules","href":"/api-reference/scheduling/schedules/list-a-wallets-schedules"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/scheduling/schedules/get-a-schedule"},{"title":"List a schedule's events","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/logs","href":"/api-reference/scheduling/schedules/list-a-schedules-events"},{"title":"Cancel a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/cancel","href":"/api-reference/scheduling/schedules/cancel-a-schedule"}]}]},{"group":"Travel","pages":[{"group":"Passengers","pages":[{"title":"List an organization's passengers","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/list-an-organizations-passengers"},{"title":"Create a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/create-a-passenger"},{"title":"Get a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/get-a-passenger"},{"title":"Update a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json put /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/update-a-passenger"},{"title":"Delete a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json delete /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/delete-a-passenger"}]},{"group":"Trips","pages":[{"title":"List the realm's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/trips","href":"/api-reference/travel/trips/list-the-realms-trips"},{"title":"List an organization's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/list-an-organizations-trips"},{"title":"Create a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/create-a-trip"},{"title":"List a passenger's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}/trips","href":"/api-reference/travel/trips/list-a-passengers-trips"},{"title":"Get a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}","href":"/api-reference/travel/trips/get-a-trip"},{"title":"List a trip's history","description":"Lists the changes of a trip's state and status, oldest first.","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/history","href":"/api-reference/travel/trips/list-a-trips-history"},{"title":"Send a trip for approval","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/request","href":"/api-reference/travel/trips/send-a-trip-for-approval"},{"title":"Withdraw a trip's approval request","description":"Withdraws the approval request of a trip.","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/request/cancel","href":"/api-reference/travel/trips/withdraw-a-trips-approval-request"},{"title":"Issue a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/issue","href":"/api-reference/travel/trips/issue-a-trip"},{"title":"List a trip's cancellation quotes","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/list-a-trips-cancellation-quotes"},{"title":"Cancel a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/cancel-a-trip"}]},{"group":"Air search","pages":[{"title":"Search airports","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/locations","href":"/api-reference/travel/air-search/search-airports"},{"title":"Create an air search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/air/searches","href":"/api-reference/travel/air-search/create-an-air-search"},{"title":"Get an air search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}","href":"/api-reference/travel/air-search/get-an-air-search-and-its-results"},{"title":"Get an air search grouped by airline and price","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/aggregate","href":"/api-reference/travel/air-search/get-an-air-search-grouped-by-airline-and-price"},{"title":"Get an air search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/air-search/get-an-air-search-item"}]},{"group":"Hotel search","pages":[{"title":"Search hotel destinations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/locations","href":"/api-reference/travel/hotel-search/search-hotel-destinations"},{"title":"Create a hotel search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/hotel/searches","href":"/api-reference/travel/hotel-search/create-a-hotel-search"},{"title":"Get a hotel search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-and-its-results"},{"title":"Get a hotel search as map points","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map","href":"/api-reference/travel/hotel-search/get-a-hotel-search-as-map-points"},{"title":"Get a hotel search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-item"}]},{"group":"Bus search","pages":[{"title":"Search bus stations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/locations","href":"/api-reference/travel/bus-search/search-bus-stations"},{"title":"Create a bus search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/bus/searches","href":"/api-reference/travel/bus-search/create-a-bus-search"},{"title":"Get a bus search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}","href":"/api-reference/travel/bus-search/get-a-bus-search-and-its-results"},{"title":"Get a bus search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/bus-search/get-a-bus-search-item"}]},{"group":"Vehicle search","pages":[{"title":"Search vehicle pick-up places","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/locations","href":"/api-reference/travel/vehicle-search/search-vehicle-pick-up-places"},{"title":"Create a vehicle search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicle/searches","href":"/api-reference/travel/vehicle-search/create-a-vehicle-search"},{"title":"Get a vehicle search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-and-its-results"},{"title":"Get a vehicle search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-item"}]}]},{"group":"Vehicles","pages":[{"group":"Vehicles","pages":[{"title":"List an organization's vehicles","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/list-an-organizations-vehicles"},{"title":"Create a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/create-a-vehicle"},{"title":"Get a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/get-a-vehicle"},{"title":"Update a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/update-a-vehicle"},{"title":"Archive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/vehicle/vehicles/archive-a-vehicle"},{"title":"Unarchive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/vehicle/vehicles/unarchive-a-vehicle"}]}]},{"group":"Attachments","pages":[{"group":"Attachments","pages":[{"title":"List the realm's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/attachments","href":"/api-reference/attachment/attachments/list-the-realms-attachments"},{"title":"List an organization's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/list-an-organizations-attachments"},{"title":"Create an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json post /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/create-an-attachment"},{"title":"Get an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/get-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json delete /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/delete-an-attachment"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}/download","href":"/api-reference/attachment/attachments/download-an-attachment"}]}]}]}]}]},"basePath":"","title":"Send a trip for approval - Portão 3","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}