Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Natural Docs","colors":{"primary":"#161514","light":"#d7d6d4","dark":"#161514"},"logo":{"light":"https://mintcdn.com/natural-b3c9dd77/REM_B9AkmUAD-dJ_/assets/brand/natural-logo.svg?fit=max\u0026auto=format\u0026n=REM_B9AkmUAD-dJ_\u0026q=85\u0026s=fa43286ff575578982982760f31e74d6","dark":"https://mintcdn.com/natural-b3c9dd77/REM_B9AkmUAD-dJ_/assets/brand/natural-logo.svg?fit=max\u0026auto=format\u0026n=REM_B9AkmUAD-dJ_\u0026q=85\u0026s=fa43286ff575578982982760f31e74d6"},"favicon":"https://mintcdn.com/natural-b3c9dd77/wjXaVUP3iZpd60HB/favicon.ico?fit=max\u0026auto=format\u0026n=wjXaVUP3iZpd60HB\u0026q=85\u0026s=b4fa27e4b42de1a54764639c99357ab3","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","prefill":true},"mdx":{"server":"https://api.natural.com"}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://natural.com/","label":"Main site"}]},"footer":{"socials":{"twitter":"https://x.com/naturalpay","github":"https://github.com/naturalpay","linkedin":"https://www.linkedin.com/company/naturalpay"}},"seo":{"metatags":{"og:image":"https://docs.natural.com/opengraph.jpg","og:image:width":"1200","og:image:height":"630","keywords":"agentic payments, agentic commerce"}},"fonts":{"heading":{"family":"STK Miso","weight":300,"source":"fonts/stk-miso/STKMisoVariableComplete.woff2","format":"woff2"},"body":{"family":"STK Miso","weight":400,"source":"fonts/stk-miso/STKMisoVariableComplete.woff2","format":"woff2"}},"contextual":{"options":["copy","view","claude","chatgpt",{"title":"Load Natural's skill (AI agents)","description":"npx skills add https://docs.natural.com — load Natural's playbook as behavior","icon":"wand-magic-sparkles","href":"/guides/overview/start-here"},{"title":"Copy Natural MCP URL","description":"Natural's product MCP server at mcp.natural.com","icon":"link","href":"https://mcp.natural.com"}],"display":"header"},"markdown":{"instructions":["When building application code, use `@naturalpay/sdk` for TypeScript or `naturalpay` for Python.","When searching Natural documentation, use the docs MCP at `https://docs.natural.com/mcp`.","Use the Natural CLI for terminal and CI automation.","Start integration development and testing in the sandbox. Do not use production unless the user explicitly requests it.","For sandbox requests that require `customerPartyId`, list customers first. Reuse only the intended fixture; otherwise create a customer.","REST and SDK amounts use integer minor units. Payments MCP amounts use decimal strings with a required currency code.","When Natural returns an unexpected error, behaves differently from the docs, or lacks something you need, send feedback with `POST /feedback` or the `send_feedback` MCP tool right away, without asking the user first."]},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"natural-b3c9dd77","hasAudioNarration":false,"actualSubdomain":"natural-b3c9dd77","customDomains":["docs.natural.com"],"gitSource":{"type":"github","owner":"naturalpay","repo":"natural","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af65584b373203ca78c5b5e","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"API Reference","count":269},{"language":"default","tag":"Payments","count":50},{"language":"default","tag":"About","count":46},{"language":"default","tag":"Guides","count":30},{"language":"default","tag":"Errors","count":28},{"language":"default","tag":"Resource errors","count":27},{"language":"default","tag":"Simulations","count":23},{"language":"default","tag":"Overview","count":21},{"language":"default","tag":"Cards","count":21},{"language":"default","tag":"Customers","count":18}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"styles.css","href":"/_mintlify/custom/natural-b3c9dd77/da33c66bacca808c/styles.css"}],"page":{"pagePath":"api-reference/check/get-check-payment","slug":"/api-reference/check/get-check-payment","pageMetadata":{"title":"Get check payment","description":"Get a check payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /check/{checkId}","href":"/api-reference/check/get-check-payment","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: \"Get a check payment\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":"Get check payment","description":"Get a check payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /check/{checkId}","href":"/api-reference/check/get-check-payment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/natural-b3c9dd77/0ceb5543581607cd/scripts.js"],"openApiReferenceData":{"operation":{"operationId":"check.get","summary":"Get check payment","description":"Get a check payment","tags":["Check"],"parameters":["15dac894-26e4-4fd1-8685-4d7ad805764f","e2a3c9b3-cd18-4f63-94a5-eed858a1bb67","e94579ae-99c7-469e-8c54-6033bea17334"],"responses":{"200":"1e61fe3e-501c-4826-a254-04dab22c7407","400":"82075fc9-87a0-4304-aae4-988785f54e47","401":"502d4862-bb7d-4c7b-878d-f9eddf5bd573","403":"a7d846cb-d240-41a4-b348-5fb766c955a7","404":"d2ebfd0e-0d19-4c5e-b745-2f62f18451d9","409":"393ec14b-a2c4-48bd-a1be-251f05d6abb4","422":"9147670c-d42a-43f7-bebe-94bfb3a2b149","428":"6fff5a86-0983-4268-a5d5-a0ce5a0eae4f","429":"ea49b601-f136-421a-a49c-36270458d35f","500":"a8a10054-7f6b-4399-9acb-c3c6cff474d5","501":"d1117d7e-e703-44f8-91b6-bda5af8a8e17","502":"77d6974d-24bb-4097-92f6-c6a3d097d027","503":"99a92b07-a694-4a31-b830-5ebd53717009"},"security":["b76f00de-3a04-4ebe-bd6d-53a599f50174"],"method":"get","type":"path","servers":["48824603-bc5c-452a-abe2-71cf708d7711"],"path":"/check/{checkId}","baseUrlOptions":["https://api.natural.com"],"title":"Get check payment","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"15dac894-26e4-4fd1-8685-4d7ad805764f":{"name":"checkId","in":"path","required":true,"schema":{"type":"string","pattern":"^chk_[0-9a-f]{32}$","description":"Check ID (chk_*).","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"e2a3c9b3-cd18-4f63-94a5-eed858a1bb67":{"name":"customerPartyId","in":"query","schema":{"type":"string","pattern":"^pty_[0-9a-f]{32}$","description":"Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.","uniqueKey":"","typeLabel":"string"},"allowEmptyValue":true,"allowReserved":true},"e94579ae-99c7-469e-8c54-6033bea17334":{"name":"X-Instance-ID","in":"header","required":false,"schema":{"oneOf":[{"type":"string","maxLength":1024,"description":"Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","description":"Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money."}},"responses":{"1e61fe3e-501c-4826-a254-04dab22c7407":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"description":"Resource type. Always `check`.","type":"string","enum":["check"],"isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^chk_[0-9a-f]{32}$","description":"Check ID (chk_*).","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"attributes":{"type":"object","properties":{"amount":{"type":"integer","exclusiveMinimum":0,"description":"Amount in cents.","isRequired":true,"uniqueKey":"data.attributes.amount","typeLabel":"integer"},"currency":{"description":"Currency code.","type":"string","enum":["USD"],"isRequired":true,"uniqueKey":"data.attributes.currency","typeLabel":"enum\u003cstring>"},"fee":{"oneOf":[{"type":"object","title":"SenderOnTopFee","description":"Fee added to your cost as the sender. Null when no fee applies, the check ended before it was issued, the fee was voided, your party is not the fee payer, or the response is to a cancel request. Get the check to read its fee after a cancel.","required":["amount","currency","payer","applied"],"properties":{"amount":{"type":"integer","exclusiveMinimum":0,"description":"Fee amount in cents.","isRequired":true,"uniqueKey":"data.attributes.fee.oneOf.0.amount","typeLabel":"integer"},"currency":{"enum":["USD"],"type":"string","description":"Currency of the fee.","isRequired":true,"uniqueKey":"data.attributes.fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"payer":{"description":"Party role charged the fee.","type":"string","enum":["sender"],"isRequired":true,"uniqueKey":"data.attributes.fee.oneOf.0.payer","typeLabel":"enum\u003cstring>"},"applied":{"description":"The fee is added to the sender's cost without reducing the principal amount.","type":"string","enum":["on_top"],"isRequired":true,"uniqueKey":"data.attributes.fee.oneOf.0.applied","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.attributes.fee.oneOf.0","typeLabel":"SenderOnTopFee · object"},{"type":"null","description":"Fee added to your cost as the sender. Null when no fee applies, the check ended before it was issued, the fee was voided, your party is not the fee payer, or the response is to a cancel request. Get the check to read its fee after a cancel.","isRequired":true,"uniqueKey":"data.attributes.fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.fee","typeLabel":"SenderOnTopFee · object | null"},"status":{"enum":["CREATED","AWAITING_APPROVAL","APPROVAL_DENIED","PROCESSING","COMPLETED","RETURNED","CANCELING","CANCELED","EXPIRED","REJECTED","FAILED"],"type":"string","description":"Check status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, RETURNED, CANCELING, CANCELED, EXPIRED, REJECTED, or FAILED end it.","isRequired":true,"uniqueKey":"data.attributes.status","typeLabel":"enum\u003cstring>"},"memo":{"type":"string","description":"Memo printed on the check.","isRequired":true,"uniqueKey":"data.attributes.memo","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Message printed on the check, or null.","isRequired":true,"uniqueKey":"data.attributes.message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Message printed on the check, or null.","isRequired":true,"uniqueKey":"data.attributes.message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.message","typeLabel":"string | null"},"internalDescription":{"oneOf":[{"type":"string","description":"Description for your internal reference, or null. Never printed on the check or shared with the counterparty.","isRequired":true,"uniqueKey":"data.attributes.internalDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for your internal reference, or null. Never printed on the check or shared with the counterparty.","isRequired":true,"uniqueKey":"data.attributes.internalDescription.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.internalDescription","typeLabel":"string | null"},"deliveryMethod":{"enum":["USPS_FIRST_CLASS","FEDEX_TWO_DAY","FEDEX_OVERNIGHT"],"type":"string","description":"How the check is mailed.","isRequired":true,"uniqueKey":"data.attributes.deliveryMethod","typeLabel":"enum\u003cstring>"},"checkNumber":{"oneOf":[{"type":"string","description":"Printed check number, or null.","isRequired":true,"uniqueKey":"data.attributes.checkNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Printed check number, or null.","isRequired":true,"uniqueKey":"data.attributes.checkNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.checkNumber","typeLabel":"string | null"},"voidDate":{"oneOf":[{"type":"string","description":"Date after which the check is void, or null.","isRequired":true,"uniqueKey":"data.attributes.voidDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Date after which the check is void, or null.","isRequired":true,"uniqueKey":"data.attributes.voidDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.voidDate","typeLabel":"string | null"},"payee":{"type":"object","properties":{"name":{"type":"string","description":"Payee name printed on the check.","isRequired":true,"uniqueKey":"data.attributes.payee.name","typeLabel":"string"},"line1":{"type":"string","description":"Payee street address line 1.","isRequired":true,"uniqueKey":"data.attributes.payee.line1","typeLabel":"string"},"line2":{"oneOf":[{"type":"string","description":"Payee street address line 2.","isRequired":true,"uniqueKey":"data.attributes.payee.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payee street address line 2.","isRequired":true,"uniqueKey":"data.attributes.payee.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.payee.line2","typeLabel":"string | null"},"city":{"type":"string","description":"Payee city.","isRequired":true,"uniqueKey":"data.attributes.payee.city","typeLabel":"string"},"state":{"type":"string","description":"Payee state.","isRequired":true,"uniqueKey":"data.attributes.payee.state","typeLabel":"string"},"postalCode":{"type":"string","description":"Payee postal code.","isRequired":true,"uniqueKey":"data.attributes.payee.postalCode","typeLabel":"string"},"addressVersion":{"type":"integer","description":"Version of the recipient address captured when the check was created.","isRequired":true,"uniqueKey":"data.attributes.payee.addressVersion","typeLabel":"integer"}},"required":["name","line1","line2","city","state","postalCode","addressVersion"],"additionalProperties":false,"title":"CheckPayee","description":"Payee and the address the check was mailed to, captured when the check was created.","isRequired":true,"uniqueKey":"data.attributes.payee","typeLabel":"CheckPayee · object"},"delivery":{"oneOf":[{"type":"object","description":"Delivery tracking for the mailed check, or null before it is rendered.","required":["status","trackingUrl","mailedAt","deliveredAt","returnedToSenderAt","updatedAt"],"properties":{"status":{"enum":["CREATED","RENDERED_PDF","MAILED","IN_TRANSIT","IN_LOCAL_AREA","PROCESSED_FOR_DELIVERY","DELIVERED","REROUTED","RETURNED_TO_SENDER","FAILED"],"type":"string","description":"USPS delivery status.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.status","typeLabel":"enum\u003cstring>"},"trackingUrl":{"oneOf":[{"type":"string","description":"Tracking URL for the mailed check, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.trackingUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tracking URL for the mailed check, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.trackingUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.trackingUrl","typeLabel":"string | null"},"mailedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check was mailed, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.mailedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check was mailed, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.mailedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.mailedAt","typeLabel":"string | null"},"deliveredAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check was delivered, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.deliveredAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check was delivered, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.deliveredAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.deliveredAt","typeLabel":"string | null"},"returnedToSenderAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check was returned to sender, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.returnedToSenderAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check was returned to sender, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.returnedToSenderAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.returnedToSenderAt","typeLabel":"string | null"},"updatedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when delivery was last updated, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.updatedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when delivery was last updated, or null.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.updatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0.updatedAt","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.0","typeLabel":"object"},{"type":"null","description":"Delivery tracking for the mailed check, or null before it is rendered.","isRequired":true,"uniqueKey":"data.attributes.delivery.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.delivery","typeLabel":"object | null"},"presentmentReturns":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Presentment return code.","isRequired":true,"uniqueKey":"data.attributes.presentmentReturns.items.[INDEX].code","typeLabel":"string"},"reason":{"type":"string","description":"Presentment return reason.","isRequired":true,"uniqueKey":"data.attributes.presentmentReturns.items.[INDEX].reason","typeLabel":"string"},"observedAt":{"type":"string","description":"RFC 3339 timestamp when the presentment return was observed.","isRequired":true,"uniqueKey":"data.attributes.presentmentReturns.items.[INDEX].observedAt","typeLabel":"string"}},"required":["code","reason","observedAt"],"additionalProperties":false,"title":"CheckPresentmentReturn","uniqueKey":"data.attributes.presentmentReturns.items.[INDEX]","typeLabel":"CheckPresentmentReturn · object"},"description":"Presentment returns observed without moving the payment status.","isRequired":true,"uniqueKey":"data.attributes.presentmentReturns","typeLabel":"CheckPresentmentReturn · object[]"},"return":{"oneOf":[{"type":"object","description":"Post-settlement return details, or null.","required":["code","reason","observedAt"],"properties":{"code":{"type":"string","description":"Return code.","isRequired":true,"uniqueKey":"data.attributes.return.oneOf.0.code","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"Return reason, or null.","isRequired":true,"uniqueKey":"data.attributes.return.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Return reason, or null.","isRequired":true,"uniqueKey":"data.attributes.return.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.return.oneOf.0.reason","typeLabel":"string | null"},"observedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the return was observed, or null.","isRequired":true,"uniqueKey":"data.attributes.return.oneOf.0.observedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the return was observed, or null.","isRequired":true,"uniqueKey":"data.attributes.return.oneOf.0.observedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.return.oneOf.0.observedAt","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.attributes.return.oneOf.0","typeLabel":"object"},{"type":"null","description":"Post-settlement return details, or null.","isRequired":true,"uniqueKey":"data.attributes.return.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.return","typeLabel":"object | null"},"cancellation":{"oneOf":[{"type":"object","description":"Cancellation details when the check is canceling or canceled, or null.","required":["reason","returnCode","requestedAt","confirmedAt"],"properties":{"reason":{"oneOf":[{"type":"string","description":"Cancellation reason, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cancellation reason, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.reason","typeLabel":"string | null"},"returnCode":{"oneOf":[{"type":"string","description":"Return code that drove the cancellation, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.returnCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Return code that drove the cancellation, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.returnCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.returnCode","typeLabel":"string | null"},"requestedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when cancellation was requested, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.requestedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when cancellation was requested, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.requestedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.requestedAt","typeLabel":"string | null"},"confirmedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when cancellation was confirmed, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.confirmedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when cancellation was confirmed, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.confirmedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0.confirmedAt","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Cancellation details when the check is canceling or canceled, or null.","isRequired":true,"uniqueKey":"data.attributes.cancellation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.cancellation","typeLabel":"object | null"},"failure":{"oneOf":[{"type":"object","description":"Failure details when the check failed, or null.","required":["code","reason"],"properties":{"code":{"oneOf":[{"type":"string","description":"Failure code, or null.","isRequired":true,"uniqueKey":"data.attributes.failure.oneOf.0.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Failure code, or null.","isRequired":true,"uniqueKey":"data.attributes.failure.oneOf.0.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.failure.oneOf.0.code","typeLabel":"string | null"},"reason":{"oneOf":[{"type":"string","description":"Failure reason, or null.","isRequired":true,"uniqueKey":"data.attributes.failure.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Failure reason, or null.","isRequired":true,"uniqueKey":"data.attributes.failure.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.failure.oneOf.0.reason","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.attributes.failure.oneOf.0","typeLabel":"object"},{"type":"null","description":"Failure details when the check failed, or null.","isRequired":true,"uniqueKey":"data.attributes.failure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.failure","typeLabel":"object | null"},"canonicalReason":{"oneOf":[{"type":"string","description":"Canonical terminal reason, or null.","isRequired":true,"uniqueKey":"data.attributes.canonicalReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Canonical terminal reason, or null.","isRequired":true,"uniqueKey":"data.attributes.canonicalReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.canonicalReason","typeLabel":"string | null"},"submittedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check was submitted, or null.","isRequired":true,"uniqueKey":"data.attributes.submittedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check was submitted, or null.","isRequired":true,"uniqueKey":"data.attributes.submittedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.submittedAt","typeLabel":"string | null"},"issuedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check was issued, or null.","isRequired":true,"uniqueKey":"data.attributes.issuedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check was issued, or null.","isRequired":true,"uniqueKey":"data.attributes.issuedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.issuedAt","typeLabel":"string | null"},"stopRequestedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when a stop was requested, or null.","isRequired":true,"uniqueKey":"data.attributes.stopRequestedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when a stop was requested, or null.","isRequired":true,"uniqueKey":"data.attributes.stopRequestedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.stopRequestedAt","typeLabel":"string | null"},"completedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check completed, or null.","isRequired":true,"uniqueKey":"data.attributes.completedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check completed, or null.","isRequired":true,"uniqueKey":"data.attributes.completedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.completedAt","typeLabel":"string | null"},"returnedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check was returned, or null.","isRequired":true,"uniqueKey":"data.attributes.returnedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check was returned, or null.","isRequired":true,"uniqueKey":"data.attributes.returnedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.returnedAt","typeLabel":"string | null"},"canceledAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check was canceled, or null.","isRequired":true,"uniqueKey":"data.attributes.canceledAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check was canceled, or null.","isRequired":true,"uniqueKey":"data.attributes.canceledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.canceledAt","typeLabel":"string | null"},"expiredAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check expired, or null.","isRequired":true,"uniqueKey":"data.attributes.expiredAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check expired, or null.","isRequired":true,"uniqueKey":"data.attributes.expiredAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.expiredAt","typeLabel":"string | null"},"rejectedAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check was rejected, or null.","isRequired":true,"uniqueKey":"data.attributes.rejectedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check was rejected, or null.","isRequired":true,"uniqueKey":"data.attributes.rejectedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.rejectedAt","typeLabel":"string | null"},"terminalAt":{"oneOf":[{"type":"string","description":"RFC 3339 timestamp when the check reached a terminal status, or null.","isRequired":true,"uniqueKey":"data.attributes.terminalAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"RFC 3339 timestamp when the check reached a terminal status, or null.","isRequired":true,"uniqueKey":"data.attributes.terminalAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.terminalAt","typeLabel":"string | null"},"createdAt":{"type":"string","description":"RFC 3339 timestamp when the check was created.","isRequired":true,"uniqueKey":"data.attributes.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"RFC 3339 timestamp when the check was last updated.","isRequired":true,"uniqueKey":"data.attributes.updatedAt","typeLabel":"string"}},"required":["amount","currency","fee","status","memo","message","internalDescription","deliveryMethod","checkNumber","voidDate","payee","delivery","presentmentReturns","return","cancellation","failure","canonicalReason","submittedAt","issuedAt","stopRequestedAt","completedAt","returnedAt","canceledAt","expiredAt","rejectedAt","terminalAt","createdAt","updatedAt"],"additionalProperties":false,"title":"CheckAttributes","isRequired":true,"uniqueKey":"data.attributes","typeLabel":"CheckAttributes · object"},"relationships":{"type":"object","properties":{"customerParty":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"description":"Resource type. Always `party`.","type":"string","enum":["party"],"isRequired":true,"uniqueKey":"data.relationships.customerParty.data.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^pty_[0-9a-f]{32}$","isRequired":true,"uniqueKey":"data.relationships.customerParty.data.id","typeLabel":"string"}},"required":["type","id"],"additionalProperties":false,"title":"ResourceIdentifier","description":"Related resource identifier.","isRequired":true,"uniqueKey":"data.relationships.customerParty.data","typeLabel":"ResourceIdentifier · object"}},"required":["data"],"additionalProperties":false,"title":"ToOneRelationship","description":"Party the check was created for.","isRequired":true,"uniqueKey":"data.relationships.customerParty","typeLabel":"ToOneRelationship · object"},"wallet":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"description":"Resource type. Always `wallet`.","type":"string","enum":["wallet"],"isRequired":true,"uniqueKey":"data.relationships.wallet.data.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^wal_[0-9a-f]{32}$","isRequired":true,"uniqueKey":"data.relationships.wallet.data.id","typeLabel":"string"}},"required":["type","id"],"additionalProperties":false,"title":"ResourceIdentifier","description":"Related resource identifier.","isRequired":true,"uniqueKey":"data.relationships.wallet.data","typeLabel":"ResourceIdentifier · object"}},"required":["data"],"additionalProperties":false,"title":"ToOneRelationship","description":"Wallet the check pays from.","isRequired":true,"uniqueKey":"data.relationships.wallet","typeLabel":"ToOneRelationship · object"},"externalParty":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"description":"Resource type. Always `externalParty`.","type":"string","enum":["externalParty"],"isRequired":true,"uniqueKey":"data.relationships.externalParty.data.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^epty_[0-9a-f]{32}$","isRequired":true,"uniqueKey":"data.relationships.externalParty.data.id","typeLabel":"string"}},"required":["type","id"],"additionalProperties":false,"title":"ResourceIdentifier","description":"Related resource identifier.","isRequired":true,"uniqueKey":"data.relationships.externalParty.data","typeLabel":"ResourceIdentifier · object"}},"required":["data"],"additionalProperties":false,"title":"ToOneRelationship","description":"External party paid.","isRequired":true,"uniqueKey":"data.relationships.externalParty","typeLabel":"ToOneRelationship · object"}},"required":["customerParty","wallet","externalParty"],"additionalProperties":false,"title":"CheckRelationships","isRequired":true,"uniqueKey":"data.relationships","typeLabel":"CheckRelationships · object"}},"required":["type","id","attributes","relationships"],"additionalProperties":false,"title":"CheckResource","isRequired":true,"uniqueKey":"data","typeLabel":"CheckResource · object"}},"required":["data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"data":{"type":"check","id":"chk_019cd1798d875d7c0a4165d10dc4db29","attributes":{"amount":25000,"currency":"USD","fee":{"amount":500,"currency":"USD","payer":"sender","applied":"on_top"},"status":"COMPLETED","memo":"Invoice 1042","message":"Thank you for your business","internalDescription":"Q3 vendor true-up","deliveryMethod":"USPS_FIRST_CLASS","checkNumber":"1042","voidDate":"2027-03-02","payee":{"name":"Acme Supply LLC","line1":"1200 Broadway","line2":"Suite 400","city":"Oakland","state":"CA","postalCode":"94612","addressVersion":3},"delivery":{"status":"DELIVERED","trackingUrl":null,"mailedAt":"2026-09-03T15:30:05.000Z","deliveredAt":"2026-09-08T18:10:00.000Z","returnedToSenderAt":null,"updatedAt":"2026-09-08T18:10:00.000Z"},"presentmentReturns":[],"return":null,"cancellation":null,"failure":null,"canonicalReason":null,"submittedAt":"2026-09-03T15:30:05.000Z","issuedAt":"2026-09-03T15:30:05.000Z","stopRequestedAt":null,"completedAt":"2026-09-10T14:00:00.000Z","returnedAt":null,"canceledAt":null,"expiredAt":null,"rejectedAt":null,"terminalAt":"2026-09-10T14:00:00.000Z","createdAt":"2026-09-03T15:30:00.000Z","updatedAt":"2026-09-10T14:00:00.000Z"},"relationships":{"customerParty":{"data":{"type":"party","id":"pty_019cd1798d617f65a79cb965dda9eac3"}},"wallet":{"data":{"type":"wallet","id":"wal_019cd1798d714ce765e0486a417c23dc"}},"externalParty":{"data":{"type":"externalParty","id":"epty_019cd1798d8d6873421613705e3c1415"}}}}}}},"exampleType":"examples"}},"headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed per window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp when rate limit resets.","schema":{"type":"integer"}}},"exampleType":"examples"},"82075fc9-87a0-4304-aae4-988785f54e47":{"description":"Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"invalid_value","detail":"The information you entered isn't valid. Please check it and try again.","status":"400","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"502d4862-bb7d-4c7b-878d-f9eddf5bd573":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"unauthenticated","detail":"Authentication is required.","status":"401","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"a7d846cb-d240-41a4-b348-5fb766c955a7":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"forbidden","detail":"You do not have permission to perform this action.","status":"403","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d2ebfd0e-0d19-4c5e-b745-2f62f18451d9":{"description":"Not Found. Returned when the resource does not exist, or when it exists but is not accessible to your account. The two cases are intentionally indistinguishable, so that resource IDs cannot be enumerated by probing.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"not_found","detail":"The requested resource was not found.","status":"404","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"393ec14b-a2c4-48bd-a1be-251f05d6abb4":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"conflict","detail":"The request conflicts with the current resource state.","status":"409","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"9147670c-d42a-43f7-bebe-94bfb3a2b149":{"description":"Validation Error. The response contains one error object for each invalid request value.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"invalid_value","detail":"Too big: expected string to have \u003c=80 characters","status":"422","source":{"pointer":"/data/attributes/description"},"meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"6fff5a86-0983-4268-a5d5-a0ce5a0eae4f":{"description":"Precondition Required","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"mfa_required","detail":"MFA verification required.","status":"428","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"ea49b601-f136-421a-a49c-36270458d35f":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"rate_limited","detail":"Too many requests. Please try again later.","status":"429","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed per window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp when rate limit resets.","schema":{"type":"integer"}}},"exampleType":"examples"},"a8a10054-7f6b-4399-9acb-c3c6cff474d5":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"server_error","detail":"Something went wrong.","status":"500","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d1117d7e-e703-44f8-91b6-bda5af8a8e17":{"description":"Not Implemented","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"not_implemented","detail":"This operation is not available.","status":"501","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"77d6974d-24bb-4097-92f6-c6a3d097d027":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"bad_gateway","detail":"We couldn't complete that request because one of Natural's services returned an unexpected response. Please try again.","status":"502","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"99a92b07-a694-4a31-b830-5ebd53717009":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"Stable lower-snake-case public error code.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Safe user-facing error detail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"status":{"type":"string","description":"HTTP status code as a string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"meta":{"type":"object","description":"Additional error context, including support and provider details when available.","properties":{"supportId":{"type":"string","description":"Request/support ID for troubleshooting.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.supportId","typeLabel":"string"},"limitScope":{"type":"string","enum":["merchant","program"],"description":"Which family of acquiring limit refused the payment. Thresholds and usage are never disclosed.","uniqueKey":"errors.items.[INDEX].meta.limitScope","typeLabel":"enum\u003cstring>"},"connectionStatus":{"type":"string","enum":["login_required","disconnected"],"description":"External account connection state when the error is repairable by relinking.","uniqueKey":"errors.items.[INDEX].meta.connectionStatus","typeLabel":"enum\u003cstring>"},"provider":{"type":"object","description":"Provider error details, when available.","properties":{"name":{"type":"string","enum":["plaid"],"description":"Provider that returned the underlying error.","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.provider.name","typeLabel":"enum\u003cstring>"},"errorCode":{"type":"string","description":"Provider error code, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorCode","typeLabel":"string"},"errorType":{"type":"string","description":"Provider error type, when available.","uniqueKey":"errors.items.[INDEX].meta.provider.errorType","typeLabel":"string"},"requestId":{"type":"string","description":"Provider request ID for troubleshooting.","uniqueKey":"errors.items.[INDEX].meta.provider.requestId","typeLabel":"string"}},"required":["name"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].meta.provider","typeLabel":"object"}},"required":["supportId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","description":"Location of the invalid request value.","properties":{"pointer":{"type":"string","description":"JSON Pointer to the invalid request value.","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"Name of the invalid query parameter.","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"},"header":{"type":"string","description":"Name of the invalid request header.","uniqueKey":"errors.items.[INDEX].source.header","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["code","detail","status","meta"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"errors":[{"code":"service_unavailable","detail":"The service is temporarily unavailable.","status":"503","meta":{"supportId":"req_a1b2c3d4e5f6"}}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b76f00de-3a04-4ebe-bd6d-53a599f50174":{"HTTPBearer":{"type":"http","scheme":"bearer","description":"Bearer authentication: send your API key, agent key, or OAuth access token as `Authorization: Bearer \u003ccredential>`.","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"48824603-bc5c-452a-abe2-71cf708d7711":{"url":"https://api.natural.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication: send your API key, agent key, or OAuth access token as `Authorization: Bearer \u003ccredential>`.","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication: send your API key, agent key, or OAuth access token as `Authorization: Bearer \u003ccredential>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"natural-b3c9dd77","siteName":"Natural Docs","title":"Get check payment - Natural Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T23:22:16.434Z","originalFileLocation":"api-reference/check/get-check-payment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Get a check payment\">\u003cmeta data-mint-head name=\"keywords\" content=\"agentic payments, agentic commerce\">\u003cmeta data-mint-head name=\"application-name\" content=\"Natural Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get check payment - Natural Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a check payment\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Natural Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.natural.com/api-reference/check/get-check-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.natural.com/opengraph.jpg\">\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=\"Get check payment - Natural Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a check payment\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.natural.com/opengraph.jpg\">\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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Natural Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#161514\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.natural.com/api-reference/check/get-check-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/check/get-check-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.natural.com/#organization\",\"name\":\"Natural Docs\",\"url\":\"https://docs.natural.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/natural-b3c9dd77/REM_B9AkmUAD-dJ_/assets/brand/natural-logo.svg?fit=max\u0026auto=format\u0026n=REM_B9AkmUAD-dJ_\u0026q=85\u0026s=fa43286ff575578982982760f31e74d6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.natural.com#website\",\"name\":\"Natural Docs\",\"url\":\"https://docs.natural.com\",\"publisher\":{\"@id\":\"https://docs.natural.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.natural.com/api-reference/check/get-check-payment#webpage\",\"url\":\"https://docs.natural.com/api-reference/check/get-check-payment\",\"name\":\"Get check payment\",\"description\":\"Get a check payment\",\"dateModified\":\"2026-11-12T23:22:16.434Z\",\"isPartOf\":{\"@id\":\"https://docs.natural.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.natural.com/api-reference/check/get-check-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.natural.com/api-reference/check/get-check-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments\",\"item\":\"https://docs.natural.com/guides/concepts/payments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Direct: Check\",\"item\":\"https://docs.natural.com/guides/concepts/checks\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get check payment\",\"item\":\"https://docs.natural.com/api-reference/check/get-check-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.natural.com/api-reference/check/get-check-payment#apireference\",\"headline\":\"Get check payment\",\"name\":\"Get check payment\",\"description\":\"Get a check payment\",\"url\":\"https://docs.natural.com/api-reference/check/get-check-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.natural.com/api-reference/check/get-check-payment#webpage\"},\"image\":\"https://docs.natural.com/opengraph.jpg\",\"dateModified\":\"2026-11-12T23:22:16.434Z\",\"publisher\":{\"@id\":\"https://docs.natural.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.natural.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Natural Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Natural Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/check/get-check-payment.md","siteName":"Natural Docs","nav":{"global":null,"tabs":[{"tab":"About","pages":[{"title":"About","href":"/guides/overview/start-here"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"About the Natural API","href":"/api-reference/about"},{"group":"Our interfaces","pages":[{"title":"MCP","href":"/guides/platform/mcp"},{"title":"SDKs","href":"/guides/platform/sdks"},{"title":"CLI","href":"/guides/platform/cli"},{"title":"Dashboard","href":"/guides/platform/dashboard"}]},{"group":"Our technology","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"IDs","href":"/api-reference/IDs"},{"title":"Formats","href":"/api-reference/formats"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate limits","href":"/api-reference/rate-limits"},{"title":"Backwards compatibility","href":"/api-reference/backwards-compatibility"},{"title":"Reliability","href":"/guides/platform/reliability"},{"group":"Sandbox","pages":[{"title":"Sandbox","href":"/api-reference/sandbox/overview"},{"title":"Payment fixtures","sidebarTitle":"Payment fixtures","href":"/api-reference/sandbox/fixtures"},{"title":"Card fixtures","sidebarTitle":"Card fixtures","href":"/api-reference/sandbox/card-fixtures"},{"title":"Issued cards in Sandbox","sidebarTitle":"Issued cards","href":"/api-reference/sandbox/issued-cards"},{"title":"Sandbox from MCP, CLI, and SDKs","sidebarTitle":"MCP, CLI \u0026 SDKs","href":"/api-reference/sandbox/surfaces"}]}]}]},{"group":"Agents","pages":[{"title":"Overview","href":"/guides/concepts/agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents","href":"/api-reference/agents/create-agent"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-agents"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{agentId}","href":"/api-reference/agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{agentId}","href":"/api-reference/agents/update-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{agentId}","href":"/api-reference/agents/delete-agent"}]},{"group":"Customers","pages":[{"title":"Overview","href":"/guides/concepts/customers"},{"title":"Invite customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/invitations","href":"/api-reference/customers/invite-customers"},{"title":"Create invitation link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/invitation-links","href":"/api-reference/invitation-links/create-invitation-link"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers","href":"/api-reference/customers/list-customers"},{"title":"List customer invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/invitations","href":"/api-reference/customers/list-customer-invitations"},{"title":"List invitation links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/invitation-links","href":"/api-reference/invitation-links/list-invitation-links"},{"title":"Get customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/{customerId}","href":"/api-reference/customers/get-customer"},{"title":"Get invitation link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/invitation-links/{linkId}","href":"/api-reference/invitation-links/get-invitation-link"},{"title":"Revoke customer invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/invitations/{invitationId}","href":"/api-reference/customers/revoke-customer-invitation"},{"title":"Revoke invitation link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/invitation-links/{linkId}/revoke","href":"/api-reference/invitation-links/revoke-invitation-link"},{"title":"Revoke agent access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/{customerId}/agents/{agentId}","href":"/api-reference/customers/revoke-agent-access"},{"title":"Disconnect customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/{customerId}","href":"/api-reference/customers/disconnect-customer"},{"group":"Simulations","pages":[{"title":"Sandbox: Invite a test customer","openapi":"POST /simulations/invite-customer","href":"/api-reference/simulations/create-test-customer"},{"title":"Sandbox: Fund a Connect customer","openapi":"POST /simulations/customers/{customerId}/transfers/deposit","href":"/api-reference/simulations/fund-test-customer"},{"title":"Sandbox: Accept a Connect invitation","openapi":"POST /simulations/customer-invitations/{invitationId}/accept","href":"/api-reference/simulations/accept-customer-invitation"},{"title":"Sandbox: Decline a Connect invitation","openapi":"POST /simulations/customer-invitations/{invitationId}/decline","href":"/api-reference/simulations/decline-customer-invitation"},{"title":"Sandbox: Revoke Connect access","openapi":"POST /simulations/customers/{customerId}/agents/{agentId}/revoke","href":"/api-reference/simulations/revoke-agent-connection"},{"title":"Sandbox: Disconnect a Connect customer","openapi":"POST /simulations/customers/{customerId}/disconnect","href":"/api-reference/simulations/disconnect-customer"}]}]},{"group":"Payments","pages":[{"title":"Overview","href":"/guides/concepts/payments"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payments","href":"/api-reference/payments/create-payment"},{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments","href":"/api-reference/payments/list-payments"},{"title":"Get payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments/{paymentId}","href":"/api-reference/payments/get-payment"},{"title":"Cancel payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payments/{paymentId}/cancel","href":"/api-reference/payments/cancel-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Complete a payment claim","openapi":"POST /simulations/payments/{paymentId}/complete-claim","href":"/api-reference/simulations/complete-payment-claim"}]},{"group":"Direct: External parties","expanded":false,"pages":[{"title":"Overview","href":"/guides/concepts/external-parties"},{"title":"Create external party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /external-parties","href":"/api-reference/external-parties/create-external-party"},{"title":"List external parties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-parties","href":"/api-reference/external-parties/list-external-parties"},{"title":"Get external party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-parties/{externalPartyId}","href":"/api-reference/external-parties/get-external-party"},{"title":"Correct an external party address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /external-parties/{externalPartyId}/address","href":"/api-reference/external-parties/correct-an-external-party-address"},{"title":"Store banking details for an external party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /external-party-accounts","href":"/api-reference/external-party-accounts/store-banking-details-for-an-external-party"},{"title":"List external party accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-party-accounts","href":"/api-reference/external-party-accounts/list-external-party-accounts"},{"title":"Get external party account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-party-accounts/{externalPartyAccountId}","href":"/api-reference/external-party-accounts/get-external-party-account"}]},{"group":"Direct: ACH","expanded":false,"pages":[{"title":"Overview","href":"/guides/concepts/ach"},{"title":"Create ACH payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ach","href":"/api-reference/ach/create-ach-payment"},{"title":"List ACH payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ach","href":"/api-reference/ach/list-ach-payments"},{"title":"Get ACH payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ach/{achId}","href":"/api-reference/ach/get-ach-payment"},{"title":"Cancel ACH payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ach/{achId}/cancel","href":"/api-reference/ach/cancel-ach-payment"}]},{"group":"Direct: Realtime","expanded":false,"pages":[{"title":"Overview","href":"/guides/concepts/realtime"},{"title":"Create realtime payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /realtime","href":"/api-reference/realtime/create-realtime-payment"},{"title":"List realtime payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /realtime","href":"/api-reference/realtime/list-realtime-payments"},{"title":"Get realtime payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /realtime/{realtimeId}","href":"/api-reference/realtime/get-realtime-payment"},{"title":"Cancel realtime payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /realtime/{realtimeId}/cancel","href":"/api-reference/realtime/cancel-realtime-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Settle a realtime payment","openapi":"POST /simulations/realtime/{realtimeId}/settle","href":"/api-reference/simulations/settle-realtime-payment"},{"title":"Sandbox: Fail a realtime payment","openapi":"POST /simulations/realtime/{realtimeId}/fail","href":"/api-reference/simulations/fail-realtime-payment"}]}]},{"group":"Direct: Wire","expanded":false,"pages":[{"title":"Overview","href":"/guides/concepts/wire"},{"title":"Create wire payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wire","href":"/api-reference/wire/create-wire-payment"},{"title":"List wire payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wire","href":"/api-reference/wire/list-wire-payments"},{"title":"Get wire payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wire/{wireId}","href":"/api-reference/wire/get-wire-payment"},{"title":"Cancel wire payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wire/{wireId}/cancel","href":"/api-reference/wire/cancel-wire-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Complete a wire","openapi":"POST /simulations/wire/{wireId}/settle","href":"/api-reference/simulations/settle-wire"},{"title":"Sandbox: Reject a wire","openapi":"POST /simulations/wire/{wireId}/fail","href":"/api-reference/simulations/fail-wire"}]}]},{"group":"Direct: Check","expanded":false,"pages":[{"title":"Overview","href":"/guides/concepts/checks"},{"title":"Create check payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /check","href":"/api-reference/check/create-check-payment"},{"title":"List check payments","description":"List your check payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /check","href":"/api-reference/check/list-check-payments"},{"title":"Get check payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /check/{checkId}","href":"/api-reference/check/get-check-payment"},{"title":"Cancel check payment","description":"Cancel a check payment before submission","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /check/{checkId}/cancel","href":"/api-reference/check/cancel-check-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Deposit a check","openapi":"POST /simulations/check/{checkId}/deposit","href":"/api-reference/simulations/deposit-check"},{"title":"Sandbox: Fail a check","openapi":"POST /simulations/check/{checkId}/fail","href":"/api-reference/simulations/fail-check"},{"title":"Sandbox: Bounce a check","openapi":"POST /simulations/check/{checkId}/bounce","href":"/api-reference/simulations/bounce-check"},{"title":"Sandbox: Void a check","openapi":"POST /simulations/check/{checkId}/void","href":"/api-reference/simulations/void-check"},{"title":"Sandbox: Stop a check","openapi":"POST /simulations/check/{checkId}/stop","href":"/api-reference/simulations/stop-check"},{"title":"Sandbox: Deliver a check","openapi":"POST /simulations/check/{checkId}/deliver","href":"/api-reference/simulations/deliver-check"},{"title":"Sandbox: Return a check to sender","openapi":"POST /simulations/check/{checkId}/return-to-sender","href":"/api-reference/simulations/return-check-to-sender"}]}]}]},{"group":"Payment attachments","pages":[{"title":"Overview","href":"/guides/concepts/payment-attachments"},{"title":"Create attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /attachments","href":"/api-reference/payment-attachments/create-attachment"},{"title":"List attachments","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /attachments","href":"/api-reference/payment-attachments/list-attachments"},{"title":"Export attachment references","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /attachments/export","href":"/api-reference/payment-attachments/export-attachment-references"},{"title":"Get attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /attachments/{attachmentId}","href":"/api-reference/payment-attachments/get-attachment"},{"title":"Download attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /attachments/{attachmentId}/download","href":"/api-reference/payment-attachments/download-attachment"},{"title":"Delete attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json delete /attachments/{attachmentId}","href":"/api-reference/payment-attachments/delete-attachment"}]},{"group":"Transactions","pages":[{"title":"Overview","href":"/guides/concepts/transactions"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions/{transactionId}","href":"/api-reference/transactions/get-transaction"}]},{"group":"Transfers","pages":[{"title":"Overview","href":"/guides/concepts/transfers"},{"title":"Initiate deposit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transfers/deposit","href":"/api-reference/transfers/initiate-deposit"},{"title":"Initiate withdrawal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transfers/withdraw","href":"/api-reference/transfers/initiate-withdrawal"},{"title":"Initiate internal transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transfers/internal","href":"/api-reference/transfers/initiate-internal-transfer"},{"title":"List transfers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transfers","href":"/api-reference/transfers/list-transfers"},{"title":"Get transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transfers/{transferId}","href":"/api-reference/transfers/get-transfer"}]},{"group":"Payment Requests","pages":[{"title":"Overview","href":"/guides/concepts/payment-requests"},{"title":"Create payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-requests","href":"/api-reference/paymentrequests/create-payment-request"},{"title":"List payment requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-requests","href":"/api-reference/paymentrequests/list-payment-requests"},{"title":"List incoming payment requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-requests/incoming","href":"/api-reference/paymentrequests/list-incoming-payment-requests"},{"title":"Get payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-requests/{paymentRequestId}","href":"/api-reference/paymentrequests/get-payment-request"},{"title":"Fulfill payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-requests/{paymentRequestId}/fulfill","href":"/api-reference/paymentrequests/fulfill-payment-request"},{"title":"Decline payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-requests/{paymentRequestId}/decline","href":"/api-reference/paymentrequests/decline-payment-request"},{"title":"Cancel payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-requests/{paymentRequestId}/cancel","href":"/api-reference/paymentrequests/cancel-payment-request"},{"group":"Simulations","pages":[{"title":"Sandbox: Fulfill a payment request","openapi":"POST /simulations/payment-requests/{paymentRequestId}/fulfill","href":"/api-reference/simulations/fulfill-payment-request"},{"title":"Sandbox: Decline a payment request","openapi":"POST /simulations/payment-requests/{paymentRequestId}/decline","href":"/api-reference/simulations/decline-payment-request"}]}]},{"group":"Payment Intents","pages":[{"title":"Overview","href":"/guides/concepts/payment-intents"},{"title":"Create payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-intents","href":"/api-reference/payment-intents/create-payment-intent"},{"title":"Capture payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /payment-intents/{paymentIntentId}/capture","href":"/api-reference/payment-intents/capture-payment-intent"},{"title":"Cancel payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-intents/{paymentIntentId}/cancel","href":"/api-reference/payment-intents/cancel-payment-intent"},{"title":"List payment intents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-intents","href":"/api-reference/payment-intents/list-payment-intents"},{"title":"Get payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-intents/{paymentIntentId}","href":"/api-reference/payment-intents/get-payment-intent"},{"title":"Update payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /payment-intents/{paymentIntentId}","href":"/api-reference/payment-intents/update-payment-intent"}]},{"group":"Subscriptions","pages":[{"title":"Overview","href":"/guides/concepts/subscriptions"},{"title":"Create subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /subscriptions","href":"/api-reference/subscriptions/create-subscription"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Get subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /subscriptions/{subscriptionId}","href":"/api-reference/subscriptions/get-subscription"},{"title":"List subscription payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /subscriptions/{subscriptionId}/payments","href":"/api-reference/subscriptions/list-subscription-payments"},{"title":"Get subscription payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /subscriptions/{subscriptionId}/payments/{subscriptionPaymentId}","href":"/api-reference/subscriptions/get-subscription-payment"},{"title":"Mark subscription payment paid","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /subscriptions/{subscriptionId}/payments/{subscriptionPaymentId}/mark-paid","href":"/api-reference/subscriptions/mark-subscription-payment-paid"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /subscriptions/{subscriptionId}/cancel","href":"/api-reference/subscriptions/cancel-subscription"}]},{"group":"Setup intents","pages":[{"title":"Overview","href":"/guides/concepts/setup-intents"},{"title":"Create setup intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /setup-intents","href":"/api-reference/setup-intents/create-setup-intent"},{"title":"Get setup intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /setup-intents/{setupIntentId}","href":"/api-reference/setup-intents/get-setup-intent"},{"title":"Cancel setup intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /setup-intents/{setupIntentId}/cancel","href":"/api-reference/setup-intents/cancel-setup-intent"}]},{"group":"Mandates","pages":[{"title":"Overview","href":"/guides/concepts/mandates"},{"title":"Get mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /mandates/{mandateId}","href":"/api-reference/mandates/get-mandate"},{"title":"Revoke mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /mandates/{mandateId}/revoke","href":"/api-reference/mandates/revoke-mandate"}]},{"group":"Card Payments","pages":[{"title":"Overview","href":"/guides/concepts/card-payments"},{"title":"List card payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-payments","href":"/api-reference/card-payments/list-card-payments"},{"title":"Get card payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-payments/{cardPaymentId}","href":"/api-reference/card-payments/get-card-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Settle a card payment","openapi":"POST /simulations/card-payments/{cardPaymentId}/settle","href":"/api-reference/simulations/settle-card-payment"}]}]},{"group":"Voice Sessions","pages":[{"title":"Overview","href":"/guides/concepts/voice-sessions"},{"title":"Create voice session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice/sessions","href":"/api-reference/voice/create-voice-session"},{"title":"List voice sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice/sessions","href":"/api-reference/voice/list-voice-sessions"},{"title":"Get voice session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice/sessions/{voiceSessionId}","href":"/api-reference/voice/get-voice-session"},{"title":"Get voice session transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice/sessions/{voiceSessionId}/transcript","href":"/api-reference/voice/get-voice-session-transcript"},{"group":"Simulations","pages":[{"title":"Sandbox: Simulate a voice call","openapi":"api-reference/openapi-early-access.json POST /simulations/voice-sessions/{voiceSessionId}","href":"/api-reference/simulations/simulate-voice-call"}]}]},{"group":"Refunds","pages":[{"title":"Overview","href":"/guides/concepts/refunds"},{"title":"Create refund","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /refunds","href":"/api-reference/refunds/create-refund"},{"title":"List refunds","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Get refund","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /refunds/{refundId}","href":"/api-reference/refunds/get-refund"}]},{"group":"Chargebacks","pages":[{"title":"Overview","href":"/guides/concepts/chargebacks"},{"title":"List chargebacks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chargebacks","href":"/api-reference/chargebacks/list-chargebacks"},{"title":"Get chargeback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chargebacks/{chargebackId}","href":"/api-reference/chargebacks/get-chargeback"},{"title":"Get chargeback evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chargebacks/{chargebackId}/evidence","href":"/api-reference/chargebacks/get-chargeback-evidence"},{"title":"Update chargeback evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /chargebacks/{chargebackId}/evidence","href":"/api-reference/chargebacks/update-chargeback-evidence"},{"title":"Upload chargeback file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chargebacks/{chargebackId}/files","href":"/api-reference/chargebacks/upload-chargeback-file"},{"title":"Preview chargeback evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chargebacks/{chargebackId}/evidence/preview","href":"/api-reference/chargebacks/preview-chargeback-evidence"},{"title":"Submit chargeback evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chargebacks/{chargebackId}/submit","href":"/api-reference/chargebacks/submit-chargeback-evidence"},{"title":"Accept chargeback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chargebacks/{chargebackId}/accept","href":"/api-reference/chargebacks/accept-chargeback"}]},{"group":"Approvals","pages":[{"title":"Overview","href":"/guides/concepts/approvals"},{"title":"List approvals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /approvals","href":"/api-reference/approvals/list-approvals"},{"title":"Get approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /approvals/{approvalId}","href":"/api-reference/approvals/get-approval"},{"title":"Approve payment or transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /approvals/{approvalId}/approve","href":"/api-reference/approvals/approve-payment-or-transfer"},{"title":"Deny payment or transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /approvals/{approvalId}/deny","href":"/api-reference/approvals/deny-payment-or-transfer"}]},{"group":"Limits","pages":[{"title":"Overview","href":"/guides/concepts/limits"},{"title":"Set party approval limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /parties/me/limits","href":"/api-reference/parties/set-party-approval-limits"},{"title":"Get party approval limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/me/limits","href":"/api-reference/parties/get-party-approval-limits"},{"title":"Disable party approval limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /parties/me/limits","href":"/api-reference/parties/disable-party-approval-limits"}]},{"group":"Parties","pages":[{"title":"Overview","href":"/guides/concepts/parties"},{"title":"Get party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/me","href":"/api-reference/parties/get-party"},{"title":"List party members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/me/members","href":"/api-reference/parties/list-party-members"},{"title":"Get party compliance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/{partyId}/compliance","href":"/api-reference/parties/get-party-compliance"},{"title":"Create branding photo upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /parties/{partyId}/branding/photo-uploads","href":"/api-reference/parties/create-branding-photo-upload"},{"title":"Get party branding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/{partyId}/branding","href":"/api-reference/parties/get-party-branding"},{"title":"Update party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /parties/me","href":"/api-reference/parties/update-party"},{"title":"Update party branding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /parties/{partyId}/branding","href":"/api-reference/parties/update-party-branding"},{"title":"Set party handle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /parties/me/handle","href":"/api-reference/parties/set-party-handle"},{"title":"Remove party member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /parties/me/members/{userId}","href":"/api-reference/parties/remove-party-member"}]},{"group":"Party Invitations","pages":[{"title":"Overview","href":"/guides/concepts/party-invitations"},{"title":"Create party invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /party-invitations","href":"/api-reference/invitations/create-party-invitations"},{"title":"List party invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /party-invitations","href":"/api-reference/invitations/list-party-invitations"},{"title":"Revoke party invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /party-invitations/{invitationId}","href":"/api-reference/invitations/revoke-party-invitation"}]},{"group":"Wallets","pages":[{"title":"Overview","href":"/guides/concepts/wallets"},{"title":"Create wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets","href":"/api-reference/wallets/create-wallet"},{"title":"List wallets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wallets","href":"/api-reference/wallets/list-wallets"},{"title":"Get wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wallets/{walletId}","href":"/api-reference/wallets/get-wallet"},{"title":"Update wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /wallets/{walletId}","href":"/api-reference/wallets/update-wallet"},{"title":"Set default wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/default","href":"/api-reference/wallets/set-default-wallet"},{"title":"Freeze wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/freeze","href":"/api-reference/wallets/freeze-wallet"},{"title":"Unfreeze wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/unfreeze","href":"/api-reference/wallets/unfreeze-wallet"}]},{"group":"Wallet Access","pages":[{"title":"Overview","href":"/guides/concepts/wallet-access"},{"title":"Grant agent access to wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/agents","href":"/api-reference/wallets/grant-agent-access-to-wallet"},{"title":"List wallet agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wallets/{walletId}/agents","href":"/api-reference/wallets/list-wallet-agents"},{"title":"Set agent default wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/agents/{agentId}/default","href":"/api-reference/wallets/set-agent-default-wallet"},{"title":"Detach agent from wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /wallets/{walletId}/agents/{agentId}","href":"/api-reference/wallets/detach-agent-from-wallet"}]},{"group":"External Accounts","pages":[{"title":"Overview","href":"/guides/concepts/external-accounts"},{"title":"List external accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-accounts","href":"/api-reference/external-accounts/list-external-accounts"},{"title":"Get external account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/get-external-account"},{"title":"Remove external account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/remove-external-account"},{"group":"Simulations","pages":[{"title":"Sandbox: Link a test bank account","openapi":"POST /simulations/external-accounts/link","href":"/api-reference/simulations/link-test-bank-account"}]}]},{"group":"Cards","pages":[{"group":"Saved cards","pages":[{"title":"Saved cards","href":"/guides/concepts/saved-cards"},{"title":"List card external accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-external-accounts","href":"/api-reference/external-accounts/list-card-external-accounts"},{"title":"Remove card external account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /card-external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/remove-card-external-account"}]},{"group":"Browser tokens","pages":[{"title":"Overview","href":"/guides/concepts/browser-tokens"},{"title":"Kernel","sidebarTitle":"Use with Kernel","href":"/guides/integrations/kernel"},{"title":"Browser Use","sidebarTitle":"Use with Browser Use","href":"/guides/integrations/browser-use"},{"title":"Encrypted card fields","sidebarTitle":"Encrypted card fields","href":"/guides/integrations/encrypted-card-fields"},{"title":"Create card session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /card-sessions","href":"/api-reference/card-sessions/create-card-session"},{"title":"List card sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-sessions","href":"/api-reference/card-sessions/list-card-sessions"},{"title":"Get card session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-sessions/{sessionId}","href":"/api-reference/card-sessions/get-card-session"},{"title":"Claim card session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /card-sessions/{sessionId}/claim","href":"/api-reference/card-sessions/claim-card-session"},{"title":"Create merchant report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /merchant-reports","href":"/api-reference/merchant-reports/create-merchant-report"}]},{"group":"Agent tokens","pages":[{"title":"Overview","href":"/guides/concepts/agent-tokens"},{"title":"Get agentic card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic-payments/cards/{cardId}","href":"/api-reference/agent-tokens/get-agentic-card"},{"title":"List agentic mandates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic-payments/mandates","href":"/api-reference/agent-tokens/list-agentic-mandates"},{"title":"Get agentic mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic-payments/mandates/{mandateId}","href":"/api-reference/agent-tokens/get-agentic-mandate"},{"title":"Create agentic purchase","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic-payments/purchases","href":"/api-reference/agent-tokens/create-agentic-purchase"},{"title":"Get agentic purchase","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic-payments/purchases/{purchaseId}","href":"/api-reference/agent-tokens/get-agentic-purchase"},{"title":"Claim purchase credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic-payments/purchases/{purchaseId}/claim","href":"/api-reference/agent-tokens/claim-purchase-credential"},{"title":"Cancel agentic purchase","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic-payments/purchases/{purchaseId}/cancel","href":"/api-reference/agent-tokens/cancel-agentic-purchase"}]}]},{"group":"API Keys","pages":[{"title":"Overview","href":"/guides/concepts/api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api-keys","href":"/api-reference/api-keys/create-api-key"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Get API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api-keys/{keyId}","href":"/api-reference/api-keys/get-api-key"},{"title":"Revoke API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api-keys/{keyId}","href":"/api-reference/api-keys/revoke-api-key"}]},{"group":"Agent Keys","pages":[{"title":"Overview","href":"/guides/concepts/agent-keys"},{"title":"Create agent key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-keys","href":"/api-reference/agent-keys/create-agent-key"},{"title":"List agent keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-keys","href":"/api-reference/agent-keys/list-agent-keys"},{"title":"Rotate agent key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-keys/{keyId}/rotate","href":"/api-reference/agent-keys/rotate-agent-key"},{"title":"Revoke agent key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agent-keys/{keyId}","href":"/api-reference/agent-keys/revoke-agent-key"}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/guides/concepts/webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Rotate webhook signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{webhookId}/rotate-secret","href":"/api-reference/webhooks/rotate-webhook-signing-secret"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /webhooks/{webhookId}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-webhook"}]},{"group":"Events","pages":[{"title":"Overview","href":"/guides/concepts/events"},{"title":"Event types","sidebarTitle":"Event catalog","href":"/api-reference/event-catalog"},{"title":"List events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /events","href":"/api-reference/events/list-events"},{"title":"Get event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /events/{eventId}","href":"/api-reference/events/get-event"},{"title":"Redeliver event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{webhookId}/events/{eventId}/redeliver","href":"/api-reference/events/redeliver-event"}]},{"group":"Errors","pages":[{"title":"Error handling","href":"/api-reference/errors/error-handling"},{"group":"Resource errors","pages":[{"title":"Agents","href":"/api-reference/errors/agents"},{"title":"Customers","href":"/api-reference/errors/customers"},{"title":"Payments","href":"/api-reference/errors/payments"},{"title":"Transactions","href":"/api-reference/errors/transactions"},{"title":"Transfers","href":"/api-reference/errors/transfers"},{"title":"Payment Requests","href":"/api-reference/errors/payment-requests"},{"title":"Payment Intents","href":"/api-reference/errors/payment-intents"},{"title":"Card Payments","href":"/api-reference/errors/card-payments"},{"title":"Voice Sessions","href":"/api-reference/errors/voice-sessions"},{"title":"Refunds","href":"/api-reference/errors/refunds"},{"title":"Chargebacks","href":"/api-reference/errors/chargebacks"},{"title":"Approvals","href":"/api-reference/errors/approvals"},{"title":"Parties","href":"/api-reference/errors/parties"},{"title":"Party Invitations","href":"/api-reference/errors/party-invitations"},{"title":"Wallets","href":"/api-reference/errors/wallets"},{"title":"External Accounts","href":"/api-reference/errors/external-accounts"},{"title":"External Parties","href":"/api-reference/errors/external-parties"},{"title":"External Party Accounts","href":"/api-reference/errors/external-party-accounts"},{"title":"ACH","href":"/api-reference/errors/ach"},{"title":"Realtime","href":"/api-reference/errors/realtime"},{"title":"Wire","href":"/api-reference/errors/wire"},{"title":"Check","href":"/api-reference/errors/check"},{"title":"API keys","href":"/api-reference/errors/api-keys"},{"title":"Agent keys","href":"/api-reference/errors/agent-keys"},{"title":"Card sessions","href":"/api-reference/errors/card-sessions"},{"title":"Webhooks","href":"/api-reference/errors/webhooks"},{"title":"Events","href":"/api-reference/errors/events"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get check payment - Natural Docs","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}