{
"statusCode": 404,
"error": "NotFound",
"message": "No payment with that id or externalId for your org."
}
Payments
Get a payment
Fetch a payment by Caratuva’s internal id or by your own key prefixed with ext_ (e.g. ext_INV-2026-00042) — convenient when you only store your own primary key.
GET
/
v1
/
payments
/
{id}
Get a payment
curl --request GET \ --url https://api.example.com/v1/payments/{id} \ --header 'X-API-Key: <api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Caratuva","description":"Cross-border B2B payments for Brazilian commodity exporters. Collect from foreign buyers, settle in BRL.","colors":{"primary":"#0F766E","light":"#5EEAD4","dark":"#134E4A"},"favicon":"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg","navbar":{"links":[{"href":"https://dashboard.caratuva.com","label":"Dashboard"},{"href":"https://status.caratuva.com","label":"Status"}],"primary":{"type":"button","label":"Sign in","href":"https://dashboard.caratuva.com"}},"footer":{"socials":{}},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":"introduction"},{"language":"pt-BR","href":"pt-BR/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pavezisoftware","hasAudioNarration":false,"actualSubdomain":"pavezisoftware","customDomains":["docs.caratuva.com"],"gitSource":{"type":"github","owner":"pavezi-io","repo":"caratuva","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a4c592a15940cc6d05d5a49","collectionId":"1557afaa-1711-45f9-bc89-08c00102274b","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a4c592a15940cc6d05d5a49:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":46},{"language":"default","tag":"Endpoints","count":46},{"language":"default","tag":"Accounts","count":23},{"language":"en","tag":"Guides","count":12},{"language":"pt-BR","tag":"Guias","count":12},{"language":"en","tag":"API Reference","count":9},{"language":"pt-BR","tag":"Referência da API","count":9},{"language":"default","tag":"Invoices","count":7},{"language":"en","tag":"Integration","count":5},{"language":"en","tag":"Get started","count":5},{"language":"en","tag":"Get paid","count":5},{"language":"en","tag":"For sellers","count":5},{"language":"pt-BR","tag":"Integração","count":5},{"language":"pt-BR","tag":"Começar","count":5},{"language":"pt-BR","tag":"Receba","count":5},{"language":"pt-BR","tag":"Para vendedores","count":5},{"language":"default","tag":"Webhooks","count":5},{"language":"en","tag":"Overview","count":4},{"language":"en","tag":"Using the dashboard","count":4},{"language":"pt-BR","tag":"Visão geral","count":4},{"language":"pt-BR","tag":"Usando o painel","count":4},{"language":"default","tag":"API keys","count":3},{"language":"default","tag":"Payments","count":3},{"language":"default","tag":"Reports","count":3},{"language":"en","tag":"Your buyers","count":2},{"language":"pt-BR","tag":"Seus compradores","count":2},{"language":"default","tag":"Access","count":2},{"language":"en","tag":"Operations","count":1},{"language":"pt-BR","tag":"Operação","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payments/get-a-payment","slug":"/api-reference/payments/get-a-payment","pageMetadata":{"title":"Get a payment","description":"Fetch a payment by Caratuva's internal id or by your own key prefixed with `ext_` (e.g. `ext_INV-2026-00042`) — convenient when you only store your own primary key.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/payments/{id}","href":"/api-reference/payments/get-a-payment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Fetch a payment by Caratuva’s internal id or by your own key prefixed with \", _jsx(_components.code, {\n children: \"ext_\"\n }), \" (e.g. \", _jsx(_components.code, {\n children: \"ext_INV-2026-00042\"\n }), \") — convenient when you only store your own primary key.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a payment","description":"Fetch a payment by Caratuva's internal id or by your own key prefixed with `ext_` (e.g. `ext_INV-2026-00042`) — convenient when you only store your own primary key.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/payments/{id}","href":"/api-reference/payments/get-a-payment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Fetch a payment by Caratuva's internal id or by your own key prefixed with `ext_` (e.g. `ext_INV-2026-00042`) — convenient when you only store your own primary key.","operationId":"PaymentIntentsController_get","parameters":["1786701f-2dea-4b91-87f5-3baab808a958"],"responses":{"200":"63cde92e-2ac4-47e6-8295-5d95f0412829","404":"0f6cfcf7-a013-4c9f-8629-36932839bdce"},"security":["11382052-de86-46ff-9a59-14aae5facf4d","3cd8463e-03da-426f-8c5d-f01a1fb7a095"],"summary":"Get a payment","tags":["Payments"],"method":"get","type":"path","servers":[],"path":"/v1/payments/{id}","baseUrlOptions":[],"title":"Get a payment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1786701f-2dea-4b91-87f5-3baab808a958":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"63cde92e-2ac4-47e6-8295-5d95f0412829":{"description":"Payment detail","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"externalId":{"type":"string","isRequired":true,"uniqueKey":"externalId","typeLabel":"string"},"status":{"type":"string","enum":["draft","awaiting_approval","approved","awaiting_buyer","buyer_kyc_pending","buyer_kyc_approved","buyer_kyc_rejected","fx_quoted","fx_expired","on_ramp_pending","on_ramp_failed","fiat_received","on_chain_confirmed","offramp_pending","offramp_failed","settled","partial_payment","expired","cancelled","restored","manual_review"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"currency":{"type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"hostedPaymentUrl":{"type":"string","isRequired":true,"uniqueKey":"hostedPaymentUrl","typeLabel":"string"},"buyer":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"buyer.id","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"buyer.email","typeLabel":"string\u003cemail>"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"buyer.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"buyer.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buyer.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"buyer.country.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"buyer.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buyer.country","typeLabel":"string | null"},"kycStatus":{"type":"string","enum":["not_started","pending","verifying","approved","rejected"],"isRequired":true,"uniqueKey":"buyer.kycStatus","typeLabel":"enum\u003cstring>"}},"required":["id","email","name","country","kycStatus"],"additionalProperties":false,"isRequired":true,"uniqueKey":"buyer","typeLabel":"object"},"returnUrl":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"returnUrl.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"returnUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"returnUrl","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"metadata","typeLabel":"object | null"},"display":{"oneOf":[{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"display.oneOf.0.title","typeLabel":"string"},"notes":{"type":"string","maxLength":2000,"uniqueKey":"display.oneOf.0.notes","typeLabel":"string"},"lineItems":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":500,"isRequired":true,"uniqueKey":"display.oneOf.0.lineItems.items.[INDEX].description","typeLabel":"string"},"quantity":{"type":"string","uniqueKey":"display.oneOf.0.lineItems.items.[INDEX].quantity","typeLabel":"string"},"unitPrice":{"type":"string","uniqueKey":"display.oneOf.0.lineItems.items.[INDEX].unitPrice","typeLabel":"string"},"subtotal":{"type":"string","uniqueKey":"display.oneOf.0.lineItems.items.[INDEX].subtotal","typeLabel":"string"}},"required":["description"],"additionalProperties":false,"uniqueKey":"display.oneOf.0.lineItems.items.[INDEX]","typeLabel":"object"},"maxItems":500,"uniqueKey":"display.oneOf.0.lineItems","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"display.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"notes":{"type":"string","maxLength":2000},"lineItems":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":500},"quantity":{"type":"string"},"unitPrice":{"type":"string"},"subtotal":{"type":"string"}},"required":["description"],"additionalProperties":false},"maxItems":500}},"additionalProperties":false,"isRequired":true,"uniqueKey":"display.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"display","typeLabel":"object | null"},"paymentChain":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"paymentChain.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"paymentChain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentChain","typeLabel":"string | null"},"paymentAddress":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"paymentAddress.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"paymentAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentAddress","typeLabel":"string | null"},"brlSettledAmount":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"brlSettledAmount.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"brlSettledAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"brlSettledAmount","typeLabel":"string | null"},"fxRateAtSettlement":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"fxRateAtSettlement.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"fxRateAtSettlement.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fxRateAtSettlement","typeLabel":"string | null"},"expiresAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"expiresAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expiresAt","typeLabel":"string | null"},"cancelReason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"cancelReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"cancelReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cancelReason","typeLabel":"string | null"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"affiliate":{"oneOf":[{"type":"object","properties":{"connectedAccountExternalId":{"type":"string","isRequired":true,"uniqueKey":"affiliate.oneOf.0.connectedAccountExternalId","typeLabel":"string"},"shareBps":{"type":"number","isRequired":true,"uniqueKey":"affiliate.oneOf.0.shareBps","typeLabel":"number"},"feeAmount":{"type":"string","isRequired":true,"uniqueKey":"affiliate.oneOf.0.feeAmount","typeLabel":"string"}},"required":["connectedAccountExternalId","shareBps","feeAmount"],"additionalProperties":false,"uniqueKey":"affiliate.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"connectedAccountExternalId":{"type":"string"},"shareBps":{"type":"number"},"feeAmount":{"type":"string"}},"required":["connectedAccountExternalId","shareBps","feeAmount"],"additionalProperties":false,"uniqueKey":"affiliate.oneOf.1","typeLabel":"null"}],"uniqueKey":"affiliate","typeLabel":"object | null"}},"required":["id","externalId","status","amount","currency","hostedPaymentUrl","buyer","returnUrl","metadata","display","paymentChain","paymentAddress","brlSettledAmount","fxRateAtSettlement","expiresAt","cancelReason","createdAt","updatedAt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"id":"ckxinv042","externalId":"INV-2026-00042","status":"awaiting_buyer","amount":"12500.00","currency":"USD","hostedPaymentUrl":"https://pay.caratuva.com/i/ckpub042","buyer":{"id":"ckbuy001","email":"buyer@acme.com","name":"ACME Imports LLC","country":"US","kycStatus":"not_started"},"returnUrl":"https://shop.example.com/orders/42/return","metadata":{"orderId":"order_42","source":"storefront"},"display":{"title":"Order #42 — green coffee, 18t","lineItems":[{"description":"Green coffee, 18t","quantity":"1","unitPrice":"12500.00","subtotal":"12500.00"}]},"paymentChain":"base","paymentAddress":"0x5fbe…a91c","brlSettledAmount":null,"fxRateAtSettlement":null,"expiresAt":null,"cancelReason":null,"createdAt":"2026-06-30T12:00:00.000Z","updatedAt":"2026-06-30T12:00:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"0f6cfcf7-a013-4c9f-8629-36932839bdce":{"description":"NotFound — No payment with that id or externalId for your org.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":404,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"NotFound","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"No payment with that id or externalId for your org.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"error":"NotFound","message":"No payment with that id or externalId for your org."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"11382052-de86-46ff-9a59-14aae5facf4d":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]}},"3cd8463e-03da-426f-8c5d-f01a1fb7a095":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"},{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"https://api.caratuva.com/docs-json"},"subdomain":"pavezisoftware","siteName":"Caratuva","title":"Get a payment - Caratuva","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/payments/get-a-payment","matchLevel":0},"pt-BR":{"href":"/api-reference/payments/get-a-payment","matchLevel":0}}},"lastModified":"2026-07-07T01:41:07.667Z","originalFileLocation":"api-reference/payments/get-a-payment.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Fetch a payment by Caratuva\u0026#x27;s internal id or by your own key prefixed with ext_ (e.g. ext_INV-2026-00042) — convenient when you only store your own primary key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Caratuva\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/svg+xml\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/favicon.svg\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a payment - Caratuva\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch a payment by Caratuva\u0026#x27;s internal id or by your own key prefixed with ext_ (e.g. ext_INV-2026-00042) — convenient when you only store your own primary key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Caratuva\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.caratuva.com/api-reference/payments/get-a-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pavezisoftware.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Get+a+payment\u0026amp;description=Fetch+a+payment+by+Caratuva%27s+internal+id+or+by+your+own+key+prefixed+with+%60ext_%60+%28e.g.+%60ext_INV-2026-00042%60%29+%E2%80%94+convenient+when+you+only+store+your+own+primary+\u0026amp;theme=4451605dc365fc6b8cecb93b\u0026amp;signature=71c18f8bc1d35cf1cf6f76bb0b2f0e06c175a7d99f6c2beee7cc788489e8d8ef\">\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 - Caratuva\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch a payment by Caratuva\u0026#x27;s internal id or by your own key prefixed with ext_ (e.g. ext_INV-2026-00042) — convenient when you only store your own primary key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pavezisoftware.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Get+a+payment\u0026amp;description=Fetch+a+payment+by+Caratuva%27s+internal+id+or+by+your+own+key+prefixed+with+%60ext_%60+%28e.g.+%60ext_INV-2026-00042%60%29+%E2%80%94+convenient+when+you+only+store+your+own+primary+\u0026amp;theme=4451605dc365fc6b8cecb93b\u0026amp;signature=71c18f8bc1d35cf1cf6f76bb0b2f0e06c175a7d99f6c2beee7cc788489e8d8ef\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/pavezisoftware/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Caratuva\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F766E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.caratuva.com/api-reference/payments/get-a-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/payments/get-a-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.caratuva.com/#organization\",\"name\":\"Caratuva\",\"url\":\"https://docs.caratuva.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.caratuva.com#website\",\"name\":\"Caratuva\",\"url\":\"https://docs.caratuva.com\",\"publisher\":{\"@id\":\"https://docs.caratuva.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.caratuva.com/api-reference/payments/get-a-payment#webpage\",\"url\":\"https://docs.caratuva.com/api-reference/payments/get-a-payment\",\"name\":\"Get a payment\",\"description\":\"Fetch a payment by Caratuva's internal id or by your own key prefixed with ext_ (e.g. ext_INV-2026-00042) — convenient when you only store your own primary key.\",\"dateModified\":\"2026-07-07T01:41:07.667Z\",\"isPartOf\":{\"@id\":\"https://docs.caratuva.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.caratuva.com/api-reference/payments/get-a-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.caratuva.com/api-reference/payments/get-a-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.caratuva.com/api-reference/invoices/list-invoices-for-the-caller-organization-cursor-paginated\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payments\",\"item\":\"https://docs.caratuva.com/api-reference/payments/create-a-payment\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a payment\",\"item\":\"https://docs.caratuva.com/api-reference/payments/get-a-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.caratuva.com/api-reference/payments/get-a-payment#apireference\",\"headline\":\"Get a payment\",\"name\":\"Get a payment\",\"description\":\"Fetch a payment by Caratuva's internal id or by your own key prefixed with ext_ (e.g. ext_INV-2026-00042) — convenient when you only store your own primary key.\",\"url\":\"https://docs.caratuva.com/api-reference/payments/get-a-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.caratuva.com/api-reference/payments/get-a-payment#webpage\"},\"dateModified\":\"2026-07-07T01:41:07.667Z\",\"publisher\":{\"@id\":\"https://docs.caratuva.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.caratuva.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Caratuva\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Caratuva","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Get paid","pages":[{"title":"Get paid","href":"/getpaid/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Environments","href":"/api-reference/environments"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Integration","pages":[{"title":"B2B quickstart","href":"/api-reference/b2b-quickstart"},{"title":"API keys","href":"/api-reference/api-keys"},{"title":"Payment intents","href":"/api-reference/payment-intents"},{"title":"Sellers \u0026 buyers","href":"/api-reference/connected-accounts"},{"title":"Webhooks","href":"/api-reference/webhooks"}]},{"group":"Endpoints","pages":[{"group":"Invoices","pages":[{"title":"List invoices for the caller organization (cursor-paginated)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/invoices","href":"/api-reference/invoices/list-invoices-for-the-caller-organization-cursor-paginated"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/invoices/{id}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json patch /v1/invoices/{id}","href":"/api-reference/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/cancel","href":"/api-reference/invoices/cancel-an-invoice"},{"title":"Reassign the buyer on an invoice (useful when KYC is stuck on a consumed TOS token)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/reassign-buyer","href":"/api-reference/invoices/reassign-the-buyer-on-an-invoice-useful-when-kyc-is-stuck-on-a-consumed-tos-token"},{"title":"Invite the buyer","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/invite-buyer","href":"/api-reference/invoices/invite-the-buyer"}]},{"group":"Access","pages":[{"title":"Request production (live mode) access","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/access/request","href":"/api-reference/access/request-production-live-mode-access"},{"title":"Production-access status","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/access/status","href":"/api-reference/access/production-access-status"}]},{"group":"Payments","pages":[{"title":"Create a payment","description":"Integrator-facing: keep your own CMS and push a thin intent describing what to collect, where to settle, and what to render on the hosted buyer-portal page. Caratuva runs the payment, mandatory buyer KYC, on-chain transfer, and PIX off-ramp. Name the seller with `sellerExternalId` (a ready-to-collect connected account) and the buyer with either `buyerExternalId` (a pre-created account, KYC reused) or a `buyer` object (`email` required, KYC'd at pay-time). Send an `Idempotency-Key` header to make retries safe. Returns the `hostedPaymentUrl` to forward to your customer.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/payments","href":"/api-reference/payments/create-a-payment"},{"title":"Get a payment","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/payments/{id}","href":"/api-reference/payments/get-a-payment"},{"title":"Cancel a payment","description":"Cancel a payment before its off-ramp settles. Once funds have settled to the seller's PIX the payment can no longer be cancelled.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/payments/{id}/cancel","href":"/api-reference/payments/cancel-a-payment"}]},{"group":"Accounts","pages":[{"title":"Start buyer KYC via the settlement partner","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc","href":"/api-reference/accounts/start-buyer-kyc-via-the-settlement-partner"},{"title":"Capture the buyer KYC dossier and deliver a ToS link (async)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/request-tos","href":"/api-reference/accounts/capture-the-buyer-kyc-dossier-and-deliver-a-tos-link-async"},{"title":"Mint a settlement-partner ToS-acceptance session URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-session","href":"/api-reference/accounts/mint-a-settlement-partner-tos-acceptance-session-url"},{"title":"Record the ToS acceptance returned in the redirect","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-accepted","href":"/api-reference/accounts/record-the-tos-acceptance-returned-in-the-redirect"},{"title":"Mint a one-shot signed upload URL for a KYC file","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/upload-url","href":"/api-reference/accounts/mint-a-one-shot-signed-upload-url-for-a-kyc-file"},{"title":"Get latest buyer KYC submission","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/buyer-kyc/{buyerId}","href":"/api-reference/accounts/get-latest-buyer-kyc-submission"},{"title":"List connected accounts (cursor-paginated)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts","href":"/api-reference/accounts/list-connected-accounts-cursor-paginated"},{"title":"Create a connected account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts","href":"/api-reference/accounts/create-a-connected-account"},{"title":"Get your own (the integrator's) account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self","href":"/api-reference/accounts/get-your-own-the-integrators-account"},{"title":"Get your own PIX payout configuration","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self/payout-config","href":"/api-reference/accounts/get-your-own-pix-payout-configuration"},{"title":"Register your own (the integrator's) PIX payout destination","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json put /v1/accounts/self/payout-config","href":"/api-reference/accounts/register-your-own-the-integrators-pix-payout-destination"},{"title":"Get your own full bank-account details (live)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self/payout-config/details","href":"/api-reference/accounts/get-your-own-full-bank-account-details-live"},{"title":"Get a connected account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/{id}","href":"/api-reference/accounts/get-a-connected-account"},{"title":"Mint a ToS-acceptance session URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/tos-session","href":"/api-reference/accounts/mint-a-tos-acceptance-session-url"},{"title":"Record a ToS acceptance","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/tos-accepted","href":"/api-reference/accounts/record-a-tos-acceptance"},{"title":"Mint a signed document upload URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/upload-url","href":"/api-reference/accounts/mint-a-signed-document-upload-url"},{"title":"Submit the end client for verification","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/submit","href":"/api-reference/accounts/submit-the-end-client-for-verification"},{"title":"Register a seller's PIX payout destination","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/payout-config","href":"/api-reference/accounts/register-a-sellers-pix-payout-destination"},{"title":"Finish onboarding: capture submission and deliver a ToS link to the seller","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/request-tos","href":"/api-reference/accounts/finish-onboarding:-capture-submission-and-deliver-a-tos-link-to-the-seller"},{"title":"Recover a stalled onboarding: re-send the ToS acceptance link","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/resend-tos","href":"/api-reference/accounts/recover-a-stalled-onboarding:-re-send-the-tos-acceptance-link"},{"title":"Retry the provider submission for a customer whose ToS is accepted but whose receiver was never created","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/retry-submit","href":"/api-reference/accounts/retry-the-provider-submission-for-a-customer-whose-tos-is-accepted-but-whose-receiver-was-never-created"},{"title":"List customers (connected accounts + payers)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/customers","href":"/api-reference/accounts/list-customers-connected-accounts-+-payers"},{"title":"Get a payer (self-signup buyer) detail","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/customers/payer/{id}","href":"/api-reference/accounts/get-a-payer-self-signup-buyer-detail"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions for this org","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/webhooks","href":"/api-reference/webhooks/list-webhook-subscriptions-for-this-org"},{"title":"Create an outbound webhook subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/webhooks","href":"/api-reference/webhooks/create-an-outbound-webhook-subscription"},{"title":"Soft-delete a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/soft-delete-a-webhook-subscription"},{"title":"List recent delivery attempts for a subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-recent-delivery-attempts-for-a-subscription"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"}]},{"group":"Reports","pages":[{"title":"Transfer-pricing report (JSON) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing","href":"/api-reference/reports/transfer-pricing-report-json-for-the-given-quarter"},{"title":"Transfer-pricing report (CSV) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing.csv","href":"/api-reference/reports/transfer-pricing-report-csv-for-the-given-quarter"},{"title":"Transfer-pricing report (PDF) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing.pdf","href":"/api-reference/reports/transfer-pricing-report-pdf-for-the-given-quarter"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json delete /v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-an-api-key"}]}]}]}]},{"language":"pt-BR","tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR/introduction"}]},{"tab":"Receba","pages":[{"title":"Receba","href":"/pt-BR/getpaid/introduction"}]},{"tab":"Referência da API","groups":[{"group":"Visão geral","pages":[{"title":"Visão geral da API","href":"/pt-BR/api-reference/introduction"},{"title":"Autenticação","href":"/pt-BR/api-reference/authentication"},{"title":"Ambientes","href":"/pt-BR/api-reference/environments"},{"title":"Erros","href":"/pt-BR/api-reference/errors"}]},{"group":"Integração","pages":[{"title":"Início rápido B2B","href":"/pt-BR/api-reference/b2b-quickstart"},{"title":"Chaves de API","href":"/pt-BR/api-reference/api-keys"},{"title":"Payment intents","href":"/pt-BR/api-reference/payment-intents"},{"title":"Vendedores e compradores","href":"/pt-BR/api-reference/connected-accounts"},{"title":"Webhooks","href":"/pt-BR/api-reference/webhooks"}]},{"group":"Endpoints","pages":[{"group":"Invoices","pages":[{"title":"List invoices for the caller organization (cursor-paginated)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/invoices","href":"/api-reference/invoices/list-invoices-for-the-caller-organization-cursor-paginated"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/invoices/{id}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json patch /v1/invoices/{id}","href":"/api-reference/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/cancel","href":"/api-reference/invoices/cancel-an-invoice"},{"title":"Reassign the buyer on an invoice (useful when KYC is stuck on a consumed TOS token)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/reassign-buyer","href":"/api-reference/invoices/reassign-the-buyer-on-an-invoice-useful-when-kyc-is-stuck-on-a-consumed-tos-token"},{"title":"Invite the buyer","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/invoices/{id}/invite-buyer","href":"/api-reference/invoices/invite-the-buyer"}]},{"group":"Access","pages":[{"title":"Request production (live mode) access","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/access/request","href":"/api-reference/access/request-production-live-mode-access"},{"title":"Production-access status","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/access/status","href":"/api-reference/access/production-access-status"}]},{"group":"Payments","pages":[{"title":"Create a payment","description":"Integrator-facing: keep your own CMS and push a thin intent describing what to collect, where to settle, and what to render on the hosted buyer-portal page. Caratuva runs the payment, mandatory buyer KYC, on-chain transfer, and PIX off-ramp. Name the seller with `sellerExternalId` (a ready-to-collect connected account) and the buyer with either `buyerExternalId` (a pre-created account, KYC reused) or a `buyer` object (`email` required, KYC'd at pay-time). Send an `Idempotency-Key` header to make retries safe. Returns the `hostedPaymentUrl` to forward to your customer.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/payments","href":"/api-reference/payments/create-a-payment"},{"title":"Get a payment","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/payments/{id}","href":"/api-reference/payments/get-a-payment"},{"title":"Cancel a payment","description":"Cancel a payment before its off-ramp settles. Once funds have settled to the seller's PIX the payment can no longer be cancelled.","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/payments/{id}/cancel","href":"/api-reference/payments/cancel-a-payment"}]},{"group":"Accounts","pages":[{"title":"Start buyer KYC via the settlement partner","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc","href":"/api-reference/accounts/start-buyer-kyc-via-the-settlement-partner"},{"title":"Capture the buyer KYC dossier and deliver a ToS link (async)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/request-tos","href":"/api-reference/accounts/capture-the-buyer-kyc-dossier-and-deliver-a-tos-link-async"},{"title":"Mint a settlement-partner ToS-acceptance session URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-session","href":"/api-reference/accounts/mint-a-settlement-partner-tos-acceptance-session-url"},{"title":"Record the ToS acceptance returned in the redirect","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-accepted","href":"/api-reference/accounts/record-the-tos-acceptance-returned-in-the-redirect"},{"title":"Mint a one-shot signed upload URL for a KYC file","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/upload-url","href":"/api-reference/accounts/mint-a-one-shot-signed-upload-url-for-a-kyc-file"},{"title":"Get latest buyer KYC submission","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/buyer-kyc/{buyerId}","href":"/api-reference/accounts/get-latest-buyer-kyc-submission"},{"title":"List connected accounts (cursor-paginated)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts","href":"/api-reference/accounts/list-connected-accounts-cursor-paginated"},{"title":"Create a connected account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts","href":"/api-reference/accounts/create-a-connected-account"},{"title":"Get your own (the integrator's) account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self","href":"/api-reference/accounts/get-your-own-the-integrators-account"},{"title":"Get your own PIX payout configuration","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self/payout-config","href":"/api-reference/accounts/get-your-own-pix-payout-configuration"},{"title":"Register your own (the integrator's) PIX payout destination","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json put /v1/accounts/self/payout-config","href":"/api-reference/accounts/register-your-own-the-integrators-pix-payout-destination"},{"title":"Get your own full bank-account details (live)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/self/payout-config/details","href":"/api-reference/accounts/get-your-own-full-bank-account-details-live"},{"title":"Get a connected account","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/accounts/{id}","href":"/api-reference/accounts/get-a-connected-account"},{"title":"Mint a ToS-acceptance session URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/tos-session","href":"/api-reference/accounts/mint-a-tos-acceptance-session-url"},{"title":"Record a ToS acceptance","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/tos-accepted","href":"/api-reference/accounts/record-a-tos-acceptance"},{"title":"Mint a signed document upload URL","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/upload-url","href":"/api-reference/accounts/mint-a-signed-document-upload-url"},{"title":"Submit the end client for verification","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/submit","href":"/api-reference/accounts/submit-the-end-client-for-verification"},{"title":"Register a seller's PIX payout destination","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/payout-config","href":"/api-reference/accounts/register-a-sellers-pix-payout-destination"},{"title":"Finish onboarding: capture submission and deliver a ToS link to the seller","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/request-tos","href":"/api-reference/accounts/finish-onboarding:-capture-submission-and-deliver-a-tos-link-to-the-seller"},{"title":"Recover a stalled onboarding: re-send the ToS acceptance link","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/resend-tos","href":"/api-reference/accounts/recover-a-stalled-onboarding:-re-send-the-tos-acceptance-link"},{"title":"Retry the provider submission for a customer whose ToS is accepted but whose receiver was never created","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/accounts/{id}/retry-submit","href":"/api-reference/accounts/retry-the-provider-submission-for-a-customer-whose-tos-is-accepted-but-whose-receiver-was-never-created"},{"title":"List customers (connected accounts + payers)","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/customers","href":"/api-reference/accounts/list-customers-connected-accounts-+-payers"},{"title":"Get a payer (self-signup buyer) detail","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/customers/payer/{id}","href":"/api-reference/accounts/get-a-payer-self-signup-buyer-detail"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions for this org","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/webhooks","href":"/api-reference/webhooks/list-webhook-subscriptions-for-this-org"},{"title":"Create an outbound webhook subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/webhooks","href":"/api-reference/webhooks/create-an-outbound-webhook-subscription"},{"title":"Soft-delete a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/soft-delete-a-webhook-subscription"},{"title":"List recent delivery attempts for a subscription","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-recent-delivery-attempts-for-a-subscription"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"}]},{"group":"Reports","pages":[{"title":"Transfer-pricing report (JSON) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing","href":"/api-reference/reports/transfer-pricing-report-json-for-the-given-quarter"},{"title":"Transfer-pricing report (CSV) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing.csv","href":"/api-reference/reports/transfer-pricing-report-csv-for-the-given-quarter"},{"title":"Transfer-pricing report (PDF) for the given quarter","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/reports/transfer-pricing.pdf","href":"/api-reference/reports/transfer-pricing-report-pdf-for-the-given-quarter"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://api.caratuva.com/docs-json delete /v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-an-api-key"}]}]}]}]}]},"title":"Get a payment - Caratuva","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}