{
"error": {
"code": 400,
"status": "INVALID_ARGUMENT",
"message": "Filter expression references an unsupported field.",
"details": [
{
"reason": "INVALID_ARGUMENT",
"description": "Field `nonexistent` is not allowed for filtering on this endpoint.",
"metadata": {}
}
]
}
}
{
"error": {
"code": 401,
"status": "SIGNATURE_INVALID",
"message": "Request signature could not be verified.",
"details": [
{
"reason": "SIGNATURE_INVALID",
"description": "The provided signature does not match the canonical request.",
"metadata": {
"decisionId": "acd_9RmKvTpYzH2wN8qJ5b"
}
}
]
}
}
{
"error": {
"code": 403,
"status": "RBAC_DENY",
"message": "The credential is not permitted to perform this action.",
"details": [
{
"reason": "RBAC_DENY",
"description": "Missing required role binding on the target resource.",
"metadata": {
"decisionId": "acd_8PaJvNqLcK3xW5sR4d"
}
}
]
}
}
{
"error": {
"code": 404,
"status": "WALLET_NOT_FOUND",
"message": "Wallet not found.",
"details": [
{
"reason": "WALLET_NOT_FOUND",
"description": "No wallet exists with name `production-main`.",
"metadata": {}
}
]
}
}
{
"error": {
"code": 429,
"status": "RESOURCE_EXHAUSTED",
"message": "Rate limit exceeded for this credential.",
"details": [
{
"reason": "RESOURCE_EXHAUSTED",
"description": "You have exceeded the request quota for this endpoint.",
"metadata": {
"retry_after_seconds": 12
}
}
]
}
}
{
"error": {
"code": 400,
"status": "INVALID_ARGUMENT",
"message": "Filter expression references an unsupported field.",
"details": [
{
"reason": "INVALID_ARGUMENT",
"description": "Field `nonexistent` is not allowed for filtering on this endpoint.",
"metadata": {}
}
]
}
}
{
"error": {
"code": 401,
"status": "SIGNATURE_INVALID",
"message": "Request signature could not be verified.",
"details": [
{
"reason": "SIGNATURE_INVALID",
"description": "The provided signature does not match the canonical request.",
"metadata": {
"decisionId": "acd_9RmKvTpYzH2wN8qJ5b"
}
}
]
}
}
{
"error": {
"code": 403,
"status": "RBAC_DENY",
"message": "The credential is not permitted to perform this action.",
"details": [
{
"reason": "RBAC_DENY",
"description": "Missing required role binding on the target resource.",
"metadata": {
"decisionId": "acd_8PaJvNqLcK3xW5sR4d"
}
}
]
}
}
{
"error": {
"code": 404,
"status": "WALLET_NOT_FOUND",
"message": "Wallet not found.",
"details": [
{
"reason": "WALLET_NOT_FOUND",
"description": "No wallet exists with name `production-main`.",
"metadata": {}
}
]
}
}
{
"error": {
"code": 429,
"status": "RESOURCE_EXHAUSTED",
"message": "Rate limit exceeded for this credential.",
"details": [
{
"reason": "RESOURCE_EXHAUSTED",
"description": "You have exceeded the request quota for this endpoint.",
"metadata": {
"retry_after_seconds": 12
}
}
]
}
}
{
"error": {
"code": 503,
"status": "PROVIDER_UNAVAILABLE",
"message": "Upstream payment provider is unavailable.",
"details": [
{
"reason": "PROVIDER_UNAVAILABLE",
"description": "The provider returned a transient error or did not respond.",
"metadata": {
"id": "exc_5KaHsBxYzW3pM2dV"
}
}
]
}
}
Returns a single payment order by id within the wallet scope.The response is the full order resource — see Payment Orders overview for the field reference.
For polling lifecycle transitions, fetch every 5–10 seconds while status is PENDING or PROCESSING; stop once status reaches a final state (SUCCESS, FAILED, CANCELED, EXPIRED, REFUNDED). For production-grade integrations, webhooks are strongly preferred over polling.
If the order does not exist in this wallet, the API returns 404 PAYMENT_ORDER_NOT_FOUND. Note that orders are wallet-scoped — the same paymentOrder id is not portable across wallets.
Authorizations
X-Access-Key
string
header
required
Opaque credential identifier provisioned during onboarding. See the
Integration Guide
for the request-signing protocol.
X-Access-Timestamp
string
header
required
Unix epoch timestamp in UTC milliseconds. See the Integration Guide
for skew tolerance.
X-Access-Request-Id
string
header
required
Unique identifier per request (UUID v4 recommended). The
(accessKey, requestId) tuple must be unique within the replay
window defined by the Integration Guide.
X-Access-Signature
string
header
required
Base64-encoded ECDSA signature of the canonical request, computed
with the private key paired to X-Access-Key. See the Integration
Guide for canonicalization rules and reference implementations.
Path Parameters
wallet
string
required
Wallet name (RFC 1035 DNS label).
Required string length: 1 - 63
Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
paymentOrder
string
required
Payment order identifier.
Pattern: ^ord_[A-Za-z0-9]+$
Response
The requested payment order.
An inbound (cash-in) or outbound (cash-out) payment request routed through a provider network on behalf of a wallet.
id
string
required
read-only
Pattern: ^ord_[A-Za-z0-9]+$
Example:
"ord_3KpFvBwYzNqMxA7eHbRdJ"
kind
enum<string>
required
read-only
Available options:
Payment.Order
wallet
string
required
read-only
The wallet that owns this order (DNS label name).
Example:
"production-main"
ordVersion
integer
required
read-only
Snapshot version, incremented on every content mutation.
Required range: x >= 1
direction
enum<string>
required
Direction of value flow.
Available options:
IN,
OUT
status
enum<string>
required
Lifecycle status of a payment order.
Available options:
AWAITING_APPROVAL,
PENDING,
PROCESSING,
SUCCESS,
FAILED,
CANCELED,
EXPIRED,
REFUNDED
network
enum<string>
required
Payment network identifier.
Available options:
br.gov.bcb.pix,
tron.mainnet,
solana.mainnet,
bitcoin.mainnet,
ethereum.mainnet
idempotencyKey
string
required
Client-supplied opaque key. The (wallet, idempotencyKey) tuple
is globally unique; identical retries return the existing order,
divergent retries return IDEMPOTENCY_KEY_IN_USE_WITH_DIFFERENT_PARAMS.
Required string length: 1 - 64
Example:
"invoice-2026-0184"
amount
integer<int64>
required
Amount in minor units of the order currency.
Required range: x >= 1
Example:
25000
currency
enum<string>
required
Currency or asset code.
Available options:
BRL,
USD,
TRX,
SOL,
BTC,
ETH,
USDT
instrument
object
required
Inbound PIX instrument backed by a long-lived, reusable static EMV QR code.
Option 1
Option 2
Option 3
Option 4
Option 5
Show child attributes
createdAt
string<date-time>
required
read-only
Server-assigned creation timestamp (UTC ISO 8601).
updatedAt
string<date-time>
required
read-only
Timestamp of the last content mutation (UTC ISO 8601).
Hex-encoded content fingerprint of the resource. Reserved for
optimistic concurrency control via the If-Match request header
in a future release; currently exposed for informational and
audit purposes only.
Pattern: ^[a-f0-9]{64,128}$
metadata
object
Client-supplied tags. Not included in the etag computation.
Show child attributes
Example:
{ "orderId": "2026-0184" }
errorCode
string | null
read-only
Provider-reported error code when status is FAILED.
errorMessage
string | null
read-only
Human-readable error description when status is FAILED.
processedAt
string<date-time> | null
read-only
Server processing timestamp. null until the order is submitted
to (or rejected by) the underlying provider; set once the
provider returns a definitive outcome.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bloobank","description":"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.","colors":{"primary":"#5c83fa","light":"#8DABFF","dark":"#3B5DBF"},"logo":{"light":"https://mintcdn.com/solutsco/uVFX2_9nfUfZo-fT/logo/light.svg?fit=max\u0026auto=format\u0026n=uVFX2_9nfUfZo-fT\u0026q=85\u0026s=3fb00233ac5afd400ef9320c4dc20082","dark":"https://mintcdn.com/solutsco/uVFX2_9nfUfZo-fT/logo/dark.svg?fit=max\u0026auto=format\u0026n=uVFX2_9nfUfZo-fT\u0026q=85\u0026s=1ae8e5f47a71e03557a4ff059c168293","href":"/"},"favicon":"https://mintcdn.com/solutsco/Gt5UU7K6L9qRIsM4/icon/favicon.ico?fit=max\u0026auto=format\u0026n=Gt5UU7K6L9qRIsM4\u0026q=85\u0026s=17e86373d973621bf3bcd2ca7c34e0cf","api":{"openapi":"openapi-v1.yml","playground":{"display":"simple","proxy":false},"mdx":{"auth":{"method":"key","name":"X-Access-Signature"},"server":"https://txengine.bloobank.com/txengine/v1"}},"background":{"decoration":"gradient","color":{"light":"#FFFFFF","dark":"#0B1020"}},"navbar":{"links":[{"href":"https://bloobank.com/support","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.bloobank.com"}},"footer":{"socials":{"website":"https://bloobank.com"}},"search":{"prompt":"Search the docs"},"seo":{"metatags":{"theme-color":"#5A81FA","description":"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.","og:locale":"en-US","og:url":"https://docs.bloobank.com","og:title":"Bloobank API Documentation","og:site_name":"Bloobank","og:description":"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.","og:image":"https://app.bloobank.com/img/twitter-image.png","og:image:width":"3584","og:image:height":"2062","og:image:type":"image/png","twitter:card":"summary_large_image","twitter:title":"Bloobank API Documentation","twitter:description":"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.","twitter:image":"https://app.bloobank.com/img/twitter-image.png"}},"fonts":{"family":"Inter"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"contextual":{"options":["copy","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"solutsco","hasAudioNarration":false,"actualSubdomain":"solutsco","customDomains":["developers.bloobank.com"],"gitSource":{"type":"github","owner":"exowayco","repo":"bloobank-docs-platform-core","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae957a627a0cba11e4a18d0:success","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Get Started","count":34},{"language":"default","tag":"API Reference","count":18},{"language":"default","tag":"Concepts","count":10},{"language":"default","tag":"Wallets","count":8},{"language":"default","tag":"Payment Orders","count":6},{"language":"default","tag":"Authentication","count":5},{"language":"default","tag":"Payments","count":5},{"language":"default","tag":"Webhooks","count":5},{"language":"default","tag":"Conventions","count":4},{"language":"default","tag":"Introduction","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#table-of-contents .toc-item{margin-bottom:0.5rem}#table-of-contents .toc a,#table-of-contents a{padding:0.35rem 0!important;line-height:1.6!important;display:block}#table-of-contents .toc{padding-top:0.5rem}article h2,.prose h2{margin-top:3rem!important;margin-bottom:1rem!important;padding-top:0.25rem;letter-spacing:-0.01em}article h3,.prose h3{margin-top:2.25rem!important;margin-bottom:0.75rem!important}article h4,.prose h4{margin-top:1.75rem!important;margin-bottom:0.5rem!important}article p,.prose p{line-height:1.75;margin-bottom:1.25rem}article ul li,article ol li,.prose ul li,.prose ol li{margin-bottom:0.5rem;line-height:1.7}.dark .card:hover,.dark [class*=\"Card_\"]:hover{border-color:rgba(92, 131, 250, 0.4)!important;transform:translateY(-1px);transition:border-color 0.2s, transform 0.2s}#sidebar a{line-height:1.6!important}"}],"page":{"pagePath":"api-reference/payment-orders/get","slug":"/api-reference/payment-orders/get","pageMetadata":{"title":"Get payment order","openapi":"GET /wallets/{wallet}/paymentOrders/{paymentOrder}","description":"Returns a single payment order by its identifier within the wallet scope.","href":"/api-reference/payment-orders/get"},"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: \"Returns a single payment order by its identifier within the wallet scope.\"\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={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Tip}=_components;if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns a single payment order by `,_jsx(_components.code,{children:`id`}),` within the wallet scope.`]}),`\n`,_jsxs(_components.p,{children:[`The response is the full order resource — see `,_jsx(_components.a,{href:`/api-reference/payment-orders/overview`,children:`Payment Orders overview`}),` for the field reference.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`For polling lifecycle transitions, fetch every 5–10 seconds while `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`PENDING`}),` or `,_jsx(_components.code,{children:`PROCESSING`}),`; stop once `,_jsx(_components.code,{children:`status`}),` reaches a final state (`,_jsx(_components.code,{children:`SUCCESS`}),`, `,_jsx(_components.code,{children:`FAILED`}),`, `,_jsx(_components.code,{children:`CANCELED`}),`, `,_jsx(_components.code,{children:`EXPIRED`}),`, `,_jsx(_components.code,{children:`REFUNDED`}),`). For production-grade integrations, `,_jsx(_components.a,{href:`/get-started/webhooks/overview`,children:`webhooks`}),` are strongly preferred over polling.`]})}),`\n`,_jsxs(_components.p,{children:[`If the order does not exist in this wallet, the API returns `,_jsx(_components.code,{children:`404 PAYMENT_ORDER_NOT_FOUND`}),`. Note that orders are wallet-scoped — the same `,_jsx(_components.code,{children:`paymentOrder`}),` id is not portable across wallets.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get payment order","openapi":"GET /wallets/{wallet}/paymentOrders/{paymentOrder}","description":"Returns a single payment order by its identifier within the wallet scope.","href":"/api-reference/payment-orders/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getPaymentOrder","summary":"Get payment order","tags":["Payment Orders"],"description":"Returns a single payment order by its identifier within the wallet scope.","responses":{"200":"33c644f4-8bd5-4744-9c87-5fb207e751a8","400":"3bdd6584-cd15-430e-bc06-8a0a336deb9a","401":"c9d8bfc4-65a8-449e-bc6f-b9bee62f0490","403":"2a7106d0-dbc2-4f21-88d5-57a74980a635","404":"a68f978e-94d2-4385-bf2d-61f2abf9383b","429":"f676e286-3154-4266-a6fb-d1699baf97c0","500":"f01f6177-c4d1-4233-a006-b3116fbfdd7f","503":"afe9a87a-1c68-47c0-bd08-081f6d5b2945"},"method":"get","type":"path","servers":["1bb2730f-5e3d-48d3-9a04-553715cf0f27"],"security":["1be67399-e2e9-47e4-8e12-ee5d6d30593a"],"path":"/wallets/{wallet}/paymentOrders/{paymentOrder}","baseUrlOptions":["https://txengine.bloobank.com/txengine/v1"],"title":"Get payment order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"753dc03c-8ffb-44cd-9c92-f303f9fe44ca":{"name":"wallet","in":"path","required":true,"description":"Wallet name (RFC 1035 DNS label).","schema":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$","minLength":1,"maxLength":63,"isRequired":true,"description":"Wallet name (RFC 1035 DNS label).","uniqueKey":"","typeLabel":"string"},"example":"production-main"},"444b40d7-b658-4f0a-912b-08eb7f788c05":{"name":"paymentOrder","in":"path","required":true,"description":"Payment order identifier.","schema":{"type":"string","pattern":"^ord_[A-Za-z0-9]+$","isRequired":true,"description":"Payment order identifier.","uniqueKey":"","typeLabel":"string"},"example":"ord_3KpFvBwYzNqMxA7eHbRdJ"}},"responses":{"33c644f4-8bd5-4744-9c87-5fb207e751a8":{"description":"The requested payment order.","content":{"application/json":{"schema":{"type":"object","description":"An inbound (cash-in) or outbound (cash-out) payment request routed through a provider network on behalf of a wallet.","required":["id","kind","wallet","ordVersion","direction","status","network","idempotencyKey","amount","currency","instrument","createdAt","updatedAt","selfName","etag"],"properties":{"id":{"type":"string","readOnly":true,"pattern":"^ord_[A-Za-z0-9]+$","example":"ord_3KpFvBwYzNqMxA7eHbRdJ","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"kind":{"type":"string","readOnly":true,"enum":["Payment.Order"],"isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"wallet":{"type":"string","readOnly":true,"description":"The wallet that owns this order (DNS label name).","example":"production-main","isRequired":true,"uniqueKey":"wallet","typeLabel":"string"},"ordVersion":{"type":"integer","readOnly":true,"minimum":1,"description":"Snapshot version, incremented on every content mutation.","isRequired":true,"uniqueKey":"ordVersion","typeLabel":"integer"},"direction":{"type":"string","description":"Direction of value flow.","enum":["IN","OUT"],"isRequired":true,"uniqueKey":"direction","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Lifecycle status of a payment order.","enum":["AWAITING_APPROVAL","PENDING","PROCESSING","SUCCESS","FAILED","CANCELED","EXPIRED","REFUNDED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"network":{"type":"string","description":"Payment network identifier.","enum":["br.gov.bcb.pix","tron.mainnet","solana.mainnet","bitcoin.mainnet","ethereum.mainnet"],"isRequired":true,"uniqueKey":"network","typeLabel":"enum\u003cstring>"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":64,"description":"Client-supplied opaque key. The `(wallet, idempotencyKey)` tuple\nis globally unique; identical retries return the existing order,\ndivergent retries return `IDEMPOTENCY_KEY_IN_USE_WITH_DIFFERENT_PARAMS`.\n","example":"invoice-2026-0184","isRequired":true,"uniqueKey":"idempotencyKey","typeLabel":"string"},"amount":{"type":"integer","format":"int64","minimum":1,"description":"Amount in minor units of the order currency.","example":25000,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"Currency or asset code.","enum":["BRL","USD","TRX","SOL","BTC","ETH","USDT"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"instrument":{"oneOf":[{"type":"object","description":"Inbound PIX instrument backed by a long-lived, reusable static EMV QR code.","required":["type"],"properties":{"type":{"type":"string","enum":["PIX_CASH_IN_EMV_STATIC"],"isRequired":true,"uniqueKey":"instrument.oneOf.0.type","typeLabel":"enum\u003cstring>"},"endToEndId":{"oneOf":[{"type":"string","readOnly":true,"description":"PIX end-to-end identifier, populated after the payer settles.","uniqueKey":"instrument.oneOf.0.endToEndId.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"PIX end-to-end identifier, populated after the payer settles.","uniqueKey":"instrument.oneOf.0.endToEndId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.0.endToEndId","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"instrument.oneOf.0","typeLabel":"object"},{"type":"object","description":"Inbound PIX instrument backed by a single-use dynamic EMV QR code with a configurable expiration.","required":["type"],"properties":{"type":{"type":"string","enum":["PIX_CASH_IN_EMV_DYNAMIC"],"isRequired":true,"uniqueKey":"instrument.oneOf.1.type","typeLabel":"enum\u003cstring>"},"endToEndId":{"oneOf":[{"type":"string","readOnly":true,"description":"PIX end-to-end identifier, populated after the payer settles.","uniqueKey":"instrument.oneOf.1.endToEndId.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"PIX end-to-end identifier, populated after the payer settles.","uniqueKey":"instrument.oneOf.1.endToEndId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.endToEndId","typeLabel":"string | null"},"expiresIn":{"type":"integer","minimum":1,"description":"QR code validity duration in seconds. Defaults to 86400 (24h) when omitted.","example":86400,"uniqueKey":"instrument.oneOf.1.expiresIn","typeLabel":"integer"},"debtorName":{"oneOf":[{"type":"string","uniqueKey":"instrument.oneOf.1.debtorName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instrument.oneOf.1.debtorName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorName","typeLabel":"string | null"},"debtorDocument":{"oneOf":[{"type":"string","description":"Brazilian tax ID (CPF or CNPJ).","uniqueKey":"instrument.oneOf.1.debtorDocument.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brazilian tax ID (CPF or CNPJ).","uniqueKey":"instrument.oneOf.1.debtorDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorDocument","typeLabel":"string | null"},"debtorAccount":{"oneOf":[{"type":"object","description":"Bank account details (typically for PIX cash-out instruments).","properties":{"ispb":{"oneOf":[{"type":"string","description":"ISPB code of the participating bank (8 digits).","example":"60746948","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.ispb.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISPB code of the participating bank (8 digits).","example":"60746948","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.ispb.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.ispb","typeLabel":"string | null"},"bankCode":{"oneOf":[{"type":"string","description":"Domestic bank routing code.","example":"237","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.bankCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Domestic bank routing code.","example":"237","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.bankCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.bankCode","typeLabel":"string | null"},"bankName":{"oneOf":[{"type":"string","example":"Banco Bradesco S.A.","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.bankName.oneOf.0","typeLabel":"string"},{"type":"null","example":"Banco Bradesco S.A.","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.bankName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.bankName","typeLabel":"string | null"},"agencyNumber":{"oneOf":[{"type":"string","example":"1234","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.agencyNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":"1234","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.agencyNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.agencyNumber","typeLabel":"string | null"},"accountType":{"oneOf":[{"type":"string","description":"Bank account category.","enum":["CHECKING_ACCOUNT","SAVINGS_ACCOUNT","PAYMENT_ACCOUNT","SALARY_ACCOUNT"],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountType","typeLabel":"enum\u003cstring> | null"},"accountNumber":{"oneOf":[{"type":"string","example":"987654-3","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":"987654-3","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountNumber","typeLabel":"string | null"},"accountOwnerName":{"oneOf":[{"type":"string","example":"Empresa Exemplo Ltda","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountOwnerName.oneOf.0","typeLabel":"string"},{"type":"null","example":"Empresa Exemplo Ltda","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountOwnerName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountOwnerName","typeLabel":"string | null"},"accountOwnerDocument":{"oneOf":[{"type":"string","description":"Brazilian tax ID (CPF or CNPJ).","pattern":"^(\\d{11}|\\d{14})$","example":"12345678000190","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountOwnerDocument.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brazilian tax ID (CPF or CNPJ).","pattern":"^(\\d{11}|\\d{14})$","example":"12345678000190","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountOwnerDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0.accountOwnerDocument","typeLabel":"string | null"}},"uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"instrument.oneOf.1.debtorAccount.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.debtorAccount","typeLabel":"object | null"},"qrcode":{"oneOf":[{"type":"string","readOnly":true,"description":"Provider-rendered QR code payload.","uniqueKey":"instrument.oneOf.1.qrcode.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Provider-rendered QR code payload.","uniqueKey":"instrument.oneOf.1.qrcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.qrcode","typeLabel":"string | null"},"copypaste":{"oneOf":[{"type":"string","readOnly":true,"description":"Provider-rendered copy-and-paste PIX payload.","uniqueKey":"instrument.oneOf.1.copypaste.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Provider-rendered copy-and-paste PIX payload.","uniqueKey":"instrument.oneOf.1.copypaste.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.copypaste","typeLabel":"string | null"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"description":"Absolute expiration timestamp computed by the provider.","uniqueKey":"instrument.oneOf.1.expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"description":"Absolute expiration timestamp computed by the provider.","uniqueKey":"instrument.oneOf.1.expiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.1.expiresAt","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"instrument.oneOf.1","typeLabel":"object"},{"type":"object","description":"Outbound PIX instrument addressing the creditor by a PIX key (CPF, CNPJ, phone, e-mail, or EVP).","required":["type","keyType","keyValue"],"properties":{"type":{"type":"string","enum":["PIX_CASH_OUT_KEY"],"isRequired":true,"uniqueKey":"instrument.oneOf.2.type","typeLabel":"enum\u003cstring>"},"keyType":{"type":"string","description":"Type of PIX key.","enum":["CPF","CNPJ","PHONE","EMAIL","EVP"],"isRequired":true,"uniqueKey":"instrument.oneOf.2.keyType","typeLabel":"enum\u003cstring>"},"keyValue":{"type":"string","description":"PIX key value, normalized according to `keyType`.","example":"+5511999998888","isRequired":true,"uniqueKey":"instrument.oneOf.2.keyValue","typeLabel":"string"},"endToEndId":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"instrument.oneOf.2.endToEndId.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"instrument.oneOf.2.endToEndId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.endToEndId","typeLabel":"string | null"},"creditorAccount":{"oneOf":[{"type":"object","description":"Resolved creditor account, populated by the provider after settlement.","properties":{"ispb":{"oneOf":[{"type":"string","description":"ISPB code of the participating bank (8 digits).","example":"60746948","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.ispb.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISPB code of the participating bank (8 digits).","example":"60746948","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.ispb.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.ispb","typeLabel":"string | null"},"bankCode":{"oneOf":[{"type":"string","description":"Domestic bank routing code.","example":"237","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.bankCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Domestic bank routing code.","example":"237","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.bankCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.bankCode","typeLabel":"string | null"},"bankName":{"oneOf":[{"type":"string","example":"Banco Bradesco S.A.","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.bankName.oneOf.0","typeLabel":"string"},{"type":"null","example":"Banco Bradesco S.A.","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.bankName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.bankName","typeLabel":"string | null"},"agencyNumber":{"oneOf":[{"type":"string","example":"1234","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.agencyNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":"1234","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.agencyNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.agencyNumber","typeLabel":"string | null"},"accountType":{"oneOf":[{"type":"string","description":"Bank account category.","enum":["CHECKING_ACCOUNT","SAVINGS_ACCOUNT","PAYMENT_ACCOUNT","SALARY_ACCOUNT"],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountType","typeLabel":"enum\u003cstring> | null"},"accountNumber":{"oneOf":[{"type":"string","example":"987654-3","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":"987654-3","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountNumber","typeLabel":"string | null"},"accountOwnerName":{"oneOf":[{"type":"string","example":"Empresa Exemplo Ltda","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountOwnerName.oneOf.0","typeLabel":"string"},{"type":"null","example":"Empresa Exemplo Ltda","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountOwnerName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountOwnerName","typeLabel":"string | null"},"accountOwnerDocument":{"oneOf":[{"type":"string","description":"Brazilian tax ID (CPF or CNPJ).","pattern":"^(\\d{11}|\\d{14})$","example":"12345678000190","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountOwnerDocument.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brazilian tax ID (CPF or CNPJ).","pattern":"^(\\d{11}|\\d{14})$","example":"12345678000190","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountOwnerDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0.accountOwnerDocument","typeLabel":"string | null"}},"uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"instrument.oneOf.2.creditorAccount.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.2.creditorAccount","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"instrument.oneOf.2","typeLabel":"object"},{"type":"object","description":"Outbound PIX instrument that pays an EMV (BRCode) payload presented by the creditor.","required":["type","emvValue"],"properties":{"type":{"type":"string","enum":["PIX_CASH_OUT_EMV"],"isRequired":true,"uniqueKey":"instrument.oneOf.3.type","typeLabel":"enum\u003cstring>"},"emvValue":{"type":"string","description":"The EMV (BRCode) payload string to be paid.","isRequired":true,"uniqueKey":"instrument.oneOf.3.emvValue","typeLabel":"string"},"endToEndId":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"instrument.oneOf.3.endToEndId.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"instrument.oneOf.3.endToEndId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.endToEndId","typeLabel":"string | null"},"keyType":{"oneOf":[{"type":"string","description":"Type of PIX key.","enum":["CPF","CNPJ","PHONE","EMAIL","EVP"],"uniqueKey":"instrument.oneOf.3.keyType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"instrument.oneOf.3.keyType.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.keyType","typeLabel":"enum\u003cstring> | null"},"keyValue":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"instrument.oneOf.3.keyValue.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"instrument.oneOf.3.keyValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.keyValue","typeLabel":"string | null"},"emvTxid":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"instrument.oneOf.3.emvTxid.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"instrument.oneOf.3.emvTxid.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.emvTxid","typeLabel":"string | null"},"emvAmount":{"oneOf":[{"type":"integer","format":"int64","readOnly":true,"description":"Amount encoded in the EMV payload (minor units).","uniqueKey":"instrument.oneOf.3.emvAmount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","readOnly":true,"description":"Amount encoded in the EMV payload (minor units).","uniqueKey":"instrument.oneOf.3.emvAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.emvAmount","typeLabel":"integer\u003cint64> | null"},"creditorAccount":{"oneOf":[{"type":"object","description":"Bank account details (typically for PIX cash-out instruments).","properties":{"ispb":{"oneOf":[{"type":"string","description":"ISPB code of the participating bank (8 digits).","example":"60746948","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.ispb.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISPB code of the participating bank (8 digits).","example":"60746948","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.ispb.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.ispb","typeLabel":"string | null"},"bankCode":{"oneOf":[{"type":"string","description":"Domestic bank routing code.","example":"237","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.bankCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Domestic bank routing code.","example":"237","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.bankCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.bankCode","typeLabel":"string | null"},"bankName":{"oneOf":[{"type":"string","example":"Banco Bradesco S.A.","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.bankName.oneOf.0","typeLabel":"string"},{"type":"null","example":"Banco Bradesco S.A.","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.bankName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.bankName","typeLabel":"string | null"},"agencyNumber":{"oneOf":[{"type":"string","example":"1234","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.agencyNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":"1234","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.agencyNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.agencyNumber","typeLabel":"string | null"},"accountType":{"oneOf":[{"type":"string","description":"Bank account category.","enum":["CHECKING_ACCOUNT","SAVINGS_ACCOUNT","PAYMENT_ACCOUNT","SALARY_ACCOUNT"],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountType","typeLabel":"enum\u003cstring> | null"},"accountNumber":{"oneOf":[{"type":"string","example":"987654-3","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":"987654-3","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountNumber","typeLabel":"string | null"},"accountOwnerName":{"oneOf":[{"type":"string","example":"Empresa Exemplo Ltda","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountOwnerName.oneOf.0","typeLabel":"string"},{"type":"null","example":"Empresa Exemplo Ltda","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountOwnerName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountOwnerName","typeLabel":"string | null"},"accountOwnerDocument":{"oneOf":[{"type":"string","description":"Brazilian tax ID (CPF or CNPJ).","pattern":"^(\\d{11}|\\d{14})$","example":"12345678000190","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountOwnerDocument.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brazilian tax ID (CPF or CNPJ).","pattern":"^(\\d{11}|\\d{14})$","example":"12345678000190","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountOwnerDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0.accountOwnerDocument","typeLabel":"string | null"}},"uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"instrument.oneOf.3.creditorAccount.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.creditorAccount","typeLabel":"object | null"},"emvObs":{"oneOf":[{"type":"string","readOnly":true,"description":"Observation field extracted from the EMV payload.","uniqueKey":"instrument.oneOf.3.emvObs.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Observation field extracted from the EMV payload.","uniqueKey":"instrument.oneOf.3.emvObs.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.3.emvObs","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"instrument.oneOf.3","typeLabel":"object"},{"type":"object","description":"Outbound PIX instrument addressing the creditor directly by bank account details, without a PIX key.","required":["type","creditorAccount"],"properties":{"type":{"type":"string","enum":["PIX_CASH_OUT_ACCOUNT"],"isRequired":true,"uniqueKey":"instrument.oneOf.4.type","typeLabel":"enum\u003cstring>"},"creditorAccount":{"type":"object","description":"Bank account details (typically for PIX cash-out instruments).","properties":{"ispb":{"oneOf":[{"type":"string","description":"ISPB code of the participating bank (8 digits).","example":"60746948","uniqueKey":"instrument.oneOf.4.creditorAccount.ispb.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISPB code of the participating bank (8 digits).","example":"60746948","uniqueKey":"instrument.oneOf.4.creditorAccount.ispb.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.creditorAccount.ispb","typeLabel":"string | null"},"bankCode":{"oneOf":[{"type":"string","description":"Domestic bank routing code.","example":"237","uniqueKey":"instrument.oneOf.4.creditorAccount.bankCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Domestic bank routing code.","example":"237","uniqueKey":"instrument.oneOf.4.creditorAccount.bankCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.creditorAccount.bankCode","typeLabel":"string | null"},"bankName":{"oneOf":[{"type":"string","example":"Banco Bradesco S.A.","uniqueKey":"instrument.oneOf.4.creditorAccount.bankName.oneOf.0","typeLabel":"string"},{"type":"null","example":"Banco Bradesco S.A.","uniqueKey":"instrument.oneOf.4.creditorAccount.bankName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.creditorAccount.bankName","typeLabel":"string | null"},"agencyNumber":{"oneOf":[{"type":"string","example":"1234","uniqueKey":"instrument.oneOf.4.creditorAccount.agencyNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":"1234","uniqueKey":"instrument.oneOf.4.creditorAccount.agencyNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.creditorAccount.agencyNumber","typeLabel":"string | null"},"accountType":{"oneOf":[{"type":"string","description":"Bank account category.","enum":["CHECKING_ACCOUNT","SAVINGS_ACCOUNT","PAYMENT_ACCOUNT","SALARY_ACCOUNT"],"uniqueKey":"instrument.oneOf.4.creditorAccount.accountType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"instrument.oneOf.4.creditorAccount.accountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.creditorAccount.accountType","typeLabel":"enum\u003cstring> | null"},"accountNumber":{"oneOf":[{"type":"string","example":"987654-3","uniqueKey":"instrument.oneOf.4.creditorAccount.accountNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":"987654-3","uniqueKey":"instrument.oneOf.4.creditorAccount.accountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.creditorAccount.accountNumber","typeLabel":"string | null"},"accountOwnerName":{"oneOf":[{"type":"string","example":"Empresa Exemplo Ltda","uniqueKey":"instrument.oneOf.4.creditorAccount.accountOwnerName.oneOf.0","typeLabel":"string"},{"type":"null","example":"Empresa Exemplo Ltda","uniqueKey":"instrument.oneOf.4.creditorAccount.accountOwnerName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.creditorAccount.accountOwnerName","typeLabel":"string | null"},"accountOwnerDocument":{"oneOf":[{"type":"string","description":"Brazilian tax ID (CPF or CNPJ).","pattern":"^(\\d{11}|\\d{14})$","example":"12345678000190","uniqueKey":"instrument.oneOf.4.creditorAccount.accountOwnerDocument.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brazilian tax ID (CPF or CNPJ).","pattern":"^(\\d{11}|\\d{14})$","example":"12345678000190","uniqueKey":"instrument.oneOf.4.creditorAccount.accountOwnerDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.creditorAccount.accountOwnerDocument","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"instrument.oneOf.4.creditorAccount","typeLabel":"object"},"endToEndId":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"instrument.oneOf.4.endToEndId.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"instrument.oneOf.4.endToEndId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.oneOf.4.endToEndId","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"instrument.oneOf.4","typeLabel":"object"}],"isRequired":true,"uniqueKey":"instrument","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Server-assigned creation timestamp (UTC ISO 8601).","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp of the last content mutation (UTC ISO 8601).","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"selfName":{"type":"string","readOnly":true,"description":"Canonical relative resource name.","example":"wallets/production-main/paymentOrders/ord_3KpFvBwYzNqMxA7eHbRdJ","isRequired":true,"uniqueKey":"selfName","typeLabel":"string"},"etag":{"type":"string","readOnly":true,"description":"Hex-encoded content fingerprint of the resource. Reserved for\noptimistic concurrency control via the `If-Match` request header\nin a future release; currently exposed for informational and\naudit purposes only.\n","pattern":"^[a-f0-9]{64,128}$","isRequired":true,"uniqueKey":"etag","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Client-supplied tags. Not included in the etag computation.","example":{"orderId":"2026-0184"},"uniqueKey":"metadata","typeLabel":"object"},"errorCode":{"oneOf":[{"type":"string","readOnly":true,"description":"Provider-reported error code when `status` is `FAILED`.","uniqueKey":"errorCode.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Provider-reported error code when `status` is `FAILED`.","uniqueKey":"errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"errorCode","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","readOnly":true,"description":"Human-readable error description when `status` is `FAILED`.","uniqueKey":"errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Human-readable error description when `status` is `FAILED`.","uniqueKey":"errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"errorMessage","typeLabel":"string | null"},"processedAt":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"description":"Server processing timestamp. `null` until the order is submitted\nto (or rejected by) the underlying provider; set once the\nprovider returns a definitive outcome.\n","uniqueKey":"processedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"description":"Server processing timestamp. `null` until the order is submitted\nto (or rejected by) the underlying provider; set once the\nprovider returns a definitive outcome.\n","uniqueKey":"processedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"processedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"ord_3KpFvBwYzNqMxA7eHbRdJ","kind":"Payment.Order","wallet":"production-main","ordVersion":2,"direction":"IN","status":"AWAITING_APPROVAL","network":"br.gov.bcb.pix","idempotencyKey":"invoice-2026-0184","amount":25000,"currency":"BRL","instrument":{"type":"PIX_CASH_IN_EMV_STATIC","endToEndId":"\u003cstring>"},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","selfName":"wallets/production-main/paymentOrders/ord_3KpFvBwYzNqMxA7eHbRdJ","etag":"\u003cstring>","metadata":{"orderId":"2026-0184"},"errorCode":"\u003cstring>","errorMessage":"\u003cstring>","processedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"3bdd6584-cd15-430e-bc06-8a0a336deb9a":{"description":"Request contract violation. The request is malformed.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":400,"status":"INVALID_ARGUMENT","message":"Filter expression references an unsupported field.","details":[{"reason":"INVALID_ARGUMENT","description":"Field `nonexistent` is not allowed for filtering on this endpoint.","metadata":{}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":400,"status":"INVALID_ARGUMENT","message":"Filter expression references an unsupported field.","details":[{"reason":"INVALID_ARGUMENT","description":"Field `nonexistent` is not allowed for filtering on this endpoint.","metadata":{}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"c9d8bfc4-65a8-449e-bc6f-b9bee62f0490":{"description":"Authentication failure.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":401,"status":"SIGNATURE_INVALID","message":"Request signature could not be verified.","details":[{"reason":"SIGNATURE_INVALID","description":"The provided signature does not match the canonical request.","metadata":{"decisionId":"acd_9RmKvTpYzH2wN8qJ5b"}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":401,"status":"SIGNATURE_INVALID","message":"Request signature could not be verified.","details":[{"reason":"SIGNATURE_INVALID","description":"The provided signature does not match the canonical request.","metadata":{"decisionId":"acd_9RmKvTpYzH2wN8qJ5b"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"2a7106d0-dbc2-4f21-88d5-57a74980a635":{"description":"Authenticated, but not authorized for this action on this resource.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":403,"status":"RBAC_DENY","message":"The credential is not permitted to perform this action.","details":[{"reason":"RBAC_DENY","description":"Missing required role binding on the target resource.","metadata":{"decisionId":"acd_8PaJvNqLcK3xW5sR4d"}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":403,"status":"RBAC_DENY","message":"The credential is not permitted to perform this action.","details":[{"reason":"RBAC_DENY","description":"Missing required role binding on the target resource.","metadata":{"decisionId":"acd_8PaJvNqLcK3xW5sR4d"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"a68f978e-94d2-4385-bf2d-61f2abf9383b":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":404,"status":"WALLET_NOT_FOUND","message":"Wallet not found.","details":[{"reason":"WALLET_NOT_FOUND","description":"No wallet exists with name `production-main`.","metadata":{}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":404,"status":"WALLET_NOT_FOUND","message":"Wallet not found.","details":[{"reason":"WALLET_NOT_FOUND","description":"No wallet exists with name `production-main`.","metadata":{}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"f676e286-3154-4266-a6fb-d1699baf97c0":{"description":"Rate limit exceeded for this credential. Honor the `Retry-After`\nheader, then retry with exponential backoff — see the\n[rate-limiting guide](/get-started/concepts/rate-limiting).\n","headers":{"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":429,"status":"RESOURCE_EXHAUSTED","message":"Rate limit exceeded for this credential.","details":[{"reason":"RESOURCE_EXHAUSTED","description":"You have exceeded the request quota for this endpoint.","metadata":{"retry_after_seconds":12}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":429,"status":"RESOURCE_EXHAUSTED","message":"Rate limit exceeded for this credential.","details":[{"reason":"RESOURCE_EXHAUSTED","description":"You have exceeded the request quota for this endpoint.","metadata":{"retry_after_seconds":12}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"f01f6177-c4d1-4233-a006-b3116fbfdd7f":{"description":"An unexpected error occurred on the server.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":500,"status":"INTERNAL","message":"An unexpected error occurred.","details":[{"reason":"INTERNAL","description":"Internal server error.","metadata":{"id":"exc_5KaHsBxYzW3pM2dV"}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":500,"status":"INTERNAL","message":"An unexpected error occurred.","details":[{"reason":"INTERNAL","description":"Internal server error.","metadata":{"id":"exc_5KaHsBxYzW3pM2dV"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"afe9a87a-1c68-47c0-bd08-081f6d5b2945":{"description":"A downstream dependency is currently unavailable.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned by every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["code","status","message","details"],"properties":{"code":{"type":"integer","description":"HTTP status code echo.","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"status":{"type":"string","description":"Canonical error identifier. Stable; safe to branch on programmatically.","isRequired":true,"uniqueKey":"error.status","typeLabel":"string"},"message":{"type":"string","description":"Human-readable summary. May vary between releases — do not string-match on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Stable code identifying this specific diagnostic.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].reason","typeLabel":"string"},"description":{"type":"string","description":"Human-readable explanation of the specific detail.","uniqueKey":"error.details.items.[INDEX].description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"description":"Key-value context. For DENY decisions contains `decisionId`.\nFor 5xx errors may contain `id` — the exception record id\n(format `exc_…`) to quote when contacting support.\n","uniqueKey":"error.details.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":503,"status":"PROVIDER_UNAVAILABLE","message":"Upstream payment provider is unavailable.","details":[{"reason":"PROVIDER_UNAVAILABLE","description":"The provider returned a transient error or did not respond.","metadata":{"id":"exc_5KaHsBxYzW3pM2dV"}}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":503,"status":"PROVIDER_UNAVAILABLE","message":"Upstream payment provider is unavailable.","details":[{"reason":"PROVIDER_UNAVAILABLE","description":"The provider returned a transient error or did not respond.","metadata":{"id":"exc_5KaHsBxYzW3pM2dV"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"1be67399-e2e9-47e4-8e12-ee5d6d30593a":{"AccessKey":{"type":"apiKey","in":"header","name":"X-Access-Key","description":"Opaque credential identifier provisioned during onboarding. See the\n[Integration Guide](https://developers.bloobank.com/iam/integration)\nfor the request-signing protocol.\n","scopes":[]},"AccessTimestamp":{"type":"apiKey","in":"header","name":"X-Access-Timestamp","description":"Unix epoch timestamp in UTC milliseconds. See the Integration Guide\nfor skew tolerance.\n","scopes":[]},"AccessRequestId":{"type":"apiKey","in":"header","name":"X-Access-Request-Id","description":"Unique identifier per request (UUID v4 recommended). The\n`(accessKey, requestId)` tuple must be unique within the replay\nwindow defined by the Integration Guide.\n","scopes":[]},"AccessSignature":{"type":"apiKey","in":"header","name":"X-Access-Signature","description":"Base64-encoded ECDSA signature of the canonical request, computed\nwith the private key paired to `X-Access-Key`. See the Integration\nGuide for canonicalization rules and reference implementations.\n","scopes":[]}}},"servers":{"1bb2730f-5e3d-48d3-9a04-553715cf0f27":{"url":"https://txengine.bloobank.com/txengine/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Access-Key","description":"Opaque credential identifier provisioned during onboarding. See the\n[Integration Guide](https://developers.bloobank.com/iam/integration)\nfor the request-signing protocol.\n","scopes":[]},"schema":{"title":"X-Access-Key","type":"string","description":"Opaque credential identifier provisioned during onboarding. See the\n[Integration Guide](https://developers.bloobank.com/iam/integration)\nfor the request-signing protocol.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessKey","name":"X-Access-Key"},{"scheme":{"type":"apiKey","in":"header","name":"X-Access-Timestamp","description":"Unix epoch timestamp in UTC milliseconds. See the Integration Guide\nfor skew tolerance.\n","scopes":[]},"schema":{"title":"X-Access-Timestamp","type":"string","description":"Unix epoch timestamp in UTC milliseconds. See the Integration Guide\nfor skew tolerance.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessTimestamp","name":"X-Access-Timestamp"},{"scheme":{"type":"apiKey","in":"header","name":"X-Access-Request-Id","description":"Unique identifier per request (UUID v4 recommended). The\n`(accessKey, requestId)` tuple must be unique within the replay\nwindow defined by the Integration Guide.\n","scopes":[]},"schema":{"title":"X-Access-Request-Id","type":"string","description":"Unique identifier per request (UUID v4 recommended). The\n`(accessKey, requestId)` tuple must be unique within the replay\nwindow defined by the Integration Guide.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessRequestId","name":"X-Access-Request-Id"},{"scheme":{"type":"apiKey","in":"header","name":"X-Access-Signature","description":"Base64-encoded ECDSA signature of the canonical request, computed\nwith the private key paired to `X-Access-Key`. See the Integration\nGuide for canonicalization rules and reference implementations.\n","scopes":[]},"schema":{"title":"X-Access-Signature","type":"string","description":"Base64-encoded ECDSA signature of the canonical request, computed\nwith the private key paired to `X-Access-Key`. See the Integration\nGuide for canonicalization rules and reference implementations.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessSignature","name":"X-Access-Signature"}],"title":"AccessKey \u0026 AccessTimestamp \u0026 AccessRequestId \u0026 AccessSignature"}]},"originalFileLocation":"openapi-v1.yml"},"subdomain":"solutsco","siteName":"Bloobank","title":"Bloobank API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-06T07:11:42.677Z","originalFileLocation":"api-reference/payment-orders/get.mdx"},"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=\"Returns a single payment order by its identifier within the wallet scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bloobank\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_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/solutsco/-h8GthN2_cqd1gsr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Bloobank API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bloobank\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.bloobank.com/api-reference/payment-orders/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://app.bloobank.com/img/twitter-image.png\">\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=\"Bloobank API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Bloobank Transactions Engine API — wallets, payment orders (PIX), and webhooks.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://app.bloobank.com/img/twitter-image.png\">\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/solutsco/-h8GthN2_cqd1gsr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bloobank\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5c83fa\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en-US\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#5A81FA\">\u003cmeta data-mint-head name=\"og:image:type\" content=\"image/png\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.bloobank.com/api-reference/payment-orders/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payment-orders/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.bloobank.com/#organization\",\"name\":\"Bloobank\",\"url\":\"https://developers.bloobank.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/solutsco/uVFX2_9nfUfZo-fT/logo/light.svg?fit=max\u0026auto=format\u0026n=uVFX2_9nfUfZo-fT\u0026q=85\u0026s=3fb00233ac5afd400ef9320c4dc20082\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.bloobank.com#website\",\"name\":\"Bloobank\",\"url\":\"https://developers.bloobank.com\",\"publisher\":{\"@id\":\"https://developers.bloobank.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.bloobank.com/api-reference/payment-orders/get#webpage\",\"url\":\"https://developers.bloobank.com/api-reference/payment-orders/get\",\"name\":\"Get payment order\",\"description\":\"Returns a single payment order by its identifier within the wallet scope.\",\"dateModified\":\"2026-08-06T07:11:42.677Z\",\"isPartOf\":{\"@id\":\"https://developers.bloobank.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.bloobank.com/api-reference/payment-orders/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.bloobank.com/api-reference/payment-orders/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payment Orders\",\"item\":\"https://developers.bloobank.com/api-reference/payment-orders/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get payment order\",\"item\":\"https://developers.bloobank.com/api-reference/payment-orders/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.bloobank.com/api-reference/payment-orders/get#apireference\",\"headline\":\"Get payment order\",\"name\":\"Get payment order\",\"description\":\"Returns a single payment order by its identifier within the wallet scope.\",\"url\":\"https://developers.bloobank.com/api-reference/payment-orders/get\",\"mainEntityOfPage\":{\"@id\":\"https://developers.bloobank.com/api-reference/payment-orders/get#webpage\"},\"image\":\"https://app.bloobank.com/img/twitter-image.png\",\"dateModified\":\"2026-08-06T07:11:42.677Z\",\"publisher\":{\"@id\":\"https://developers.bloobank.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.bloobank.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bloobank\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Bloobank\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/payment-orders/get.md","siteName":"Bloobank","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/get-started/overview"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"API Reference","icon":"code","href":"/api-reference/introduction"}]},{"group":"Conventions","pages":[{"title":"HTTP","icon":"globe","href":"/api-reference/conventions/http"},{"title":"Errors","icon":"bug","href":"/api-reference/conventions/errors"},{"title":"Pagination","icon":"arrow-down","href":"/api-reference/conventions/pagination"},{"title":"Filtering (SFS-1)","icon":"filter","href":"/api-reference/conventions/filtering"}]},{"group":"Wallets","pages":[{"title":"Wallets","icon":"wallet","href":"/api-reference/wallets/overview"},{"title":"List wallets","openapi":"GET /wallets","href":"/api-reference/wallets/list"},{"title":"Create wallet","openapi":"POST /wallets","href":"/api-reference/wallets/create"},{"title":"Get wallet","openapi":"GET /wallets/{wallet}","href":"/api-reference/wallets/get"},{"title":"Update wallet","openapi":"PUT /wallets/{wallet}","href":"/api-reference/wallets/update"},{"title":"Get wallet balance","openapi":"GET /wallets/{wallet}/balance","href":"/api-reference/wallets/get-balance"}]},{"group":"Payment Orders","pages":[{"title":"Payment Orders","icon":"money-bill-transfer","href":"/api-reference/payment-orders/overview"},{"title":"List payment orders","openapi":"GET /wallets/{wallet}/paymentOrders","href":"/api-reference/payment-orders/list"},{"title":"Create payment order","openapi":"POST /wallets/{wallet}/paymentOrders","description":"Creates a payment order for the given wallet.\n\nThe `idempotencyKey` is strongly recommended: it makes the request\nsafe to retry. Duplicate creates with the same `(wallet, idempotencyKey)`\nand an identical body return the existing order; divergent bodies\nreturn `IDEMPOTENCY_KEY_IN_USE_WITH_DIFFERENT_PARAMS`.\n\nThe `instrument` field is a discriminated union by `type`; the\nsupported variants reflect provider capabilities.\n\nOutbound (`direction: OUT`) orders are created in `AWAITING_APPROVAL`\nstatus and require an explicit `approve` call before being submitted\nfor processing. Inbound (`direction: IN`) orders are submitted to the\nprovider immediately and start in `PENDING`.\n","href":"/api-reference/payment-orders/create"},{"title":"Get payment order","openapi":"GET /wallets/{wallet}/paymentOrders/{paymentOrder}","href":"/api-reference/payment-orders/get"},{"title":"Approve payment order","openapi":"PUT /wallets/{wallet}/paymentOrders/{paymentOrder}/approve","description":"Approves an outbound payment order awaiting approval. Transitions\n`status` from `AWAITING_APPROVAL` to `PENDING` and submits the order\nfor provider processing.\n\nOnly valid for outbound (`direction: OUT`) orders in\n`AWAITING_APPROVAL`; any other state returns\n`PAYMENT_ORDER_NOT_AWAITING_APPROVAL`.\n","href":"/api-reference/payment-orders/approve"},{"title":"Cancel payment order","openapi":"PUT /wallets/{wallet}/paymentOrders/{paymentOrder}/cancel","href":"/api-reference/payment-orders/cancel"}]},{"group":"Utilities","pages":[{"title":"Check Server Time","openapi":"GET /time","href":"/api-reference/server-time/check-server-time"}]}]}]},"basePath":"","title":"Bloobank API Documentation","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}