{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Heyrafiki","description":"Reference and integration guidance for the Heyrafiki API, Sandbox, insurance and institutional workflows.","colors":{"primary":"#184A34","light":"#56C995","dark":"#3D7B5C"},"logo":{"light":"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/logo-black.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=adad3843b7b770dddb62d8d2a7095272","dark":"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/logo-white.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=9d24495fb1c9d7a5cd24d6dd106b5641","href":"/"},"favicon":{"light":"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/mark-black.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=4cf99d03241c11cfedcf0eef01032b16","dark":"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/mark-white.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=01bf7726e0bcffdad1248183ae626074"},"api":{"openapi":"openapi/heyrafiki.openapi.yaml","playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["bash","javascript","python","go"],"prefill":true,"autogenerate":true}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"https://heyrafiki.space","label":"Website"}],"primary":{"type":"button","label":"Request access","href":"https://heyrafiki.space/waitlist"}},"footer":{"socials":{"website":"https://heyrafiki.space","github":"https://github.com/heyrafiki","linkedin":"https://www.linkedin.com/company/heyrafiki","x":"https://x.com/heyrafikios","instagram":"https://www.instagram.com/heyrafikios"}},"search":{"prompt":"Search Heyrafiki Docs"},"seo":{"metatags":{"canonical":"https://docs.heyrafiki.space","og:locale":"en_KE"},"indexing":"navigable"},"fonts":{"heading":{"family":"Instrument Sans"},"body":{"family":"Instrument Sans"}},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heyrafiki","hasAudioNarration":false,"actualSubdomain":"heyrafiki","customDomains":["docs.heyrafiki.space"],"gitSource":{"type":"github","owner":"heyrafiki","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"84349ba1-a84d-4fd5-a07c-7cc15d884561","liveDeploymentHistoryId":"6a98f97431118af9857677b0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a98f97431118af9857677b0"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a98f97431118af9857677b0","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API reference","count":34},{"language":"default","tag":"REST API","count":34},{"language":"default","tag":"Build","count":12},{"language":"default","tag":"Institutions","count":8},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Insurance","count":6},{"language":"default","tag":"Integration tools","count":5},{"language":"default","tag":"Institutional integration","count":4},{"language":"default","tag":"Integration assurance","count":4},{"language":"default","tag":"Payer workflows","count":2}],"searchSettings":{"isFiltersEnabled":true,"maxResults":10,"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"hello@heyrafiki.space"}},"basePath":"","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":"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":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--hr-brand:#184a34;--hr-brand-soft:color-mix(in srgb, var(--hr-brand) 34%, transparent)}#content-area h1,article h1{font-size:1.78rem;line-height:1.15;letter-spacing:-.03em;font-weight:600}#content-area h2,article h2{font-size:1.14rem;line-height:1.25;letter-spacing:-.02em;font-weight:600;margin-top:2.25rem}#content-area h3,article h3{font-size:.98rem;line-height:1.3;letter-spacing:-.015em;font-weight:600}#content-area li,#content-area p,article li,article p{font-size:.93rem;line-height:1.7}#content-area>div:first-child p:first-of-type{font-size:.98rem}#content-area table,article table{font-size:.84rem}#content-area th,article th{font-weight:600;letter-spacing:.01em}#content-area code,article code{font-size:.82rem}#content-area pre code,article pre code{font-size:.8rem;line-height:1.6}#content-area .card h2,#content-area .card h3{font-size:.91rem;margin-top:0}#content-area tbody tr:nth-child(even),article tbody tr:nth-child(even){background:color-mix(in srgb,var(--hr-brand) 3%,transparent)}#content-area a,#content-area button,article a,article button{text-underline-offset:.18em}#content-area [role=tablist],article [role=tablist]{column-gap:.75rem!important;padding-inline:.25rem;scrollbar-color:var(--hr-brand-soft) transparent;scrollbar-width:thin}#content-area [role=tablist]::-webkit-scrollbar,article [role=tablist]::-webkit-scrollbar{height:.25rem}#content-area [role=tablist]::-webkit-scrollbar-track,article [role=tablist]::-webkit-scrollbar-track{background:0 0}#content-area [role=tablist]::-webkit-scrollbar-thumb,article [role=tablist]::-webkit-scrollbar-thumb{background:var(--hr-brand-soft);border-radius:999px}#content-area [role=tablist] button,article [role=tablist] button{font-size:.78rem;white-space:nowrap}#content-area [role=tablist] button:focus-visible,article [role=tablist] button:focus-visible{outline:2px solid color-mix(in srgb,var(--hr-brand) 72%,white);outline-offset:2px}@media (min-width:48rem){#content-area [role=tablist],article [role=tablist]{column-gap:1rem!important}}"}],"page":{"pagePath":"api-reference/retrieve-a-remittance","slug":"/api-reference/retrieve-a-remittance","pageMetadata":{"title":"Retrieve a remittance","description":"Returns one project-scoped remittance. Requires `remittances:read`.","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /remittances/{remittance_id}","href":"/api-reference/retrieve-a-remittance","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: [\"Returns one project-scoped remittance. Requires \", _jsx(_components.code, {\n children: \"remittances:read\"\n }), \".\"]\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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Retrieve a remittance","description":"Returns one project-scoped remittance. Requires `remittances:read`.","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /remittances/{remittance_id}","href":"/api-reference/retrieve-a-remittance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/heyrafiki/3adcae0af99d46fb/legacy-domain-redirect.js"],"openApiReferenceData":{"operation":{"operationId":"getRemittance","summary":"Retrieve a remittance","description":"Returns one project-scoped remittance. Requires `remittances:read`.","parameters":["bc05a1ec-afb4-40fc-9fec-a5329439cfdb"],"responses":{"200":"6009be04-4f05-48c2-a3b7-aa8ea21dedbf","400":"378d5ecb-ff9a-4b48-b849-3825dcd7f7ac","401":"58a23e9d-c4f4-49c8-814d-ca3a7afcf2c4","403":"682bf0b7-79f1-4cb3-99a1-e34495452d79","404":"e168135e-45c7-411c-9a84-1d1a009205b2","429":"453a6aca-662c-4c1e-bd07-16d2a12f9e0f","503":"9a24cf5b-090e-4991-a006-825fddb27f92"},"method":"get","type":"path","servers":["205aa400-3d09-41ea-9e0f-e980a31088ea"],"security":["86494d2d-1144-4d2f-8ad9-2b59f577d19d","9d45a79f-700a-4daa-9635-034a1dbd0845"],"path":"/remittances/{remittance_id}","baseUrlOptions":["https://api.heyrafiki.space/v1"],"title":"Retrieve a remittance","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"bc05a1ec-afb4-40fc-9fec-a5329439cfdb":{"name":"remittance_id","in":"path","required":true,"description":"A public remittance identifier.","schema":{"type":"string","maxLength":100,"pattern":"^rem_[A-Za-z0-9_-]+$","isRequired":true,"description":"A public remittance identifier.","uniqueKey":"","typeLabel":"string"}}},"responses":{"6009be04-4f05-48c2-a3b7-aa8ea21dedbf":{"description":"A remittance","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["id","object","status","payer_reference","amount","allocations","received_at","reconciled_at"],"properties":{"id":{"type":"string","pattern":"^rem_[A-Za-z0-9_-]+$","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","const":"remittance","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"status":{"type":"string","enum":["received","reconciled","exception"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"payer_reference":{"type":"string","isRequired":true,"uniqueKey":"payer_reference","typeLabel":"string"},"amount":{"type":"object","additionalProperties":false,"required":["currency","paid"],"properties":{"currency":{"type":"string","pattern":"^[A-Z]{3}$","isRequired":true,"uniqueKey":"amount.currency","typeLabel":"string"},"paid":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"amount.paid","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"amount","typeLabel":"object"},"allocations":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["claim_id","paid_amount","reason_codes"],"properties":{"claim_id":{"type":"string","pattern":"^clm_[A-Za-z0-9_-]+$","isRequired":true,"uniqueKey":"allocations.items.[INDEX].claim_id","typeLabel":"string"},"paid_amount":{"type":"integer","minimum":1,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"allocations.items.[INDEX].paid_amount","typeLabel":"integer"},"reason_codes":{"type":"array","maxItems":16,"items":{"type":"string","pattern":"^[a-z0-9_]+$","uniqueKey":"allocations.items.[INDEX].reason_codes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"allocations.items.[INDEX].reason_codes","typeLabel":"string[]"}},"uniqueKey":"allocations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"allocations","typeLabel":"object[]"},"received_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"received_at","typeLabel":"string\u003cdate-time>"},"reconciled_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"reconciled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"reconciled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reconciled_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","object":"remittance","status":"received","payer_reference":"\u003cstring>","amount":{"currency":"\u003cstring>","paid":2},"allocations":[{"claim_id":"\u003cstring>","paid_amount":4503599627370496,"reason_codes":["\u003cstring>"]}],"received_at":"2023-11-07T05:31:56Z","reconciled_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"378d5ecb-ff9a-4b48-b849-3825dcd7f7ac":{"description":"The request failed validation.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"58a23e9d-c4f4-49c8-814d-ca3a7afcf2c4":{"description":"The API key is missing or invalid.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"682bf0b7-79f1-4cb3-99a1-e34495452d79":{"description":"The API key does not permit this operation.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e168135e-45c7-411c-9a84-1d1a009205b2":{"description":"The requested resource does not exist or is not visible to this project.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"453a6aca-662c-4c1e-bd07-16d2a12f9e0f":{"description":"The project exceeded its request limit.","headers":{"Retry-After":{"description":"Seconds until another request should be attempted.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp when the current limit resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9a24cf5b-090e-4991-a006-825fddb27f92":{"description":"The service is temporarily unavailable.","headers":{"Retry-After":{"schema":{"type":"integer","example":5}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","docs"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"docs":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"error.docs","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","docs":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"86494d2d-1144-4d2f-8ad9-2b59f577d19d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A sandbox or production secret key.","scopes":[]}},"9d45a79f-700a-4daa-9635-034a1dbd0845":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"An alternative for clients that cannot set Authorization.","scopes":[]}}},"servers":{"205aa400-3d09-41ea-9e0f-e980a31088ea":{"url":"https://api.heyrafiki.space/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A sandbox or production secret key.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A sandbox or production secret key.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"An alternative for clients that cannot set Authorization.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"An alternative for clients that cannot set Authorization.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"openapi/heyrafiki.openapi.yaml"},"subdomain":"heyrafiki","siteName":"Heyrafiki","title":"Retrieve a remittance - Heyrafiki","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-10T15:07:05.289Z","originalFileLocation":"api-reference/retrieve-a-remittance.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns one project-scoped remittance. Requires remittances:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heyrafiki\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_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/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heyrafiki/6pLNsXzfdQKPtWLt/_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/heyrafiki/6pLNsXzfdQKPtWLt/_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/heyrafiki/6pLNsXzfdQKPtWLt/_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/heyrafiki/6pLNsXzfdQKPtWLt/_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/heyrafiki/6pLNsXzfdQKPtWLt/_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/heyrafiki/6pLNsXzfdQKPtWLt/_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/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a remittance - Heyrafiki\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one project-scoped remittance. Requires remittances:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heyrafiki\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://heyrafiki.mintlify.app/_mintlify/api/og/v2?division=REST+API\u0026amp;title=Retrieve+a+remittance\u0026amp;description=Returns+one+project-scoped+remittance.+Requires+%60remittances%3Aread%60.\u0026amp;theme=21d32e2b607e525eebaffa65\u0026amp;signature=be8d41ab7bec5546d3853c940e2a65ab29c4dcfcc04ac533af72204885d760a4\">\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=\"Retrieve a remittance - Heyrafiki\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one project-scoped remittance. Requires remittances:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://heyrafiki.mintlify.app/_mintlify/api/og/v2?division=REST+API\u0026amp;title=Retrieve+a+remittance\u0026amp;description=Returns+one+project-scoped+remittance.+Requires+%60remittances%3Aread%60.\u0026amp;theme=21d32e2b607e525eebaffa65\u0026amp;signature=be8d41ab7bec5546d3853c940e2a65ab29c4dcfcc04ac533af72204885d760a4\">\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/heyrafiki/6pLNsXzfdQKPtWLt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heyrafiki\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#184A34\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_KE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/retrieve-a-remittance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.heyrafiki.space/#organization\",\"name\":\"Heyrafiki\",\"url\":\"https://docs.heyrafiki.space\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/heyrafiki/VzWzD9yh2LbdjA9G/images/logo-black.png?fit=max\u0026auto=format\u0026n=VzWzD9yh2LbdjA9G\u0026q=85\u0026s=adad3843b7b770dddb62d8d2a7095272\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heyrafiki.space#website\",\"name\":\"Heyrafiki\",\"url\":\"https://docs.heyrafiki.space\",\"publisher\":{\"@id\":\"https://docs.heyrafiki.space/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance#webpage\",\"url\":\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance\",\"name\":\"Retrieve a remittance\",\"description\":\"Returns one project-scoped remittance. Requires remittances:read.\",\"dateModified\":\"2026-08-10T15:07:05.289Z\",\"isPartOf\":{\"@id\":\"https://docs.heyrafiki.space#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API\",\"item\":\"https://docs.heyrafiki.space/resources\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a remittance\",\"item\":\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance#apireference\",\"headline\":\"Retrieve a remittance\",\"name\":\"Retrieve a remittance\",\"description\":\"Returns one project-scoped remittance. Requires remittances:read.\",\"url\":\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heyrafiki.space/api-reference/retrieve-a-remittance#webpage\"},\"dateModified\":\"2026-08-10T15:07:05.289Z\",\"publisher\":{\"@id\":\"https://docs.heyrafiki.space/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heyrafiki.space#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heyrafiki\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Heyrafiki","nav":{"global":null,"tabs":[{"tab":"Build","icon":"code","pages":[{"title":"Build","href":""}]},{"tab":"Insurance","icon":"shield-check","pages":[{"title":"Insurance","href":"/benefits"}]},{"tab":"Institutions","icon":"landmark","pages":[{"title":"Institutions","href":"/concepts/institutions"}]},{"tab":"API reference","icon":"brackets-curly","groups":[{"group":"REST API","pages":[{"title":"API overview","sidebarTitle":"Overview","href":"/resources"},{"title":"Inspect the API version and environment","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /","href":"/api-reference/inspect-the-api-version-and-environment"},{"title":"List Practitioners","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /practitioners","href":"/api-reference/list-practitioners"},{"title":"Retrieve a Practitioner","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /practitioners/{practitioner_id}","href":"/api-reference/retrieve-a-practitioner"},{"title":"Retrieve Practitioner availability","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /practitioners/{practitioner_id}/availability","href":"/api-reference/retrieve-practitioner-availability"},{"title":"List Bookings","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /bookings","href":"/api-reference/list-bookings"},{"title":"Create a Booking","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /bookings","href":"/api-reference/create-a-booking"},{"title":"Retrieve a Booking","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /bookings/{booking_id}","href":"/api-reference/retrieve-a-booking"},{"title":"List Sessions","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /sessions","href":"/api-reference/list-sessions"},{"title":"Retrieve a Session","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /sessions/{session_id}","href":"/api-reference/retrieve-a-session"},{"title":"Record a Coverage observation","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /coverages","href":"/api-reference/record-a-coverage-observation"},{"title":"Record a Coverage batch","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /coverage_batches","href":"/api-reference/record-a-coverage-batch"},{"title":"Check Benefit eligibility","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /eligibility_checks","href":"/api-reference/check-benefit-eligibility"},{"title":"Retrieve an eligibility check","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /eligibility_checks/{eligibility_check_id}","href":"/api-reference/retrieve-an-eligibility-check"},{"title":"Request a pre-authorization","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /preauthorizations","href":"/api-reference/request-a-pre-authorization"},{"title":"Retrieve a pre-authorization","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /preauthorizations/{preauthorization_id}","href":"/api-reference/retrieve-a-pre-authorization"},{"title":"Decide a pre-authorization","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /preauthorizations/{preauthorization_id}/decisions","href":"/api-reference/decide-a-pre-authorization"},{"title":"List Claims","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /claims","href":"/api-reference/list-claims"},{"title":"Submit a Claim","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /claims","href":"/api-reference/submit-a-claim"},{"title":"Retrieve a Claim","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /claims/{claim_id}","href":"/api-reference/retrieve-a-claim"},{"title":"Reproduce a Claim valuation","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /claims/{claim_id}/valuation","href":"/api-reference/reproduce-a-claim-valuation"},{"title":"Request Claim information","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /claims/{claim_id}/information_requests","href":"/api-reference/request-claim-information"},{"title":"Submit Claim evidence","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /claims/{claim_id}/evidence","href":"/api-reference/submit-claim-evidence"},{"title":"Adjudicate a Claim","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /claims/{claim_id}/adjudications","href":"/api-reference/adjudicate-a-claim"},{"title":"List remittances","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /remittances","href":"/api-reference/list-remittances"},{"title":"Record a remittance","description":"Allocates payer remittance advice to adjudicated Claims without recording payment settlement. Requires `remittances:write`.","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /remittances","href":"/api-reference/record-a-remittance"},{"title":"Retrieve a remittance","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /remittances/{remittance_id}","href":"/api-reference/retrieve-a-remittance"},{"title":"List Webhook endpoints","description":"Returns Webhook endpoints for the authenticated project. Requires `webhooks:read`.","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /webhook_endpoints","href":"/api-reference/list-webhook-endpoints"},{"title":"Create a Webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /webhook_endpoints","href":"/api-reference/create-a-webhook-endpoint"},{"title":"Retrieve a Webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml get /webhook_endpoints/{webhook_endpoint_id}","href":"/api-reference/retrieve-a-webhook-endpoint"},{"title":"Disable a Webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml delete /webhook_endpoints/{webhook_endpoint_id}","href":"/api-reference/disable-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi/heyrafiki.openapi.yaml post /webhook_endpoints/{webhook_endpoint_id}/test","href":"/api-reference/send-a-test-event"},{"title":"Rate limits","href":"/rate-limits"},{"title":"Versioning","href":"/versioning"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Retrieve a remittance - Heyrafiki","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}