Returns the canonical Payment when the account fixed by the client bearer token is its owner or a participant.
Authorizations
Authorization
string
header
required
Short-lived account-bound token returned by POST /v2/client/auth/exchange.
Path Parameters
paymentId
string
required
Canonical payment_* id returned by POST /v2/client/me/payments.
Pattern: ^payment_
Example:
"payment_123"
Response
Canonical Payment
payment
object
required
Show child attributes
nextAction
Action required · object
required
The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.
Action required
Start account KYC
Re-verify identity
Verify UPA email
Complete hosted compliance
Waiting for review
Contact support
No action required (type none)
Show child attributes
checkout
object
Show child attributes
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Stableyard","description":"Collect, move and settle money across local payment rails and stablecoins, through one API.","colors":{"primary":"#2563EB","light":"#6B9BFF","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/stableyard/KNLdOufdyK0ENvTU/images/logo-light.svg?fit=max\u0026auto=format\u0026n=KNLdOufdyK0ENvTU\u0026q=85\u0026s=9db9c25a0ce38c9ebf3a01a5b531d374","dark":"https://mintcdn.com/stableyard/KNLdOufdyK0ENvTU/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=KNLdOufdyK0ENvTU\u0026q=85\u0026s=d9d2a69f0cce0390261360eecd9dacaf"},"favicon":"https://mintcdn.com/stableyard/KNLdOufdyK0ENvTU/images/favicon.svg?fit=max\u0026auto=format\u0026n=KNLdOufdyK0ENvTU\u0026q=85\u0026s=b7d3dda76ca45590b12c3d5f6f244a40","appearance":{"default":"light"},"background":{"color":{"light":"#F7F7F8","dark":"#0C0D10"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Get API keys","href":"https://dashboard.stableyard.fi"}},"footer":{"socials":{}},"fonts":{"heading":{"family":"Geist","weight":500},"body":{"family":"Geist"}},"styling":{"eyebrows":"section","codeblocks":"system","latex":false},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stableyard","hasAudioNarration":false,"actualSubdomain":"stableyard","customDomains":["docs.stableyard.fi"],"gitSource":{"type":"github","owner":"rajparab","repo":"docs-mintlify","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aede37a637c395c8819783c","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":97},{"language":"default","tag":"Money movement","count":29},{"language":"default","tag":"Concepts","count":25},{"language":"default","tag":"Client \u0026 checkout","count":22},{"language":"default","tag":"Onboarding","count":21},{"language":"default","tag":"Payments","count":21},{"language":"default","tag":"Accounts","count":20},{"language":"default","tag":"Vaults","count":16},{"language":"default","tag":"Settlement","count":11},{"language":"default","tag":"Bank accounts","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--sy-ink: #16181d;--sy-line: rgba(22, 24, 29, 0.08);--sy-line-strong: rgba(22, 24, 29, 0.14);--sy-sunken: rgba(22, 24, 29, 0.025);--sy-accent: #2563eb}.dark{--sy-ink: #f7f7f8;--sy-line: rgba(255, 255, 255, 0.09);--sy-line-strong: rgba(255, 255, 255, 0.16);--sy-sunken: rgba(255, 255, 255, 0.03);--sy-accent: #6b9bff}h1{letter-spacing:-0.028em;font-weight:540;line-height:1.12}h2{letter-spacing:-0.018em;font-weight:540;margin-top:2.75rem}h3{letter-spacing:-0.011em;font-weight:540}#content-area>div>p:first-of-type,.mdx-content>p:first-of-type{font-size:1.0625rem;line-height:1.6;opacity:0.72}a[href]>div[class*=\"card\"],div[class*=\"card\"]{border-color:var(--sy-line)!important;border-radius:12px!important;transition:border-color 140ms ease, transform 140ms ease, background-color 140ms ease}a[href]:hover>div[class*=\"card\"]{border-color:var(--sy-line-strong)!important;transform:translateY(-1px)}table{border-collapse:separate;border-spacing:0;font-size:0.9375rem}th{font-weight:540;letter-spacing:-0.006em;background:var(--sy-sunken);border-bottom:1px solid var(--sy-line-strong)!important}th,td{padding:0.65rem 0.875rem!important;vertical-align:top}td{min-width:6rem!important}th:first-child{border-top-left-radius:8px}th:last-child{border-top-right-radius:8px}tr:last-child td{border-bottom:none!important}td strong{font-weight:560;letter-spacing:-0.004em}code{font-size:0.875em;letter-spacing:-0.01em}:not(pre)>code{border:1px solid var(--sy-line);border-radius:5px;padding:0.1em 0.34em;background:var(--sy-sunken)}div[class*=\"callout\"]{border-radius:10px!important}.mermaid{margin:1.75rem auto;max-width:44rem}.sy-home{--sy-surface: #ffffff;--sy-muted: #5c6270;display:flex;flex-direction:column;gap:0.75rem;margin-top:0.5rem}.dark .sy-home{--sy-surface: rgba(255, 255, 255, 0.03);--sy-muted: #a1a6b3}.sy-home a{color:inherit;text-decoration:none}.sy-entry{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1rem}.sy-entry-card{display:flex;flex-direction:column;gap:0.35rem;padding:1.5rem;border:1px solid var(--sy-line);border-radius:12px;background:var(--sy-surface)}.sy-entry-card h3{margin:0.75rem 0 0;font-size:1.05rem;font-weight:540;letter-spacing:-0.011em}.sy-entry-card p{margin:0 0 0.75rem;color:var(--sy-muted);font-size:0.9375rem}.sy-entry-card a{width:fit-content;font-size:0.9375rem;font-weight:500;border-bottom:1px solid transparent;transition:border-color 140ms ease}.sy-entry-card a::after{content:\" →\";color:var(--sy-accent)}.sy-entry-card a:hover{border-bottom-color:var(--sy-line-strong)}.sy-section-head{display:flex;align-items:baseline;gap:0.6rem;margin:2.25rem 0 0.25rem}.sy-section-head h2{margin:0;font-size:1.25rem}.sy-section-head span{color:var(--sy-muted);font-size:1.05rem}.sy-tiles{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));border:1px solid var(--sy-line);border-radius:12px;overflow:hidden;background:var(--sy-surface)}.sy-tile{display:flex;flex-direction:column;gap:0.3rem;padding:1.1rem 1.25rem;border-right:1px solid var(--sy-line);border-bottom:1px solid var(--sy-line);transition:background-color 140ms ease}.sy-tile:nth-child(3n){border-right:none}.sy-tile:nth-last-child(-n+3){border-bottom:none}.sy-tile:hover,.sy-product:hover{background:var(--sy-sunken)}.sy-tile span,.sy-product span{color:var(--sy-muted);font-size:0.875rem;line-height:1.45}.sy-tile .sy-title,.sy-product .sy-title{margin-top:0.4rem;color:inherit;font-size:0.9375rem;font-weight:540}.sy-products{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:1rem}.sy-product{display:flex;flex-direction:column;gap:0.3rem;padding:1.25rem;border:1px solid var(--sy-line);border-radius:12px;background:var(--sy-surface);transition:background-color 140ms ease, border-color 140ms ease}.sy-product:hover{border-color:var(--sy-line-strong)}.sy-split,.sy-resources{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));border:1px solid var(--sy-line);border-radius:12px;background:var(--sy-surface)}.sy-resources{grid-template-columns:repeat(3, minmax(0, 1fr));border:none;background:none}.sy-split>div,.sy-resources>div{padding:1.25rem 1.5rem}.sy-split>div+div{border-left:1px solid var(--sy-line)}.sy-resources>div{display:flex;flex-direction:column;gap:0.45rem;padding-left:0}.sy-split h4,.sy-resources h4{margin:0 0 0.6rem;font-size:0.8125rem;font-weight:500;color:var(--sy-muted)}.sy-split ul{margin:0;padding-left:1.1rem;display:flex;flex-direction:column;gap:0.4rem;font-size:0.9375rem}.sy-resources a{width:fit-content;font-size:0.9375rem}.sy-resources a:hover{text-decoration:underline;text-underline-offset:3px}@media (max-width: 768px){.sy-entry,.sy-products,.sy-split,.sy-resources{grid-template-columns:minmax(0, 1fr)}.sy-tiles{grid-template-columns:repeat(2, minmax(0, 1fr))}.sy-tile:nth-child(3n){border-right:1px solid var(--sy-line)}.sy-tile:nth-child(2n){border-right:none}.sy-tile:nth-last-child(-n+3){border-bottom:1px solid var(--sy-line)}.sy-tile:nth-last-child(-n+2){border-bottom:none}.sy-split>div+div{border-left:none;border-top:1px solid var(--sy-line)}.sy-section-head{flex-direction:column;gap:0.15rem}}.sy-hero{width:100%;height:auto;border-radius:16px;margin:0.25rem 0 1.75rem}.sy-flag{display:inline-block;width:20px;height:15px;margin:0 0.5rem 0 0!important;border-radius:2px;vertical-align:-2px;box-shadow:0 0 0 1px var(--sy-line)}.sy-home>.sy-section-head:first-child{margin-top:0.5rem}.sy-chain{display:inline-block;width:18px;height:18px;margin:0 0.5rem 0 0!important;vertical-align:-4px}"}]}
{"page":{"pagePath":"api-reference/client-payments/get-payment","slug":"/api-reference/client-payments/get-payment","pageMetadata":{"openapi":"frontend-openapi.json GET /v2/client/me/payments/{paymentId}","title":"Get a payment for the client account","sidebarTitle":"Get payment","description":"Fetch a Payment that the client token's account owns or participates in.","href":"/api-reference/client-payments/get-payment"},"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: \"Fetch a Payment that the client token’s account owns or participates in.\"\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{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Returns the canonical Payment when the account fixed by the client bearer token is its owner or a participant.`})}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":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"frontend-openapi.json GET /v2/client/me/payments/{paymentId}","title":"Get a payment for the client account","sidebarTitle":"Get payment","description":"Fetch a Payment that the client token's account owns or participates in.","href":"/api-reference/client-payments/get-payment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Client API"],"operationId":"getClientPayment","summary":"Get my payment","description":"Fetch a Payment that the client token's account owns or participates in.","security":["513b04d2-82e4-40ab-a17f-c3e933dfb275"],"parameters":["5c44f5f0-abd6-4bf3-8280-2ad5f53b5c9b"],"responses":{"200":"a7d3b0e7-56fc-43fd-987a-5c50bc24745c","401":"89582a4a-facb-40e1-8e23-97492f99283a","403":"677f2ce3-d7c9-498f-a877-e188e8205746","404":"a8ac67f7-8824-4c1f-b19b-1b683078414e"},"method":"get","type":"path","servers":["d273b006-c101-40f8-b2f9-947071af1f98","333e279f-022e-4549-8780-374542d5f7e2"],"path":"/v2/client/me/payments/{paymentId}","baseUrlOptions":["https://prod-api.stableyard.fi","https://staging-api-v2.stableyard.fi"],"title":"Get my payment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5c44f5f0-abd6-4bf3-8280-2ad5f53b5c9b":{"name":"paymentId","in":"path","required":true,"schema":{"type":"string","pattern":"^payment_","example":"payment_123","isRequired":true,"description":"Canonical payment_* id returned by POST /v2/client/me/payments.","uniqueKey":"","typeLabel":"string"},"description":"Canonical payment_* id returned by POST /v2/client/me/payments."}},"responses":{"a7d3b0e7-56fc-43fd-987a-5c50bc24745c":{"description":"Canonical Payment","headers":{"Stableyard-Version":{"description":"Effective date-based Stableyard API contract version for this response.","schema":{"type":"string","enum":["2026-09-09"]}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["payment","nextAction"],"properties":{"payment":{"type":"object","additionalProperties":false,"required":["id","apiVersion","intent","amountMode","status","offrampStatus","stage","operationalState","operationalReasonCode","operationalUpdatedAt","statusVersion","paymentAmount","participants","destination","settlement","fees","funding","externalReference","description","metadata","expiresAt","acceptedAt","succeededAt","cancelledAt","failure","refundSummary","incidentRecoverySummary","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^payment_[A-Za-z0-9_-]+$","isRequired":true,"uniqueKey":"payment.id","typeLabel":"string"},"apiVersion":{"type":"string","enum":["2026-08-28","2026-09-09"],"example":"2026-09-09","description":"Immutable date-based contract recorded on the resource. Historical values may appear on existing records; only versions advertised in x-stableyard-supported-api-versions are accepted for new requests.","isRequired":true,"uniqueKey":"payment.apiVersion","typeLabel":"enum\u003cstring>"},"intent":{"type":"string","enum":["receive","send"],"isRequired":true,"uniqueKey":"payment.intent","typeLabel":"enum\u003cstring>"},"amountMode":{"type":"string","enum":["collect_exact","deliver_exact"],"isRequired":true,"uniqueKey":"payment.amountMode","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["requires_payment_method","requires_action","processing","accepted","succeeded","failed","cancelled","expired"],"description":"Customer-facing financial lifecycle. Operational recovery never regresses a succeeded Payment or replaces this value with requires_intervention.","isRequired":true,"uniqueKey":"payment.status","typeLabel":"enum\u003cstring>"},"offrampStatus":{"oneOf":[{"type":"string","enum":["not_started","processing","failed","refunding","refunded","succeeded",null],"description":"External payout outcome. failed: the payout failed after funding; a failure before funding is not_started. refunding: Stableyard is returning the source amount to the sender's preferred crypto settlement destination. refunded: the return is confirmed. Null for other Payment types.","isRequired":true,"uniqueKey":"payment.offrampStatus.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["not_started","processing","failed","refunding","refunded","succeeded",null],"description":"External payout outcome. failed: the payout failed after funding; a failure before funding is not_started. refunding: Stableyard is returning the source amount to the sender's preferred crypto settlement destination. refunded: the return is confirmed. Null for other Payment types.","isRequired":true,"uniqueKey":"payment.offrampStatus.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.offrampStatus","typeLabel":"enum\u003cstring> | null"},"stage":{"oneOf":[{"type":"string","enum":["escrow_provisioning","awaiting_payment","destination_verifying","provider_processing","quote_pending","transaction_broadcast","receipt_verifying","payment_detected","settlement_pending","settlement_broadcast","settlement_confirming","settlement_returned","payout_pending","payout_processing","payout_confirming","refund_pending","refund_broadcast",null],"description":"Current financial-processing stage. Operational review is represented separately by operationalState.","isRequired":true,"uniqueKey":"payment.stage.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["escrow_provisioning","awaiting_payment","destination_verifying","provider_processing","quote_pending","transaction_broadcast","receipt_verifying","payment_detected","settlement_pending","settlement_broadcast","settlement_confirming","settlement_returned","payout_pending","payout_processing","payout_confirming","refund_pending","refund_broadcast",null],"description":"Current financial-processing stage. Operational review is represented separately by operationalState.","isRequired":true,"uniqueKey":"payment.stage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.stage","typeLabel":"enum\u003cstring> | null"},"operationalState":{"type":"string","enum":["normal","retrying","requires_intervention"],"description":"Operational health of the Payment. requires_intervention means Stableyard must act; it is not a financial payment status.","isRequired":true,"uniqueKey":"payment.operationalState","typeLabel":"enum\u003cstring>"},"operationalReasonCode":{"oneOf":[{"type":"string","enum":["collection_requires_intervention","custody_after_failure","duplicate_payment_detected","fee_payout_failed","fee_payout_requires_intervention","fee_payout_retry_scheduled","late_payment_received","payment_execution_requires_intervention","payment_execution_retry_scheduled","escrow_provisioning_retry_scheduled","payment_session_requires_intervention","payout_failed","payout_requires_intervention","payout_retry_scheduled","refund_failed","refund_requires_intervention","refund_retry_scheduled","settlement_failed","settlement_requires_intervention","settlement_retry_scheduled","settlement_unconfirmed",null],"description":"Machine-readable operational reason when operationalState is not normal.","isRequired":true,"uniqueKey":"payment.operationalReasonCode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["collection_requires_intervention","custody_after_failure","duplicate_payment_detected","fee_payout_failed","fee_payout_requires_intervention","fee_payout_retry_scheduled","late_payment_received","payment_execution_requires_intervention","payment_execution_retry_scheduled","escrow_provisioning_retry_scheduled","payment_session_requires_intervention","payout_failed","payout_requires_intervention","payout_retry_scheduled","refund_failed","refund_requires_intervention","refund_retry_scheduled","settlement_failed","settlement_requires_intervention","settlement_retry_scheduled","settlement_unconfirmed",null],"description":"Machine-readable operational reason when operationalState is not normal.","isRequired":true,"uniqueKey":"payment.operationalReasonCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.operationalReasonCode","typeLabel":"enum\u003cstring> | null"},"operationalUpdatedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the operational state or reason last changed.","isRequired":true,"uniqueKey":"payment.operationalUpdatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the operational state or reason last changed.","isRequired":true,"uniqueKey":"payment.operationalUpdatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.operationalUpdatedAt","typeLabel":"string\u003cdate-time> | null"},"statusVersion":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.statusVersion","typeLabel":"integer"},"paymentAmount":{"type":"object","additionalProperties":false,"required":["amount","amountAtomic","assetType","assetCode","decimals"],"properties":{"amount":{"type":"string","minLength":1,"maxLength":100,"pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","example":"50.00","isRequired":true,"uniqueKey":"payment.paymentAmount.amount","typeLabel":"string"},"amountAtomic":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[1-9][0-9]*$","example":"50000000","isRequired":true,"uniqueKey":"payment.paymentAmount.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","enum":["crypto","fiat"],"isRequired":true,"uniqueKey":"payment.paymentAmount.assetType","typeLabel":"enum\u003cstring>"},"assetCode":{"type":"string","example":"USDC","isRequired":true,"uniqueKey":"payment.paymentAmount.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"example":6,"isRequired":true,"uniqueKey":"payment.paymentAmount.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"example":8453,"uniqueKey":"payment.paymentAmount.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","uniqueKey":"payment.paymentAmount.tokenAddress","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payment.paymentAmount","typeLabel":"object"},"participants":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["role","accountId"],"properties":{"role":{"type":"string","enum":["sender","recipient"],"isRequired":true,"uniqueKey":"payment.participants.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"accountId":{"type":"string","description":"A UPA account belonging to the authenticated organization, app, and environment. Participants that belong to another app are omitted.","isRequired":true,"uniqueKey":"payment.participants.items.[INDEX].accountId","typeLabel":"string"}},"uniqueKey":"payment.participants.items.[INDEX]","typeLabel":"object"},"description":"Only participant UPAs that belong to your app are returned. The array can be empty for creator-only visibility.","isRequired":true,"uniqueKey":"payment.participants","typeLabel":"object[]"},"destination":{"oneOf":[{"type":"object","title":"UPA account","required":["type","accountId"],"properties":{"type":{"type":"string","const":"upa","isRequired":true,"uniqueKey":"payment.destination.oneOf.0.type","typeLabel":"string"},"accountId":{"type":"string","isRequired":true,"uniqueKey":"payment.destination.oneOf.0.accountId","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.destination.oneOf.0","typeLabel":"UPA account · object"},{"type":"object","title":"Payment handle","required":["type","paymentHandle","accountId"],"properties":{"type":{"type":"string","const":"payment_handle","isRequired":true,"uniqueKey":"payment.destination.oneOf.1.type","typeLabel":"string"},"paymentHandle":{"type":"string","isRequired":true,"uniqueKey":"payment.destination.oneOf.1.paymentHandle","typeLabel":"string"},"accountId":{"type":"string","isRequired":true,"uniqueKey":"payment.destination.oneOf.1.accountId","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.destination.oneOf.1","typeLabel":"Payment handle · object"},{"type":"object","title":"External crypto wallet","required":["type","chainId","address","assetCode","tokenAddress"],"properties":{"type":{"type":"string","const":"crypto_wallet","isRequired":true,"uniqueKey":"payment.destination.oneOf.2.type","typeLabel":"string"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.destination.oneOf.2.chainId","typeLabel":"integer"},"address":{"type":"string","isRequired":true,"uniqueKey":"payment.destination.oneOf.2.address","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.destination.oneOf.2.assetCode","typeLabel":"string"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.destination.oneOf.2.tokenAddress","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.destination.oneOf.2","typeLabel":"External crypto wallet · object"},{"type":"object","title":"External merchant QR","required":["type","country","currency","dynamic","merchant"],"properties":{"type":{"type":"string","const":"external_qr","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.type","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","example":"PH","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.country","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"PHP","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.currency","typeLabel":"string"},"dynamic":{"type":"boolean","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.dynamic","typeLabel":"boolean"},"merchant":{"oneOf":[{"type":"object","title":"Merchant details","required":["name","city"],"properties":{"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant.oneOf.0.name","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant.oneOf.0.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant.oneOf.0.city","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant.oneOf.0","typeLabel":"Merchant details · object"},{"type":"null","title":"Merchant details unavailable","isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.destination.oneOf.3.merchant","typeLabel":"Merchant details · object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.destination.oneOf.3","typeLabel":"External merchant QR · object"},{"type":"object","title":"External bank beneficiary","required":["type","country","currency","beneficiary"],"properties":{"type":{"type":"string","const":"external_bank","isRequired":true,"uniqueKey":"payment.destination.oneOf.4.type","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","example":"VN","isRequired":true,"uniqueKey":"payment.destination.oneOf.4.country","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"VND","isRequired":true,"uniqueKey":"payment.destination.oneOf.4.currency","typeLabel":"string"},"beneficiary":{"type":"object","additionalProperties":false,"required":["accountHolderName","accountNumberLast4","bankCode","bankName","country"],"properties":{"accountHolderName":{"oneOf":[{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.accountHolderName.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.accountHolderName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.accountHolderName","typeLabel":"string | null"},"accountNumberLast4":{"oneOf":[{"type":"string","pattern":"^[A-Za-z0-9]{4}$","isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.accountNumberLast4.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[A-Za-z0-9]{4}$","isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.accountNumberLast4.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.accountNumberLast4","typeLabel":"string | null"},"bankCode":{"oneOf":[{"type":"string","maxLength":64,"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.bankCode.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.bankCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.bankCode","typeLabel":"string | null"},"bankName":{"oneOf":[{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.bankName.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.bankName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.bankName","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.country.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary.country","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payment.destination.oneOf.4.beneficiary","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.destination.oneOf.4","typeLabel":"External bank beneficiary · object"},{"type":"object","title":"Verified linked bank account","required":["type","bankAccountId","country","currency","bankName","accountNumberLast4","rail"],"properties":{"type":{"type":"string","const":"bank_account","isRequired":true,"uniqueKey":"payment.destination.oneOf.5.type","typeLabel":"string"},"bankAccountId":{"type":"string","pattern":"^bank_[A-Za-z0-9_-]{3,59}$","example":"bank_123","isRequired":true,"uniqueKey":"payment.destination.oneOf.5.bankAccountId","typeLabel":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$","example":"US","isRequired":true,"uniqueKey":"payment.destination.oneOf.5.country","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"USD","isRequired":true,"uniqueKey":"payment.destination.oneOf.5.currency","typeLabel":"string"},"bankName":{"type":"string","minLength":1,"maxLength":160,"example":"Example Bank","isRequired":true,"uniqueKey":"payment.destination.oneOf.5.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","pattern":"^[A-Za-z0-9]{4,8}$","example":"6789","isRequired":true,"uniqueKey":"payment.destination.oneOf.5.accountNumberLast4","typeLabel":"string"},"rail":{"type":"string","minLength":1,"maxLength":64,"example":"ach","isRequired":true,"uniqueKey":"payment.destination.oneOf.5.rail","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.destination.oneOf.5","typeLabel":"Verified linked bank account · object"}],"isRequired":true,"uniqueKey":"payment.destination","typeLabel":"UPA account · object | Payment handle · object | External crypto wallet · object | External merchant QR · object | External bank beneficiary · object | Verified linked bank account · object"},"settlement":{"oneOf":[{"type":"object","title":"Settlement destination","description":"Immutable receive-side settlement snapshot. Null for Payment types that do not use a receive settlement destination.","required":["type","settlementDestinationId","destinationType","destinationAddress","chainId","assetCode","tokenAddress","decimals"],"properties":{"type":{"type":"string","enum":["settlement_destination","crypto_wallet"],"isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.type","typeLabel":"enum\u003cstring>"},"settlementDestinationId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.settlementDestinationId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.settlementDestinationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.settlementDestinationId","typeLabel":"string | null"},"destinationType":{"type":"string","isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.destinationType","typeLabel":"string"},"destinationAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.destinationAddress","typeLabel":"string"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.chainId","typeLabel":"integer"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.assetCode","typeLabel":"string"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.tokenAddress","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.settlement.oneOf.0.decimals","typeLabel":"integer"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.settlement.oneOf.0","typeLabel":"Settlement destination · object"},{"type":"null","title":"No settlement destination","description":"Immutable receive-side settlement snapshot. Null for Payment types that do not use a receive settlement destination.","isRequired":true,"uniqueKey":"payment.settlement.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.settlement","typeLabel":"Settlement destination · object | null"},"fees":{"oneOf":[{"type":"object","title":"Commercial fee quote pending","description":"Commercial fee terms are returned only to the partner that owns them. quote_pending exposes frozen BPS but keeps exact monetary amounts null until the payout quote is frozen; quoted exposes immutable exact atomic amounts, including genuine zero values.","required":["version","pricingStatus","platformFeeBps","partnerFeeBps","platformFeeAmountAtomic","partnerFeeAmountAtomic","merchantNetAmountAtomic"],"properties":{"version":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.fees.oneOf.0.version.oneOf.0","typeLabel":"string"},{"type":"number","isRequired":true,"uniqueKey":"payment.fees.oneOf.0.version.oneOf.1","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payment.fees.oneOf.0.version.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.fees.oneOf.0.version","typeLabel":"string | number | null"},"pricingStatus":{"type":"string","const":"quote_pending","isRequired":true,"uniqueKey":"payment.fees.oneOf.0.pricingStatus","typeLabel":"string"},"platformFeeBps":{"type":"integer","minimum":0,"maximum":10000,"isRequired":true,"uniqueKey":"payment.fees.oneOf.0.platformFeeBps","typeLabel":"integer"},"partnerFeeBps":{"type":"integer","minimum":0,"maximum":10000,"isRequired":true,"uniqueKey":"payment.fees.oneOf.0.partnerFeeBps","typeLabel":"integer"},"platformFeeAmountAtomic":{"type":"null","isRequired":true,"uniqueKey":"payment.fees.oneOf.0.platformFeeAmountAtomic","typeLabel":"null"},"partnerFeeAmountAtomic":{"type":"null","isRequired":true,"uniqueKey":"payment.fees.oneOf.0.partnerFeeAmountAtomic","typeLabel":"null"},"merchantNetAmountAtomic":{"type":"null","isRequired":true,"uniqueKey":"payment.fees.oneOf.0.merchantNetAmountAtomic","typeLabel":"null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.fees.oneOf.0","typeLabel":"Commercial fee quote pending · object"},{"type":"object","title":"Quoted commercial fee snapshot","description":"Commercial fee terms are returned only to the partner that owns them. quote_pending exposes frozen BPS but keeps exact monetary amounts null until the payout quote is frozen; quoted exposes immutable exact atomic amounts, including genuine zero values.","required":["version","pricingStatus","platformFeeBps","partnerFeeBps","platformFeeAmountAtomic","partnerFeeAmountAtomic","merchantNetAmountAtomic"],"properties":{"version":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.fees.oneOf.1.version.oneOf.0","typeLabel":"string"},{"type":"number","isRequired":true,"uniqueKey":"payment.fees.oneOf.1.version.oneOf.1","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payment.fees.oneOf.1.version.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.fees.oneOf.1.version","typeLabel":"string | number | null"},"pricingStatus":{"type":"string","const":"quoted","isRequired":true,"uniqueKey":"payment.fees.oneOf.1.pricingStatus","typeLabel":"string"},"platformFeeBps":{"type":"integer","minimum":0,"maximum":10000,"isRequired":true,"uniqueKey":"payment.fees.oneOf.1.platformFeeBps","typeLabel":"integer"},"partnerFeeBps":{"type":"integer","minimum":0,"maximum":10000,"isRequired":true,"uniqueKey":"payment.fees.oneOf.1.partnerFeeBps","typeLabel":"integer"},"platformFeeAmountAtomic":{"type":"string","maxLength":80,"pattern":"^(0|[1-9][0-9]*)$","isRequired":true,"uniqueKey":"payment.fees.oneOf.1.platformFeeAmountAtomic","typeLabel":"string"},"partnerFeeAmountAtomic":{"type":"string","maxLength":80,"pattern":"^(0|[1-9][0-9]*)$","isRequired":true,"uniqueKey":"payment.fees.oneOf.1.partnerFeeAmountAtomic","typeLabel":"string"},"merchantNetAmountAtomic":{"type":"string","maxLength":80,"pattern":"^(0|[1-9][0-9]*)$","isRequired":true,"uniqueKey":"payment.fees.oneOf.1.merchantNetAmountAtomic","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.fees.oneOf.1","typeLabel":"Quoted commercial fee snapshot · object"},{"type":"null","title":"Fees unavailable","description":"Commercial fee terms are returned only to the partner that owns them. quote_pending exposes frozen BPS but keeps exact monetary amounts null until the payout quote is frozen; quoted exposes immutable exact atomic amounts, including genuine zero values.","isRequired":true,"uniqueKey":"payment.fees.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.fees","typeLabel":"Commercial fee quote pending · object | Quoted commercial fee snapshot · object | null"},"funding":{"oneOf":[{"type":"object","title":"External payout funding","description":"Create-time funding quote for an external fiat send rail. required is the exact source amount. When the sender's active Payment Source is a Stableyard-managed Vault, creation immediately authorizes Vault funding of this amount into the Payment's escrow, and the destination payout starts once that collection is verified. Otherwise creation itself does not debit funds or submit the destination payout. Null for ordinary receive and direct-send Payments.","required":["required","providerPrincipal","providerFee","platformFee","platformFixedFee","partnerFee","totalFees","exchangeRate","quoteExpiresAt","depositAddress"],"properties":{"required":{"type":"object","additionalProperties":false,"required":["amount","amountAtomic","assetType","assetCode","decimals","chainId","tokenAddress"],"properties":{"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.required.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.required.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","const":"crypto","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.required.assetType","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.required.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.required.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.required.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.required.tokenAddress","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.required","typeLabel":"object"},"providerPrincipal":{"oneOf":[{"type":"object","required":["amount","amountAtomic","assetType","assetCode","decimals","chainId","tokenAddress"],"properties":{"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.0.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.0.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","const":"crypto","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.0.assetType","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.0.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.0.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.0.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.0.tokenAddress","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerPrincipal","typeLabel":"object | null"},"providerFee":{"oneOf":[{"type":"object","required":["amount","amountAtomic","assetType","assetCode","decimals","chainId","tokenAddress"],"properties":{"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.0.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.0.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","const":"crypto","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.0.assetType","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.0.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.0.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.0.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.0.tokenAddress","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.providerFee","typeLabel":"object | null"},"platformFee":{"oneOf":[{"type":"object","description":"Stableyard platform fee in the funding asset, including platformFixedFee.","required":["amount","amountAtomic","assetType","assetCode","decimals","chainId","tokenAddress"],"properties":{"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.0.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.0.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","const":"crypto","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.0.assetType","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.0.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.0.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.0.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.0.tokenAddress","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.0","typeLabel":"object"},{"type":"null","description":"Stableyard platform fee in the funding asset, including platformFixedFee.","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFee","typeLabel":"object | null"},"platformFixedFee":{"oneOf":[{"type":"object","description":"Flat Stableyard fee for the payout rail, charged on top of the amount sent and already included in platformFee: ACH and FedNow $0.50, Fedwire $10.00, valued 1:1 in the USD stablecoin funding asset. Zero for payouts without a rail fee. Null when fee visibility is restricted or no collection escrow exists.","required":["amount","amountAtomic","assetType","assetCode","decimals","chainId","tokenAddress"],"properties":{"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.0.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.0.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","const":"crypto","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.0.assetType","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.0.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.0.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.0.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.0.tokenAddress","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.0","typeLabel":"object"},{"type":"null","description":"Flat Stableyard fee for the payout rail, charged on top of the amount sent and already included in platformFee: ACH and FedNow $0.50, Fedwire $10.00, valued 1:1 in the USD stablecoin funding asset. Zero for payouts without a rail fee. Null when fee visibility is restricted or no collection escrow exists.","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.platformFixedFee","typeLabel":"object | null"},"partnerFee":{"oneOf":[{"type":"object","required":["amount","amountAtomic","assetType","assetCode","decimals","chainId","tokenAddress"],"properties":{"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.0.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.0.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","const":"crypto","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.0.assetType","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.0.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.0.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.0.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.0.tokenAddress","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.partnerFee","typeLabel":"object | null"},"totalFees":{"oneOf":[{"type":"object","description":"Total payout fees in the funding asset: providerFee + platformFee (Stableyard) + partnerFee (app partner). Already included in required; do not add again. Null when fee visibility is restricted or a frozen component is unavailable. Excludes any additional fee quoted separately by a selected funding method.","required":["amount","amountAtomic","assetType","assetCode","decimals","chainId","tokenAddress"],"properties":{"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.0.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.0.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","const":"crypto","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.0.assetType","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.0.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.0.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.0.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.0.tokenAddress","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.0","typeLabel":"object"},{"type":"null","description":"Total payout fees in the funding asset: providerFee + platformFee (Stableyard) + partnerFee (app partner). Already included in required; do not add again. Null when fee visibility is restricted or a frozen component is unavailable. Excludes any additional fee quoted separately by a selected funding method.","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.totalFees","typeLabel":"object | null"},"exchangeRate":{"oneOf":[{"type":"object","description":"Directional rate frozen from the payout quote. One unit of baseAssetCode equals rate units of quoteAssetCode.","required":["rate","baseAssetCode","quoteAssetCode"],"properties":{"rate":{"type":"string","pattern":"^(?=.*[1-9])(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.exchangeRate.oneOf.0.rate","typeLabel":"string"},"baseAssetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.exchangeRate.oneOf.0.baseAssetCode","typeLabel":"string"},"quoteAssetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.exchangeRate.oneOf.0.quoteAssetCode","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.exchangeRate.oneOf.0","typeLabel":"object"},{"type":"null","description":"Directional rate frozen from the payout quote. One unit of baseAssetCode equals rate units of quoteAssetCode.","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.exchangeRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.exchangeRate","typeLabel":"object | null"},"quoteExpiresAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.quoteExpiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.quoteExpiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.quoteExpiresAt","typeLabel":"string\u003cdate-time> | null"},"depositAddress":{"oneOf":[{"type":"object","description":"Direct funding instruction for the selected Payment Source, when eligible. Null while escrow is provisioning. For an eligible Base USDC source, poll checkout for the automatically prepared Routing option and use its Base funding instructions; never fund the Arbitrum escrow directly from Base.","required":["address","chainId","tokenAddress","assetCode","decimals","amount","amountAtomic"],"properties":{"address":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.0.address","typeLabel":"string"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.0.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.0.tokenAddress","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.0.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.0.decimals","typeLabel":"integer"},"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.0.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.0.amountAtomic","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.0","typeLabel":"object"},{"type":"null","description":"Direct funding instruction for the selected Payment Source, when eligible. Null while escrow is provisioning. For an eligible Base USDC source, poll checkout for the automatically prepared Routing option and use its Base funding instructions; never fund the Arbitrum escrow directly from Base.","isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding.oneOf.0.depositAddress","typeLabel":"object | null"},"mode":{"type":"string","enum":["escrow","vault_treasury"],"description":"`escrow`: source funds are collected into a Payment-specific escrow. Every new external payout uses it. `vault_treasury` may appear on older records.","uniqueKey":"payment.funding.oneOf.0.mode","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.funding.oneOf.0","typeLabel":"External payout funding · object"},{"type":"null","title":"No separate funding collection","description":"Create-time funding quote for an external fiat send rail. required is the exact source amount. When the sender's active Payment Source is a Stableyard-managed Vault, creation immediately authorizes Vault funding of this amount into the Payment's escrow, and the destination payout starts once that collection is verified. Otherwise creation itself does not debit funds or submit the destination payout. Null for ordinary receive and direct-send Payments.","isRequired":true,"uniqueKey":"payment.funding.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.funding","typeLabel":"External payout funding · object | null"},"externalReference":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.externalReference.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment.externalReference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.externalReference","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.description","typeLabel":"string | null"},"metadata":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"payment.metadata","typeLabel":"object"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payment.expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"payment.expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.expiresAt","typeLabel":"string\u003cdate-time> | null"},"acceptedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payment.acceptedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"payment.acceptedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.acceptedAt","typeLabel":"string\u003cdate-time> | null"},"succeededAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payment.succeededAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"payment.succeededAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.succeededAt","typeLabel":"string\u003cdate-time> | null"},"cancelledAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payment.cancelledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"payment.cancelledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.cancelledAt","typeLabel":"string\u003cdate-time> | null"},"failure":{"oneOf":[{"type":"object","title":"Failure details","required":["code","message"],"properties":{"code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.failure.oneOf.0.code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment.failure.oneOf.0.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.failure.oneOf.0.code","typeLabel":"string | null"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment.failure.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment.failure.oneOf.0.message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.failure.oneOf.0.message","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payment.failure.oneOf.0","typeLabel":"Failure details · object"},{"type":"null","title":"No failure","isRequired":true,"uniqueKey":"payment.failure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.failure","typeLabel":"Failure details · object | null"},"refundSummary":{"type":"object","additionalProperties":false,"required":["status","count","requestedAmountAtomic","confirmedAmountAtomic"],"properties":{"status":{"type":"string","enum":["none","pending","partially_refunded","refunded","failed","requires_intervention"],"isRequired":true,"uniqueKey":"payment.refundSummary.status","typeLabel":"enum\u003cstring>"},"count":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payment.refundSummary.count","typeLabel":"integer"},"requestedAmountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.refundSummary.requestedAmountAtomic","typeLabel":"string"},"confirmedAmountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.refundSummary.confirmedAmountAtomic","typeLabel":"string"}},"description":"Aggregate progress for Refund resources attached to this Payment. Supported direct receive refunds are created through the Partner API. Returns of failed external payouts are reported through `offrampStatus`, not here.","isRequired":true,"uniqueKey":"payment.refundSummary","typeLabel":"object"},"incidentRecoverySummary":{"type":"object","additionalProperties":false,"required":["count","pendingCount","confirmedCount","failedCount","requiresInterventionCount","requestedAmountAtomic","confirmedAmountAtomic"],"properties":{"count":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payment.incidentRecoverySummary.count","typeLabel":"integer"},"pendingCount":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payment.incidentRecoverySummary.pendingCount","typeLabel":"integer"},"confirmedCount":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payment.incidentRecoverySummary.confirmedCount","typeLabel":"integer"},"failedCount":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payment.incidentRecoverySummary.failedCount","typeLabel":"integer"},"requiresInterventionCount":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payment.incidentRecoverySummary.requiresInterventionCount","typeLabel":"integer"},"requestedAmountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.incidentRecoverySummary.requestedAmountAtomic","typeLabel":"string"},"confirmedAmountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"payment.incidentRecoverySummary.confirmedAmountAtomic","typeLabel":"string"}},"description":"Recovery of duplicate, late, overpaid, or underpaid receipts. These amounts never contribute to refundSummary for the accepted merchant payment.","isRequired":true,"uniqueKey":"payment.incidentRecoverySummary","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payment.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payment.updatedAt","typeLabel":"string\u003cdate-time>"},"sourceAmount":{"type":"object","additionalProperties":false,"required":["amount","amountAtomic","assetType","assetCode","decimals"],"properties":{"amount":{"type":"string","minLength":1,"maxLength":100,"pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","example":"50.00","isRequired":true,"uniqueKey":"payment.sourceAmount.amount","typeLabel":"string"},"amountAtomic":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[1-9][0-9]*$","example":"50000000","isRequired":true,"uniqueKey":"payment.sourceAmount.amountAtomic","typeLabel":"string"},"assetType":{"type":"string","enum":["crypto","fiat"],"isRequired":true,"uniqueKey":"payment.sourceAmount.assetType","typeLabel":"enum\u003cstring>"},"assetCode":{"type":"string","example":"USDC","isRequired":true,"uniqueKey":"payment.sourceAmount.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"example":6,"isRequired":true,"uniqueKey":"payment.sourceAmount.decimals","typeLabel":"integer"},"chainId":{"type":"integer","minimum":1,"example":8453,"uniqueKey":"payment.sourceAmount.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","uniqueKey":"payment.sourceAmount.tokenAddress","typeLabel":"string"}},"description":"Frozen source debit including commercial fees, exposed for Send execution to callers permitted to view sender fees.","uniqueKey":"payment.sourceAmount","typeLabel":"object"},"recipientDisplay":{"oneOf":[{"type":"object","title":"Recipient display snapshot","description":"Immutable payer-facing recipient identity captured when the Payment was created.","required":["displayName","logoUrl"],"properties":{"displayName":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"payment.recipientDisplay.oneOf.0.displayName","typeLabel":"string"},"logoUrl":{"oneOf":[{"type":"string","format":"uri","maxLength":2048,"isRequired":true,"uniqueKey":"payment.recipientDisplay.oneOf.0.logoUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","maxLength":2048,"isRequired":true,"uniqueKey":"payment.recipientDisplay.oneOf.0.logoUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.recipientDisplay.oneOf.0.logoUrl","typeLabel":"string\u003curi> | null"}},"additionalProperties":false,"uniqueKey":"payment.recipientDisplay.oneOf.0","typeLabel":"Recipient display snapshot · object"},{"type":"null","title":"No recipient display snapshot","description":"Immutable payer-facing recipient identity captured when the Payment was created.","uniqueKey":"payment.recipientDisplay.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.recipientDisplay","typeLabel":"Recipient display snapshot · object | null"}},"isRequired":true,"uniqueKey":"payment","typeLabel":"object"},"nextAction":{"oneOf":[{"type":"object","title":"Action required","description":"The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.","required":["id","type","expiresAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"nextAction.oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["transaction","managed_authorization","payment_method"],"isRequired":true,"uniqueKey":"nextAction.oneOf.0.type","typeLabel":"enum\u003cstring>"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"nextAction.oneOf.0.expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"nextAction.oneOf.0.expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nextAction.oneOf.0.expiresAt","typeLabel":"string\u003cdate-time> | null"},"depositInstructions":{"type":"object","additionalProperties":false,"required":["address","chainId","tokenAddress","assetCode","decimals","amount","amountAtomic"],"description":"Present only when type is \"transaction\" for a collection deposit: the exact on-chain payment to make to advance this Payment.","properties":{"address":{"type":"string","isRequired":true,"uniqueKey":"nextAction.oneOf.0.depositInstructions.address","typeLabel":"string"},"chainId":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"nextAction.oneOf.0.depositInstructions.chainId","typeLabel":"integer"},"tokenAddress":{"type":"string","isRequired":true,"uniqueKey":"nextAction.oneOf.0.depositInstructions.tokenAddress","typeLabel":"string"},"assetCode":{"type":"string","isRequired":true,"uniqueKey":"nextAction.oneOf.0.depositInstructions.assetCode","typeLabel":"string"},"decimals":{"type":"integer","minimum":0,"maximum":36,"isRequired":true,"uniqueKey":"nextAction.oneOf.0.depositInstructions.decimals","typeLabel":"integer"},"amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$","isRequired":true,"uniqueKey":"nextAction.oneOf.0.depositInstructions.amount","typeLabel":"string"},"amountAtomic":{"type":"string","pattern":"^[0-9]+$","isRequired":true,"uniqueKey":"nextAction.oneOf.0.depositInstructions.amountAtomic","typeLabel":"string"}},"uniqueKey":"nextAction.oneOf.0.depositInstructions","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nextAction.oneOf.0","typeLabel":"Action required · object"},{"type":"object","title":"Start account KYC","description":"The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.","required":["type"],"properties":{"type":{"type":"string","const":"start_kyc_session","isRequired":true,"uniqueKey":"nextAction.oneOf.1.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nextAction.oneOf.1","typeLabel":"Start account KYC · object"},{"type":"object","title":"Re-verify identity","description":"The current approved verification lacks identity data or a document type this payout requires, and the user cannot supply it on a form. Call POST /v2/accounts/{accountId}/kyc/session to get a new verification link; the current approval stays in force until the new session is decided.","required":["type"],"properties":{"type":{"type":"string","const":"reverify_identity","isRequired":true,"uniqueKey":"nextAction.oneOf.2.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nextAction.oneOf.2","typeLabel":"Re-verify identity · object"},{"type":"object","title":"Verify UPA email","description":"The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.","required":["type"],"properties":{"type":{"type":"string","const":"verify_account_email","isRequired":true,"uniqueKey":"nextAction.oneOf.3.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nextAction.oneOf.3","typeLabel":"Verify UPA email · object"},{"type":"object","title":"Complete hosted compliance","description":"Open this Stableyard-hosted URL as a top-level page. The link uses a one-time exchange and asks only for information missing from the verified account.","required":["type","url","expiresAt"],"properties":{"type":{"type":"string","const":"complete_compliance","isRequired":true,"uniqueKey":"nextAction.oneOf.4.type","typeLabel":"string"},"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"nextAction.oneOf.4.url","typeLabel":"string\u003curi>"},"expiresAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"nextAction.oneOf.4.expiresAt","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nextAction.oneOf.4","typeLabel":"Complete hosted compliance · object"},{"type":"object","title":"Waiting for review","description":"The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.","required":["type"],"properties":{"type":{"type":"string","const":"wait_for_partner_kyc","isRequired":true,"uniqueKey":"nextAction.oneOf.5.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nextAction.oneOf.5","typeLabel":"Waiting for review · object"},{"type":"object","title":"Contact support","description":"The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.","required":["type"],"properties":{"type":{"type":"string","const":"contact_support","isRequired":true,"uniqueKey":"nextAction.oneOf.6.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nextAction.oneOf.6","typeLabel":"Contact support · object"},{"type":"object","title":"No action required (type none)","description":"The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.","required":["type"],"properties":{"type":{"type":"string","const":"none","isRequired":true,"uniqueKey":"nextAction.oneOf.7.type","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nextAction.oneOf.7","typeLabel":"No action required (type none) · object"},{"type":"null","title":"No action required","description":"The exact action the caller must complete. Null means Stableyard needs no action from the partner right now.","isRequired":true,"uniqueKey":"nextAction.oneOf.8","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nextAction","typeLabel":"Action required · object | Start account KYC · object | Re-verify identity · object | Verify UPA email · object | Complete hosted compliance · object | Waiting for review · object | Contact support · object | No action required (type none) · object | null"},"checkout":{"type":"object","additionalProperties":false,"required":["paymentUrl","clientSecret","expiresAt","returnUrl"],"properties":{"paymentUrl":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"checkout.paymentUrl","typeLabel":"string\u003curi>"},"clientSecret":{"type":"string","minLength":32,"maxLength":512,"isRequired":true,"uniqueKey":"checkout.clientSecret","typeLabel":"string"},"expiresAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"checkout.expiresAt","typeLabel":"string\u003cdate-time>"},"returnUrl":{"oneOf":[{"type":"string","format":"uri","isRequired":true,"uniqueKey":"checkout.returnUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","isRequired":true,"uniqueKey":"checkout.returnUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"checkout.returnUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"checkout","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","summary":"Get my payment 200 response","value":{"payment":{"id":"payment_123","apiVersion":"2026-09-09","intent":"receive","amountMode":"collect_exact","status":"requires_payment_method","offrampStatus":null,"stage":null,"operationalState":"normal","operationalReasonCode":null,"operationalUpdatedAt":null,"statusVersion":1,"paymentAmount":{"amount":"50.00","amountAtomic":"50000000","assetType":"crypto","assetCode":"USDC","decimals":6,"chainId":8453,"tokenAddress":"0x1111111111111111111111111111111111111111"},"sourceAmount":{"amount":"50.00","amountAtomic":"50000000","assetType":"crypto","assetCode":"USDC","decimals":6,"chainId":8453,"tokenAddress":"0x1111111111111111111111111111111111111111"},"participants":[{"role":"sender","accountId":"acct_123"}],"recipientDisplay":{"displayName":"Example account","logoUrl":null},"destination":{"type":"upa","accountId":"acct_123"},"settlement":{"type":"settlement_destination","settlementDestinationId":null,"destinationType":"example","destinationAddress":"0x1111111111111111111111111111111111111111","chainId":1,"assetCode":"USDC","tokenAddress":"0x1111111111111111111111111111111111111111","decimals":0},"fees":{"version":null,"pricingStatus":"quote_pending","platformFeeBps":0,"partnerFeeBps":0,"platformFeeAmountAtomic":null,"partnerFeeAmountAtomic":null,"merchantNetAmountAtomic":null},"funding":{"mode":"escrow","required":{"amount":"1000000","amountAtomic":"1000000","assetType":"crypto","assetCode":"USDC","decimals":0,"chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111"},"providerPrincipal":{"amount":"1000000","amountAtomic":"1000000","assetType":"crypto","assetCode":"USDC","decimals":0,"chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111"},"providerFee":{"amount":"1000000","amountAtomic":"1000000","assetType":"crypto","assetCode":"USDC","decimals":0,"chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111"},"platformFee":{"amount":"1000000","amountAtomic":"1000000","assetType":"crypto","assetCode":"USDC","decimals":0,"chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111"},"platformFixedFee":{"amount":"1000000","amountAtomic":"1000000","assetType":"crypto","assetCode":"USDC","decimals":0,"chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111"},"partnerFee":{"amount":"1000000","amountAtomic":"1000000","assetType":"crypto","assetCode":"USDC","decimals":0,"chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111"},"totalFees":{"amount":"1000000","amountAtomic":"1000000","assetType":"crypto","assetCode":"USDC","decimals":0,"chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111"},"exchangeRate":{"rate":"1000000","baseAssetCode":"USDC","quoteAssetCode":"USDC"},"quoteExpiresAt":null,"depositAddress":{"address":"0x1111111111111111111111111111111111111111","chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111","assetCode":"USDC","decimals":0,"amount":"1000000","amountAtomic":"1000000"}},"externalReference":null,"description":null,"metadata":{},"expiresAt":null,"acceptedAt":null,"succeededAt":null,"cancelledAt":null,"failure":{"code":null,"message":null},"refundSummary":{"status":"none","count":0,"requestedAmountAtomic":"1000000","confirmedAmountAtomic":"1000000"},"incidentRecoverySummary":{"count":0,"pendingCount":0,"confirmedCount":0,"failedCount":0,"requiresInterventionCount":0,"requestedAmountAtomic":"1000000","confirmedAmountAtomic":"1000000"},"createdAt":"2026-08-28T10:00:00.000Z","updatedAt":"2026-08-28T10:00:00.000Z"},"checkout":{"paymentUrl":"https://example.com","clientSecret":"examplexxxxxxxxxxxxxxxxxxxxxxxxx","expiresAt":"2026-08-28T10:00:00.000Z","returnUrl":null},"nextAction":{"id":"resource_123","type":"transaction","expiresAt":null,"depositInstructions":{"address":"0x1111111111111111111111111111111111111111","chainId":1,"tokenAddress":"0x1111111111111111111111111111111111111111","assetCode":"USDC","decimals":0,"amount":"1000000","amountAtomic":"1000000"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"89582a4a-facb-40e1-8e23-97492f99283a":{"description":"Unauthorized","headers":{"Stableyard-Version":{"description":"Effective date-based Stableyard API contract version for this response.","schema":{"type":"string","enum":["2026-09-09"]}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":128,"example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":1000,"example":"The request is invalid","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","summary":"unauthorized","value":{"error":{"code":"unauthorized","message":"Authentication is required"}}}},"exampleType":"examples"}},"exampleType":"examples"},"677f2ce3-d7c9-498f-a877-e188e8205746":{"description":"The app secret does not include the required scope","headers":{"Stableyard-Version":{"description":"Effective date-based Stableyard API contract version for this response.","schema":{"type":"string","enum":["2026-09-09"]}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":128,"example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":1000,"example":"The request is invalid","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","summary":"forbidden","value":{"error":{"code":"forbidden","message":"The credential does not allow this operation"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a8ac67f7-8824-4c1f-b19b-1b683078414e":{"description":"Not found","headers":{"Stableyard-Version":{"description":"Effective date-based Stableyard API contract version for this response.","schema":{"type":"string","enum":["2026-09-09"]}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":128,"example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":1000,"example":"The request is invalid","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","summary":"not_found","value":{"error":{"code":"not_found","message":"The resource was not found"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"513b04d2-82e4-40ab-a17f-c3e933dfb275":{"clientBearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Stableyard client access token","description":"Short-lived account-bound token returned by POST /v2/client/auth/exchange.","scopes":[],"schemeName":"clientBearerAuth"}}},"servers":{"d273b006-c101-40f8-b2f9-947071af1f98":{"url":"https://prod-api.stableyard.fi","description":"Production"},"333e279f-022e-4549-8780-374542d5f7e2":{"url":"https://staging-api-v2.stableyard.fi","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Stableyard client access token","description":"Short-lived account-bound token returned by POST /v2/client/auth/exchange.","scopes":[],"schemeName":"clientBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Short-lived account-bound token returned by POST /v2/client/auth/exchange.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"clientBearerAuth","name":"Authorization"}],"title":"clientBearerAuth"}]},"originalFileLocation":"frontend-openapi.json"},"subdomain":"stableyard","siteName":"Stableyard","title":"Get a payment for the client account - Stableyard","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-04T09:12:36.581Z","originalFileLocation":"api-reference/client-payments/get-payment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"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=\"Fetch a Payment that the client token\u0026#x27;s account owns or participates in.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stableyard\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stableyard/CM8upYhMXAYLlKm0/_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/stableyard/CM8upYhMXAYLlKm0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stableyard/CM8upYhMXAYLlKm0/_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/stableyard/CM8upYhMXAYLlKm0/_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/stableyard/CM8upYhMXAYLlKm0/_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/stableyard/CM8upYhMXAYLlKm0/_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/stableyard/CM8upYhMXAYLlKm0/_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/stableyard/CM8upYhMXAYLlKm0/_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/stableyard/CM8upYhMXAYLlKm0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a payment for the client account - Stableyard\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch a Payment that the client token\u0026#x27;s account owns or participates in.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stableyard\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stableyard.fi/api-reference/client-payments/get-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stableyard.mintlify.site/_mintlify/api/og/v2?division=Client+payments\u0026amp;title=Get+a+payment+for+the+client+account\u0026amp;description=Fetch+a+Payment+that+the+client+token%27s+account+owns+or+participates+in.\u0026amp;theme=20d8ecbbc4b005af9f5d1ddd\u0026amp;signature=05a362ba6fce0c74abc6f554d52a6aa9669197d6a3450b70ab863c64e9141aa4\">\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 a payment for the client account - Stableyard\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch a Payment that the client token\u0026#x27;s account owns or participates in.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stableyard.mintlify.site/_mintlify/api/og/v2?division=Client+payments\u0026amp;title=Get+a+payment+for+the+client+account\u0026amp;description=Fetch+a+Payment+that+the+client+token%27s+account+owns+or+participates+in.\u0026amp;theme=20d8ecbbc4b005af9f5d1ddd\u0026amp;signature=05a362ba6fce0c74abc6f554d52a6aa9669197d6a3450b70ab863c64e9141aa4\">\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/stableyard/CM8upYhMXAYLlKm0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stableyard\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stableyard.fi/api-reference/client-payments/get-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/client-payments/get-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stableyard.fi/#organization\",\"name\":\"Stableyard\",\"url\":\"https://docs.stableyard.fi\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stableyard/KNLdOufdyK0ENvTU/images/logo-light.svg?fit=max\u0026auto=format\u0026n=KNLdOufdyK0ENvTU\u0026q=85\u0026s=9db9c25a0ce38c9ebf3a01a5b531d374\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stableyard.fi#website\",\"name\":\"Stableyard\",\"url\":\"https://docs.stableyard.fi\",\"publisher\":{\"@id\":\"https://docs.stableyard.fi/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stableyard.fi/api-reference/client-payments/get-payment#webpage\",\"url\":\"https://docs.stableyard.fi/api-reference/client-payments/get-payment\",\"name\":\"Get a payment for the client account\",\"description\":\"Fetch a Payment that the client token's account owns or participates in.\",\"dateModified\":\"2026-10-04T09:12:36.581Z\",\"isPartOf\":{\"@id\":\"https://docs.stableyard.fi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stableyard.fi/api-reference/client-payments/get-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stableyard.fi/api-reference/client-payments/get-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Client \u0026 checkout\",\"item\":\"https://docs.stableyard.fi/api-reference/client-sessions/create-client-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Client payments\",\"item\":\"https://docs.stableyard.fi/api-reference/client-payments/create-payment\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a payment for the client account\",\"item\":\"https://docs.stableyard.fi/api-reference/client-payments/get-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stableyard.fi/api-reference/client-payments/get-payment#apireference\",\"headline\":\"Get a payment for the client account\",\"name\":\"Get a payment for the client account\",\"description\":\"Fetch a Payment that the client token's account owns or participates in.\",\"url\":\"https://docs.stableyard.fi/api-reference/client-payments/get-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stableyard.fi/api-reference/client-payments/get-payment#webpage\"},\"dateModified\":\"2026-10-04T09:12:36.581Z\",\"publisher\":{\"@id\":\"https://docs.stableyard.fi/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stableyard.fi#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stableyard\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Stableyard\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/client-payments/get-payment.md","siteName":"Stableyard","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/concepts/overview"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/overview"}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/payments/overview"}]},{"tab":"Settlement","pages":[{"title":"Settlement","href":"/settlement/overview"}]},{"tab":"White-label","pages":[{"title":"White-label","href":"/white-label/overview"}]},{"tab":"API reference","groups":[{"group":"Introduction","pages":[{"title":"API reference","sidebarTitle":"Introduction","icon":"book-open","href":"/api-reference"}]},{"group":"Onboarding","pages":[{"group":"Universal Payment Accounts","icon":"user","pages":[{"openapi":"openapi.json POST /v2/accounts","title":"Create an account","sidebarTitle":"Create account","href":"/api-reference/accounts/create-account"},{"openapi":"openapi.json GET /v2/accounts/{accountId}","title":"Get an account","sidebarTitle":"Get account","href":"/api-reference/accounts/get-account"},{"openapi":"openapi.json GET /v2/accounts/external/{externalUserId}","title":"Get an account by external user ID","sidebarTitle":"Get by external ID","href":"/api-reference/accounts/get-account-by-external-id"},{"openapi":"openapi.json PUT /v2/accounts/{accountId}/display-profile","title":"Update display profile","sidebarTitle":"Update display profile","href":"/api-reference/accounts/update-display-profile"}]},{"group":"Email verification","icon":"envelope","pages":[{"openapi":"openapi.json GET /v2/accounts/{accountId}/email","title":"Get an account's email status","sidebarTitle":"Email status","href":"/api-reference/email/get-email-status"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/email/verification-challenges","title":"Verify or link an account email","sidebarTitle":"Verify email","href":"/api-reference/email/start-email-verification"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/email/verification-challenges/{challengeId}/confirm","title":"Confirm an account email verification","sidebarTitle":"Confirm email","href":"/api-reference/email/confirm-email-verification"}]},{"group":"Identity verification","icon":"id-card","pages":[{"openapi":"openapi.json POST /v2/accounts/{accountId}/kyc/session","title":"Create or resume a KYC session","sidebarTitle":"Start KYC","href":"/api-reference/kyc/create-kyc-session"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/kyc","title":"Get an account's KYC status","sidebarTitle":"KYC status","href":"/api-reference/kyc/get-kyc-status"},{"openapi":"openapi.json GET /v2/partners/kyc-reuse-policy","title":"Read identity reuse policy","href":"/api-reference/kyc/reuse-policy"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/kyc/imports","title":"Import a shared identity","href":"/api-reference/kyc/import-identity"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/kyc/imports/{importId}","title":"Read identity import","href":"/api-reference/kyc/get-identity-import"}]},{"group":"Capabilities","icon":"circle-check","pages":[{"openapi":"openapi.json POST /v2/accounts/{accountId}/capability-activations","title":"Activate a regulated capability","sidebarTitle":"Activate capability","href":"/api-reference/capabilities/activate-capability"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/capabilities","title":"List regulated capability readiness","sidebarTitle":"List capabilities","href":"/api-reference/capabilities/list-capabilities"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/compliance-claim-reuse/revocations","title":"Withdraw claim reuse consent","sidebarTitle":"Withdraw claim reuse consent","href":"/api-reference/capabilities/revoke-claim-reuse"}]}]},{"group":"Accounts","pages":[{"group":"Bank accounts","icon":"building-columns","pages":[{"openapi":"openapi.json GET /v2/accounts/{accountId}/bank-account-requirements","title":"Get bank account requirements by country","sidebarTitle":"Bank requirements","href":"/api-reference/bank-accounts/get-bank-account-requirements"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/bank-account-banks","title":"List banks for linking a bank account","sidebarTitle":"List banks","href":"/api-reference/bank-accounts/list-banks"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/bank-accounts","title":"Link a bank account","sidebarTitle":"Link bank account","href":"/api-reference/bank-accounts/link-bank-account"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/bank-accounts","title":"List linked bank accounts","sidebarTitle":"List bank accounts","href":"/api-reference/bank-accounts/list-bank-accounts"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/bank-accounts/{bankAccountId}","title":"Get a linked bank account","sidebarTitle":"Get bank account","href":"/api-reference/bank-accounts/get-bank-account"},{"openapi":"openapi.json DELETE /v2/accounts/{accountId}/bank-accounts/{bankAccountId}","title":"Disable a linked bank account","sidebarTitle":"Disable bank account","href":"/api-reference/bank-accounts/disable-bank-account"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/beneficiaries","title":"List saved bank beneficiaries","href":"/api-reference/beneficiaries/list-beneficiaries"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/beneficiaries","title":"Save a bank beneficiary","href":"/api-reference/beneficiaries/create-beneficiary"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/beneficiaries/{beneficiaryId}","title":"Get a saved bank beneficiary","href":"/api-reference/beneficiaries/get-beneficiary"},{"openapi":"openapi.json DELETE /v2/accounts/{accountId}/beneficiaries/{beneficiaryId}","title":"Disable a saved bank beneficiary","href":"/api-reference/beneficiaries/disable-beneficiary"}]},{"group":"Wallets","icon":"wallet","pages":[{"openapi":"openapi.json POST /v2/accounts/{accountId}/wallets","title":"Link wallets to an account","sidebarTitle":"Link wallets","href":"/api-reference/wallets/link-wallets"}]},{"group":"Payment handles","icon":"at","pages":[{"openapi":"openapi.json GET /v2/payment-handles/{handle}/availability","title":"Check whether a payment handle is available","sidebarTitle":"Check availability","href":"/api-reference/payment-handles/check-handle-availability"},{"openapi":"openapi.json PUT /v2/accounts/{accountId}/payment-handle","title":"Set an account's payment handle","sidebarTitle":"Set handle","href":"/api-reference/payment-handles/set-payment-handle"},{"openapi":"openapi.json GET /v2/payment-handles/{handle}","title":"Resolve a payment handle","sidebarTitle":"Resolve handle","href":"/api-reference/payment-handles/resolve-payment-handle"},{"openapi":"openapi.json PUT /v2/accounts/{accountId}/payment-acceptance","title":"Turn public payment acceptance on or off","sidebarTitle":"Public acceptance","href":"/api-reference/payment-handles/update-payment-acceptance"}]},{"group":"Settlement preferences","icon":"location-dot","pages":[{"openapi":"openapi.json GET /v2/accounts/{accountId}/settlement-destinations","title":"List an account's settlement destinations","sidebarTitle":"List destinations","href":"/api-reference/settlement/list-settlement-destinations"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/settlement-profile","title":"Get an account's settlement preference","sidebarTitle":"Settlement preference","href":"/api-reference/settlement/get-settlement-profile"},{"openapi":"openapi.json PUT /v2/accounts/{accountId}/settlement-profile","title":"Set an account's settlement preference","sidebarTitle":"Set preference","href":"/api-reference/settlement/set-settlement-profile"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/payment-source","title":"Get an account's payment source","sidebarTitle":"Payment source","href":"/api-reference/settlement/get-payment-source"},{"openapi":"openapi.json PUT /v2/accounts/{accountId}/payment-source","title":"Set an account's payment source","sidebarTitle":"Set payment source","href":"/api-reference/settlement/set-payment-source"}]}]},{"group":"Money movement","pages":[{"group":"Payments","icon":"money-bill-transfer","pages":[{"openapi":"openapi.json POST /v2/payments/preview","title":"Preview a send payment","sidebarTitle":"Preview payment","href":"/api-reference/payments/preview-payment"},{"openapi":"openapi.json POST /v2/payments/decode-qr","title":"Decode a QR code","sidebarTitle":"Decode a QR code","href":"/api-reference/payments/decode-qr"},{"openapi":"openapi.json POST /v2/payments","title":"Create a payment","sidebarTitle":"Create payment","href":"/api-reference/payments/create-payment"},{"openapi":"openapi.json GET /v2/payments","title":"List payments","sidebarTitle":"List payments","href":"/api-reference/payments/list-payments"},{"openapi":"openapi.json GET /v2/payments/{paymentId}","title":"Get a payment","sidebarTitle":"Get payment","href":"/api-reference/payments/get-payment"},{"openapi":"openapi.json GET /v2/payments/{paymentId}/checkout","title":"Get hosted checkout link","sidebarTitle":"Get hosted checkout link","href":"/api-reference/payments/get-checkout-link"},{"openapi":"openapi.json POST /v2/payments/{paymentId}/confirm","title":"Confirm a send payment's pending action","sidebarTitle":"Confirm payment","href":"/api-reference/payments/confirm-payment"},{"openapi":"openapi.json POST /v2/payments/{paymentId}/cancel","title":"Cancel an unpaid receive payment","sidebarTitle":"Cancel payment","href":"/api-reference/payments/cancel-payment"},{"openapi":"openapi.json GET /v2/payments/external-bank/banks","title":"List supported beneficiary banks","sidebarTitle":"Beneficiary banks","href":"/api-reference/payments/list-beneficiary-banks"}]},{"group":"Refunds","icon":"rotate-left","pages":[{"openapi":"openapi.json POST /v2/payments/{paymentId}/refunds","title":"Refund a payment","sidebarTitle":"Create refund","href":"/api-reference/refunds/create-refund"},{"openapi":"openapi.json GET /v2/payments/{paymentId}/refunds","title":"List a payment's refunds","sidebarTitle":"List refunds","href":"/api-reference/refunds/list-refunds"},{"openapi":"openapi.json GET /v2/refunds/{refundId}","title":"Get a refund","sidebarTitle":"Get refund","href":"/api-reference/refunds/get-refund"}]},{"group":"On-ramp accounts","icon":"money-bill-wave","pages":[{"openapi":"openapi.json GET /v2/accounts/{accountId}/onramp-bank-account-requirements","title":"Get on-ramp requirements","sidebarTitle":"Get on-ramp requirements","href":"/api-reference/onramp-accounts/get-onramp-requirements"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/onramp-bank-accounts","title":"Issue an on-ramp bank account","sidebarTitle":"Issue on-ramp account","href":"/api-reference/onramp-accounts/issue-onramp-account"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/onramp-bank-accounts","title":"List on-ramp bank accounts","sidebarTitle":"List on-ramp accounts","href":"/api-reference/onramp-accounts/list-onramp-accounts"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/onramp-bank-accounts/{onrampBankAccountId}/deposit-instructions","title":"Get deposit instructions for an on-ramp bank account","sidebarTitle":"Deposit instructions","href":"/api-reference/onramp-accounts/get-deposit-instructions"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/onramp-bank-accounts/{onrampBankAccountId}/transactions","title":"List funding transactions for an on-ramp bank account","sidebarTitle":"Funding transactions","href":"/api-reference/onramp-accounts/list-funding-transactions"}]},{"group":"Deposit addresses","icon":"inbox","pages":[{"openapi":"openapi.json GET /v2/deposit-networks","title":"List deposit networks","sidebarTitle":"List networks","href":"/api-reference/deposit-addresses/list-deposit-networks"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/deposit-addresses","title":"Create deposit addresses","sidebarTitle":"Create addresses","href":"/api-reference/deposit-addresses/create-deposit-addresses"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/deposit-addresses","title":"List deposit addresses","sidebarTitle":"List addresses","href":"/api-reference/deposit-addresses/list-deposit-addresses"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/deposit-addresses/check","title":"Check a deposit transaction","sidebarTitle":"Check deposit","href":"/api-reference/deposit-addresses/check-deposit"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/deposits","title":"List deposits","sidebarTitle":"List deposits","href":"/api-reference/deposit-addresses/list-deposits"}]}]},{"group":"Activity","pages":[{"group":"Transactions","icon":"list","pages":[{"openapi":"openapi.json GET /v2/accounts/{accountId}/transactions","title":"List account transactions","sidebarTitle":"List transactions","href":"/api-reference/transactions/list-transactions"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/transactions/{transactionId}","title":"Get a transaction","sidebarTitle":"Get transaction","href":"/api-reference/transactions/get-transaction"}]},{"group":"Balances","icon":"scale-balanced","pages":[{"openapi":"openapi.json GET /v2/accounts/{accountId}/balances","title":"Get recorded activity totals","sidebarTitle":"Activity totals","href":"/api-reference/balances/get-activity-totals"}]}]},{"group":"Vaults","pages":[{"group":"Vaults","icon":"vault","pages":[{"openapi":"openapi.json POST /v2/accounts/{accountId}/vault","title":"Create an account Vault","sidebarTitle":"Create Vault","href":"/api-reference/vaults/create-vault"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/vault","title":"Get an account Vault","sidebarTitle":"Get Vault","href":"/api-reference/vaults/get-vault"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/vault/spend-usage","title":"Get Vault spend usage","sidebarTitle":"Spend usage","href":"/api-reference/vaults/get-spend-usage"}]},{"group":"Policies","icon":"shield-halved","pages":[{"openapi":"openapi.json POST /v2/accounts/{accountId}/vault/policies","title":"Propose a Vault policy update","sidebarTitle":"Propose policy","href":"/api-reference/vault-policies/propose-policy"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/vault/policies","title":"List Vault policies","sidebarTitle":"List policies","href":"/api-reference/vault-policies/list-policies"},{"openapi":"openapi.json GET /v2/accounts/{accountId}/vault/policies/{policyId}","title":"Get a Vault policy","sidebarTitle":"Get policy","href":"/api-reference/vault-policies/get-policy"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/vault/policies/{policyId}/authorize","title":"Authorize a Vault policy","sidebarTitle":"Authorize policy","href":"/api-reference/vault-policies/authorize-policy"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/vault/policies/{policyId}/resend-approval","title":"Resend a managed policy approval","sidebarTitle":"Resend approval","href":"/api-reference/vault-policies/resend-approval"}]},{"group":"Actions","icon":"bolt","pages":[{"openapi":"openapi.json GET /v2/accounts/{accountId}/vault/actions/{actionId}","title":"Get a Vault action","sidebarTitle":"Get action","href":"/api-reference/vault-actions/get-action"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/vault/actions/{actionId}/complete","title":"Submit an external Vault action transaction","sidebarTitle":"Complete action","href":"/api-reference/vault-actions/complete-action"}]},{"group":"Mandates","icon":"file-signature","pages":[{"openapi":"openapi.json POST /v2/accounts/{accountId}/vault/mandates","title":"Create a Vault mandate","sidebarTitle":"Create mandate","href":"/api-reference/vault-mandates/create-mandate"},{"openapi":"openapi.json POST /v2/accounts/{accountId}/vault/mandates/{mandateId}/revoke","title":"Revoke a Vault mandate","sidebarTitle":"Revoke mandate","href":"/api-reference/vault-mandates/revoke-mandate"}]},{"group":"Audit","icon":"clock-rotate-left","pages":[{"openapi":"openapi.json GET /v2/accounts/{accountId}/vault/audit-events","title":"List Vault audit events","sidebarTitle":"List audit events","href":"/api-reference/vault-audit/list-audit-events"}]}]},{"group":"Client \u0026 checkout","pages":[{"group":"Client sessions","icon":"key","pages":[{"openapi":"frontend-openapi.json POST /v2/client-sessions","title":"Create a client session","sidebarTitle":"Create session","href":"/api-reference/client-sessions/create-client-session"},{"openapi":"frontend-openapi.json POST /v2/client/auth/exchange","title":"Exchange a client session token","sidebarTitle":"Exchange session","href":"/api-reference/client-sessions/exchange-client-session"},{"openapi":"frontend-openapi.json GET /v2/client/bootstrap","title":"Bootstrap the client account","sidebarTitle":"Bootstrap account","href":"/api-reference/client-sessions/get-bootstrap"}]},{"group":"Hosted checkout","icon":"cart-shopping","pages":[{"openapi":"frontend-openapi.json GET /v2/public/apps/{appId}/frontend-config","title":"Get interface SDK configuration","sidebarTitle":"SDK configuration","href":"/api-reference/checkout/get-sdk-configuration"},{"openapi":"frontend-openapi.json GET /v2/public/payment-recipients/{paymentHandle}","title":"Resolve a public payment page","sidebarTitle":"Payment page","href":"/api-reference/checkout/get-payment-page"},{"openapi":"frontend-openapi.json POST /v2/public/apps/{appId}/payments","title":"Create a public receive payment","sidebarTitle":"Create public payment","href":"/api-reference/checkout/create-public-payment"},{"openapi":"frontend-openapi.json GET /v2/public/payments/{paymentId}","title":"Get a checkout payment","sidebarTitle":"Get checkout payment","href":"/api-reference/checkout/get-checkout-payment"},{"openapi":"frontend-openapi.json GET /v2/public/payments/{paymentId}/payment-methods","title":"List payment methods for a checkout payment","sidebarTitle":"List methods","href":"/api-reference/checkout/list-payment-methods"},{"openapi":"frontend-openapi.json POST /v2/public/payments/{paymentId}/options","title":"Select a payment method","sidebarTitle":"Select method","href":"/api-reference/checkout/select-payment-method"},{"openapi":"frontend-openapi.json POST /v2/public/payments/{paymentId}/options/{optionId}/refresh","title":"Refresh a payment option","sidebarTitle":"Refresh option","href":"/api-reference/checkout/refresh-payment-option"},{"openapi":"frontend-openapi.json POST /v2/public/payments/{paymentId}/transactions","title":"Submit a transaction for a checkout payment","sidebarTitle":"Submit transaction","href":"/api-reference/checkout/submit-transaction"}]},{"group":"Client deposits","icon":"circle-down","pages":[{"openapi":"frontend-openapi.json GET /v2/client/me/deposit-networks","title":"List deposit networks for the client account","sidebarTitle":"List networks","href":"/api-reference/client-deposits/list-deposit-networks"},{"openapi":"frontend-openapi.json GET /v2/client/me/deposit-addresses","title":"List the client account's deposit addresses","sidebarTitle":"List addresses","href":"/api-reference/client-deposits/list-deposit-addresses"},{"openapi":"frontend-openapi.json POST /v2/client/me/deposit-addresses","title":"Create deposit addresses for the client account","sidebarTitle":"Create addresses","href":"/api-reference/client-deposits/create-deposit-addresses"},{"openapi":"frontend-openapi.json POST /v2/client/me/deposit-addresses/check","title":"Check a deposit transaction for the client account","sidebarTitle":"Check deposit","href":"/api-reference/client-deposits/check-deposit"},{"openapi":"frontend-openapi.json GET /v2/client/me/deposits","title":"List the client account's deposits","sidebarTitle":"List deposits","href":"/api-reference/client-deposits/list-deposits"}]},{"group":"Client payments","icon":"credit-card","pages":[{"openapi":"frontend-openapi.json POST /v2/client/me/payments","title":"Create a payment for the client account","sidebarTitle":"Create payment","description":"Create a receive or send Payment for the account fixed by the client token.","href":"/api-reference/client-payments/create-payment"},{"openapi":"frontend-openapi.json GET /v2/client/me/payments/{paymentId}","title":"Get a payment for the client account","sidebarTitle":"Get payment","href":"/api-reference/client-payments/get-payment"},{"openapi":"frontend-openapi.json GET /v2/client/me/payments/{paymentId}/payment-methods","title":"List account-bound payment methods","sidebarTitle":"List methods","description":"List the extra account-bound methods, such as Vault, that can fund a receive Payment.","href":"/api-reference/client-payments/list-payment-methods"},{"openapi":"frontend-openapi.json POST /v2/client/me/payments/{paymentId}/options","title":"Select the Vault payment method","sidebarTitle":"Select Vault method","href":"/api-reference/client-payments/select-vault-method"},{"openapi":"frontend-openapi.json POST /v2/client/me/payments/{paymentId}/options/{optionId}/authorize","title":"Authorize a Vault funding operation","sidebarTitle":"Authorize Vault funding","href":"/api-reference/client-payments/authorize-vault-funding"},{"openapi":"frontend-openapi.json POST /v2/client/me/payments/{paymentId}/confirm","title":"Confirm a payment for the client account","sidebarTitle":"Confirm payment","href":"/api-reference/client-payments/confirm-payment"}]}]},{"group":"Platform","pages":[{"group":"Configuration","icon":"gear","pages":[{"openapi":"openapi.json GET /v2/partners/config","title":"Get your partner configuration","sidebarTitle":"Get configuration","href":"/api-reference/configuration/get-partner-config"}]}]}]}]},"basePath":"","title":"Get a payment for the client account - Stableyard","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}