Quando o cliente informou estar em processo de superendividamento (Lei 14.181/2021). Enquanto preenchido, toda a cobrança dele fica pausada; só um administrador retoma.
Quem ouviu: o agente do WhatsApp (agent) ou o de voz (voice).
Available options:
agent,
voice
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Payable API","description":"Payable API documentation: automate collections with clients, debts, webhooks and AI voice calls.","colors":{"primary":"#16A34A","light":"#22C55E","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/revn-tech/8G10Lg5IuW978AYn/logo/light.svg?fit=max\u0026auto=format\u0026n=8G10Lg5IuW978AYn\u0026q=85\u0026s=3e82d847494f2f6241a880396cafd9a1","dark":"https://mintcdn.com/revn-tech/8G10Lg5IuW978AYn/logo/dark.svg?fit=max\u0026auto=format\u0026n=8G10Lg5IuW978AYn\u0026q=85\u0026s=fa2691180a5d0c0ed5683d50e12a88b5"},"favicon":"https://mintcdn.com/revn-tech/8G10Lg5IuW978AYn/favicon.svg?fit=max\u0026auto=format\u0026n=8G10Lg5IuW978AYn\u0026q=85\u0026s=09603fbebf7fab4ca93ff94a1f838998","api":{"openapi":"openapi.json"},"navbar":{"links":[{"href":"https://app.payable.run","label":"Dashboard"}]},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"introduction"},{"language":"pt-BR","href":"pt-BR/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"revn-tech","hasAudioNarration":false,"actualSubdomain":"revn-tech","customDomains":["docs.payable.run"],"gitSource":{"type":"github","owner":"revn-tech","repo":"payable","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae204a78c406dd2ccb3518c","collectionId":"e1de3234-6fe2-431b-b604-11f530e3bf8e","liveDeploymentHistoryId":"6ae204a78c406dd2ccb3518c","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae204a78c406dd2ccb3518c","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API reference","count":41},{"language":"default","tag":"Clients","count":12},{"language":"default","tag":"Debts","count":12},{"language":"default","tag":"Voice calls","count":7},{"language":"en","tag":"Integrate","count":5},{"language":"pt-BR","tag":"Integração","count":5},{"language":"en","tag":"Get started","count":4},{"language":"pt-BR","tag":"Começar","count":4},{"language":"default","tag":"Webhook endpoints","count":3},{"language":"default","tag":"PIX payments","count":3},{"language":"default","tag":"Recurring charges","count":3},{"language":"en","tag":"API reference","count":1},{"language":"pt-BR","tag":"Referência da API","count":1},{"language":"default","tag":"Sandbox","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/clients/get-a-client-by-id","slug":"/api-reference/clients/get-a-client-by-id","pageMetadata":{"title":"Get a client by ID","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients/{id}","href":"/api-reference/clients/get-a-client-by-id","autogeneratedByOpenApi":true},"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 client by ID","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients/{id}","href":"/api-reference/clients/get-a-client-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"ClientController_findOne","parameters":["b5df34ae-edb1-4bac-9cc1-118700bcf3fc"],"responses":{"200":"88a5b260-d54f-41c0-83b3-51c5b8ea8519","404":"9e86b980-a5b6-4251-9d60-bf5bd8ede378","default":"51dac71d-ef27-487b-9d27-6c40c264bdb0"},"security":["961890dc-0db5-41ca-bcea-215cddc80e16"],"summary":"Get a client by ID","tags":["clients"],"method":"get","type":"path","servers":["3e7e327f-03ab-404b-a6e8-63ee95df6c74","af862650-1569-4387-b1e9-eec26d47fa47"],"path":"/api/v1/clients/{id}","baseUrlOptions":["https://api.payable.run","https://localhost:3000"],"title":"Get a client by ID","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b5df34ae-edb1-4bac-9cc1-118700bcf3fc":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"88a5b260-d54f-41c0-83b3-51c5b8ea8519":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"firstName":{"type":"string","example":"João","isRequired":true,"uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","example":"Silva","isRequired":true,"uniqueKey":"lastName","typeLabel":"string"},"phone":{"type":"string","example":"11999999999","isRequired":true,"uniqueKey":"phone","typeLabel":"string"},"organizationId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["UP_TO_DATE","OVERDUE"],"example":"OVERDUE","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"object","isRequired":true,"uniqueKey":"createdAt","typeLabel":"object"},"updatedAt":{"type":"object","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"object"},"cpf":{"oneOf":[{"type":"object","example":"12345678901","uniqueKey":"cpf.oneOf.0","typeLabel":"object"},{"type":"null","example":"12345678901","uniqueKey":"cpf.oneOf.1","typeLabel":"null"}],"uniqueKey":"cpf","typeLabel":"object | null"},"email":{"oneOf":[{"type":"object","example":"[email protected]","uniqueKey":"email.oneOf.0","typeLabel":"object"},{"type":"null","example":"[email protected]","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"object | null"},"occupation":{"oneOf":[{"type":"object","uniqueKey":"occupation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"occupation.oneOf.1","typeLabel":"null"}],"uniqueKey":"occupation","typeLabel":"object | null"},"observation":{"oneOf":[{"type":"object","uniqueKey":"observation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"observation.oneOf.1","typeLabel":"null"}],"uniqueKey":"observation","typeLabel":"object | null"},"cep":{"oneOf":[{"type":"object","uniqueKey":"cep.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"cep.oneOf.1","typeLabel":"null"}],"uniqueKey":"cep","typeLabel":"object | null"},"city":{"oneOf":[{"type":"object","uniqueKey":"city.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"city.oneOf.1","typeLabel":"null"}],"uniqueKey":"city","typeLabel":"object | null"},"neighborhood":{"oneOf":[{"type":"object","uniqueKey":"neighborhood.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"neighborhood.oneOf.1","typeLabel":"null"}],"uniqueKey":"neighborhood","typeLabel":"object | null"},"street":{"oneOf":[{"type":"object","uniqueKey":"street.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"street.oneOf.1","typeLabel":"null"}],"uniqueKey":"street","typeLabel":"object | null"},"address":{"oneOf":[{"type":"object","uniqueKey":"address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address","typeLabel":"object | null"},"streetNumber":{"oneOf":[{"type":"object","uniqueKey":"streetNumber.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"streetNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetNumber","typeLabel":"object | null"},"state":{"oneOf":[{"type":"object","example":"SP","uniqueKey":"state.oneOf.0","typeLabel":"object"},{"type":"null","example":"SP","uniqueKey":"state.oneOf.1","typeLabel":"null"}],"uniqueKey":"state","typeLabel":"object | null"},"isSandbox":{"type":"boolean","uniqueKey":"isSandbox","typeLabel":"boolean"},"debtCount":{"type":"number","uniqueKey":"debtCount","typeLabel":"number"},"totalDebtAmount":{"type":"number","uniqueKey":"totalDebtAmount","typeLabel":"number"},"outstandingAmount":{"type":"number","uniqueKey":"outstandingAmount","typeLabel":"number"},"openDebtCount":{"type":"number","uniqueKey":"openDebtCount","typeLabel":"number"},"overdueDebtCount":{"type":"number","uniqueKey":"overdueDebtCount","typeLabel":"number"},"paidDebtCount":{"type":"number","uniqueKey":"paidDebtCount","typeLabel":"number"},"nextDueDate":{"oneOf":[{"type":"object","uniqueKey":"nextDueDate.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"nextDueDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextDueDate","typeLabel":"object | null"},"channelPreferences":{"type":"object","properties":{"whatsapp":{"type":"object","properties":{"status":{"type":"string","enum":["open","pending_cancel","snoozed","opted_out"],"isRequired":true,"uniqueKey":"channelPreferences.whatsapp.status","typeLabel":"enum\u003cstring>"},"mutedUntil":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.whatsapp.mutedUntil.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.whatsapp.mutedUntil.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.whatsapp.mutedUntil","typeLabel":"object | null"},"optedOutAt":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.whatsapp.optedOutAt.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.whatsapp.optedOutAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.whatsapp.optedOutAt","typeLabel":"object | null"},"source":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.whatsapp.source.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.whatsapp.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.whatsapp.source","typeLabel":"object | null"},"reason":{"oneOf":[{"type":"string","enum":["already_paid","not_my_debt","family","new_child","high_bills","wrong_channel","stop_channel","other"],"uniqueKey":"channelPreferences.whatsapp.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["already_paid","not_my_debt","family","new_child","high_bills","wrong_channel","stop_channel","other"],"uniqueKey":"channelPreferences.whatsapp.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.whatsapp.reason","typeLabel":"enum\u003cstring> | null"},"reasonDetail":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.whatsapp.reasonDetail.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.whatsapp.reasonDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.whatsapp.reasonDetail","typeLabel":"object | null"}},"required":["status"],"isRequired":true,"uniqueKey":"channelPreferences.whatsapp","typeLabel":"object"},"email":{"type":"object","properties":{"status":{"type":"string","enum":["open","pending_cancel","snoozed","opted_out"],"isRequired":true,"uniqueKey":"channelPreferences.email.status","typeLabel":"enum\u003cstring>"},"mutedUntil":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.email.mutedUntil.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.email.mutedUntil.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.email.mutedUntil","typeLabel":"object | null"},"optedOutAt":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.email.optedOutAt.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.email.optedOutAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.email.optedOutAt","typeLabel":"object | null"},"source":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.email.source.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.email.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.email.source","typeLabel":"object | null"},"reason":{"oneOf":[{"type":"string","enum":["already_paid","not_my_debt","family","new_child","high_bills","wrong_channel","stop_channel","other"],"uniqueKey":"channelPreferences.email.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["already_paid","not_my_debt","family","new_child","high_bills","wrong_channel","stop_channel","other"],"uniqueKey":"channelPreferences.email.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.email.reason","typeLabel":"enum\u003cstring> | null"},"reasonDetail":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.email.reasonDetail.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.email.reasonDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.email.reasonDetail","typeLabel":"object | null"}},"required":["status"],"isRequired":true,"uniqueKey":"channelPreferences.email","typeLabel":"object"},"sms":{"type":"object","properties":{"status":{"type":"string","enum":["open","pending_cancel","snoozed","opted_out"],"isRequired":true,"uniqueKey":"channelPreferences.sms.status","typeLabel":"enum\u003cstring>"},"mutedUntil":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.sms.mutedUntil.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.sms.mutedUntil.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.sms.mutedUntil","typeLabel":"object | null"},"optedOutAt":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.sms.optedOutAt.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.sms.optedOutAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.sms.optedOutAt","typeLabel":"object | null"},"source":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.sms.source.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.sms.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.sms.source","typeLabel":"object | null"},"reason":{"oneOf":[{"type":"string","enum":["already_paid","not_my_debt","family","new_child","high_bills","wrong_channel","stop_channel","other"],"uniqueKey":"channelPreferences.sms.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["already_paid","not_my_debt","family","new_child","high_bills","wrong_channel","stop_channel","other"],"uniqueKey":"channelPreferences.sms.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.sms.reason","typeLabel":"enum\u003cstring> | null"},"reasonDetail":{"oneOf":[{"type":"object","uniqueKey":"channelPreferences.sms.reasonDetail.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"channelPreferences.sms.reasonDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelPreferences.sms.reasonDetail","typeLabel":"object | null"}},"required":["status"],"isRequired":true,"uniqueKey":"channelPreferences.sms","typeLabel":"object"}},"required":["whatsapp","email","sms"],"uniqueKey":"channelPreferences","typeLabel":"object"},"overIndebtednessReportedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Quando o cliente informou estar em processo de superendividamento (Lei 14.181/2021). Enquanto preenchido, toda a cobrança dele fica pausada; só um administrador retoma.","uniqueKey":"overIndebtednessReportedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Quando o cliente informou estar em processo de superendividamento (Lei 14.181/2021). Enquanto preenchido, toda a cobrança dele fica pausada; só um administrador retoma.","uniqueKey":"overIndebtednessReportedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"overIndebtednessReportedAt","typeLabel":"string\u003cdate-time> | null"},"overIndebtednessSource":{"oneOf":[{"type":"string","enum":["agent","voice"],"description":"Quem ouviu: o agente do WhatsApp (`agent`) ou o de voz (`voice`).","uniqueKey":"overIndebtednessSource.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["agent","voice"],"description":"Quem ouviu: o agente do WhatsApp (`agent`) ou o de voz (`voice`).","uniqueKey":"overIndebtednessSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"overIndebtednessSource","typeLabel":"enum\u003cstring> | null"}},"required":["id","firstName","lastName","phone","organizationId","status","createdAt","updatedAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","firstName":"João","lastName":"Silva","phone":"11999999999","organizationId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"OVERDUE","createdAt":{},"updatedAt":{},"cpf":"12345678901","email":"[email protected]","occupation":{},"observation":{},"cep":{},"city":{},"neighborhood":{},"street":{},"address":{},"streetNumber":{},"state":"SP","isSandbox":true,"debtCount":123,"totalDebtAmount":123,"outstandingAmount":123,"openDebtCount":123,"overdueDebtCount":123,"paidDebtCount":123,"nextDueDate":{},"channelPreferences":{"whatsapp":{"status":"open","mutedUntil":{},"optedOutAt":{},"source":{},"reason":"already_paid","reasonDetail":{}},"email":{"status":"open","mutedUntil":{},"optedOutAt":{},"source":{},"reason":"already_paid","reasonDetail":{}},"sms":{"status":"open","mutedUntil":{},"optedOutAt":{},"source":{},"reason":"already_paid","reasonDetail":{}}},"overIndebtednessReportedAt":"2023-11-07T05:31:56Z","overIndebtednessSource":"agent"}}},"exampleType":"generated"}},"exampleType":"generated"},"9e86b980-a5b6-4251-9d60-bf5bd8ede378":{"description":"Client not found","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","instance","code","requestId"],"properties":{"type":{"type":"string","format":"uri","example":"https://docs.payable.run/errors/validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","example":"Bad Request","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","example":"One or more request fields are invalid.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","example":"/api/v1/clients","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"requestId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003cuuid>"},"errors":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.payable.run/errors/validation_error","title":"Bad Request","status":400,"detail":"One or more request fields are invalid.","instance":"/api/v1/clients","code":"VALIDATION_ERROR","requestId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","errors":[{"message":"\u003cstring>","field":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"51dac71d-ef27-487b-9d27-6c40c264bdb0":{"description":"RFC 9457 problem details. Inspect `code` for programmatic handling.","content":{"application/problem+json":{"schema":{"type":"object","required":["type","title","status","detail","instance","code","requestId"],"properties":{"type":{"type":"string","format":"uri","example":"https://docs.payable.run/errors/validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","example":"Bad Request","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","example":"One or more request fields are invalid.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","example":"/api/v1/clients","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"requestId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003cuuid>"},"errors":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.payable.run/errors/validation_error","title":"Bad Request","status":400,"detail":"One or more request fields are invalid.","instance":"/api/v1/clients","code":"VALIDATION_ERROR","requestId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","errors":[{"message":"\u003cstring>","field":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"961890dc-0db5-41ca-bcea-215cddc80e16":{"bearer":{"scheme":"bearer","bearerFormat":"API Key or JWT","type":"http","description":"Use `Authorization: Bearer esk_live_...` or `esk_test_...` for API access","scopes":[],"schemeName":"bearer"}}},"servers":{"3e7e327f-03ab-404b-a6e8-63ee95df6c74":{"url":"https://api.payable.run","description":"Production"},"af862650-1569-4387-b1e9-eec26d47fa47":{"url":"https://localhost:3000","description":"Local"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"API Key or JWT","type":"http","description":"Use `Authorization: Bearer esk_live_...` or `esk_test_...` for API access","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use `Authorization: Bearer esk_live_...` or `esk_test_...` for API access","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"revn-tech","siteName":"Payable API","title":"Get a client by ID - Payable API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/clients/get-a-client-by-id","matchLevel":0},"pt-BR":{"href":"/api-reference/clients/get-a-client-by-id","matchLevel":0}}},"lastModified":"2026-10-28T14:20:50.517Z","originalFileLocation":"api-reference/clients/get-a-client-by-id.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=\"application-name\" content=\"Payable API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/revn-tech/YhyCfu8epezX5bqR/_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/revn-tech/YhyCfu8epezX5bqR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/revn-tech/YhyCfu8epezX5bqR/_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/revn-tech/YhyCfu8epezX5bqR/_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/revn-tech/YhyCfu8epezX5bqR/_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/revn-tech/YhyCfu8epezX5bqR/_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/revn-tech/YhyCfu8epezX5bqR/_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/revn-tech/YhyCfu8epezX5bqR/_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/revn-tech/YhyCfu8epezX5bqR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a client by ID - Payable API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payable API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payable.run/api-reference/clients/get-a-client-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://revn-tech.mintlify.app/_mintlify/api/og/v2?division=Clients\u0026amp;title=Get+a+client+by+ID\u0026amp;theme=fe59c020f116851817a84d6d\u0026amp;signature=934fc5dd8530dce77f41a4baa334b029a6942dcba22c2c73fffbc466ebbb6d3e\">\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 client by ID - Payable API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://revn-tech.mintlify.app/_mintlify/api/og/v2?division=Clients\u0026amp;title=Get+a+client+by+ID\u0026amp;theme=fe59c020f116851817a84d6d\u0026amp;signature=934fc5dd8530dce77f41a4baa334b029a6942dcba22c2c73fffbc466ebbb6d3e\">\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/revn-tech/YhyCfu8epezX5bqR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payable API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payable.run/api-reference/clients/get-a-client-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/clients/get-a-client-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.payable.run/#organization\",\"name\":\"Payable API\",\"url\":\"https://docs.payable.run\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/revn-tech/8G10Lg5IuW978AYn/logo/light.svg?fit=max\u0026auto=format\u0026n=8G10Lg5IuW978AYn\u0026q=85\u0026s=3e82d847494f2f6241a880396cafd9a1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.payable.run#website\",\"name\":\"Payable API\",\"url\":\"https://docs.payable.run\",\"publisher\":{\"@id\":\"https://docs.payable.run/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.payable.run/api-reference/clients/get-a-client-by-id#webpage\",\"url\":\"https://docs.payable.run/api-reference/clients/get-a-client-by-id\",\"name\":\"Get a client by ID\",\"dateModified\":\"2026-10-28T14:20:50.517Z\",\"isPartOf\":{\"@id\":\"https://docs.payable.run#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payable.run/api-reference/clients/get-a-client-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payable.run/api-reference/clients/get-a-client-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.payable.run/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Clients\",\"item\":\"https://docs.payable.run/api-reference/clients/create-a-new-client\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a client by ID\",\"item\":\"https://docs.payable.run/api-reference/clients/get-a-client-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payable.run/api-reference/clients/get-a-client-by-id#apireference\",\"headline\":\"Get a client by ID\",\"name\":\"Get a client by ID\",\"url\":\"https://docs.payable.run/api-reference/clients/get-a-client-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payable.run/api-reference/clients/get-a-client-by-id#webpage\"},\"dateModified\":\"2026-10-28T14:20:50.517Z\",\"publisher\":{\"@id\":\"https://docs.payable.run/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.payable.run#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Payable API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Payable API","nav":{"global":null,"languages":[{"language":"en","groups":[{"group":"Get started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Core concepts","href":"/concepts"},{"title":"Authentication","href":"/authentication"}]},{"group":"Integrate","pages":[{"title":"Webhooks","href":"/webhooks"},{"title":"AI voice calls","href":"/voice-calls"},{"title":"Recuperação","href":"/recovery"},{"title":"Sandbox","href":"/sandbox"},{"title":"Errors","href":"/errors"}]},{"group":"API reference","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"group":"Clients","pages":[{"title":"Create a new client","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients","href":"/api-reference/clients/create-a-new-client"},{"title":"Get all clients for the organization","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients","href":"/api-reference/clients/get-all-clients-for-the-organization"},{"title":"Bulk upload clients from CSV file","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/bulk-upload","href":"/api-reference/clients/bulk-upload-clients-from-csv-file"},{"title":"Run a bulk action on clients","description":"delete | mark_paid. Max 100 ids.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/bulk","href":"/api-reference/clients/run-a-bulk-action-on-clients"},{"title":"Get a client by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients/{id}","href":"/api-reference/clients/get-a-client-by-id"},{"title":"Update a client","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/clients/{id}","href":"/api-reference/clients/update-a-client"},{"title":"Delete a client (hard delete with cascading)","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/clients/{id}","href":"/api-reference/clients/delete-a-client-hard-delete-with-cascading"},{"title":"Mark client as paid and clear all debts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/mark-paid","href":"/api-reference/clients/mark-client-as-paid-and-clear-all-debts"},{"title":"Settle all client debts and permanently block further messages","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/settle","href":"/api-reference/clients/settle-all-client-debts-and-permanently-block-further-messages"},{"title":"Reactivate a blocked communication channel","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/channels/{channel}/reactivate","href":"/api-reference/clients/reactivate-a-blocked-communication-channel"},{"title":"End an active channel snooze","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/channels/{channel}/end-snooze","href":"/api-reference/clients/end-an-active-channel-snooze"},{"title":"Record a one-time opt-out bypass for a send","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/channels/{channel}/bypass-send","href":"/api-reference/clients/record-a-one-time-opt-out-bypass-for-a-send"}]},{"group":"Debts","pages":[{"title":"Create a new debt","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts","href":"/api-reference/debts/create-a-new-debt"},{"title":"List all debts for the organization (paginated)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/debts","href":"/api-reference/debts/list-all-debts-for-the-organization-paginated"},{"title":"Run a bulk action on debts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/bulk","href":"/api-reference/debts/run-a-bulk-action-on-debts"},{"title":"Get all debts for a client","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/debts/client/{clientId}","href":"/api-reference/debts/get-all-debts-for-a-client"},{"title":"Get signed public payment link for a debt","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/debts/{id}/payment-link","href":"/api-reference/debts/get-signed-public-payment-link-for-a-debt"},{"title":"Get a debt by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/debts/{id}","href":"/api-reference/debts/get-a-debt-by-id"},{"title":"Update a debt","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/debts/{id}","href":"/api-reference/debts/update-a-debt"},{"title":"Delete a debt","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/debts/{id}","href":"/api-reference/debts/delete-a-debt"},{"title":"Mark a debt as paid and stop the collection flow","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/{id}/settle","href":"/api-reference/debts/mark-a-debt-as-paid-and-stop-the-collection-flow"},{"title":"Mandar uma cobrança em aberto para a Recuperação agora (sai da régua de Cobrança)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/{id}/recovery","href":"/api-reference/debts/mandar-uma-cobrança-em-aberto-para-a-recuperação-agora-sai-da-régua-de-cobrança"},{"title":"Tirar a cobrança da passagem automática para a Recuperação (para sempre; a manual continua possível)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/{id}/recovery/opt-out-handoff","href":"/api-reference/debts/tirar-a-cobrança-da-passagem-automática-para-a-recuperação-para-sempre;-a-manual-continua-possível"},{"title":"Resolver a contestação de uma cobrança da Recuperação: devida retoma a cadência; indevida cancela sem taxa e avisa o cliente","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/{id}/dispute/resolve","href":"/api-reference/debts/resolver-a-contestação-de-uma-cobrança-da-recuperação:-devida-retoma-a-cadência;-indevida-cancela-sem-taxa-e-avisa-o-cliente"}]},{"group":"Recurring charges","pages":[{"title":"Get a recurring charge series","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/recurring-charges/{id}","href":"/api-reference/recurring-charges/get-a-recurring-charge-series"},{"title":"Pause a recurring charge series","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/recurring-charges/{id}/pause","href":"/api-reference/recurring-charges/pause-a-recurring-charge-series"},{"title":"Cancel a recurring charge series","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/recurring-charges/{id}/cancel","href":"/api-reference/recurring-charges/cancel-a-recurring-charge-series"}]},{"group":"PIX payments","pages":[{"title":"Generate a charge for a debt (public checkout) — pix returns a QR code to poll, boleto/hosted_redirect card return a hostedUrl to open","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/pix/generate-for-debt/{debtId}","href":"/api-reference/payments/generate-a-charge-for-a-debt-public-checkout-—-pix-returns-a-qr-code-to-poll-boletohosted_redirect-card-return-a-hostedurl-to-open"},{"title":"Get payment details for checkout page (public)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/pix/payments/{paymentId}","href":"/api-reference/payments/get-payment-details-for-checkout-page-public"},{"title":"Get debt info for payment page (public)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/pix/debt/{debtId}/info","href":"/api-reference/payments/get-debt-info-for-payment-page-public"}]},{"group":"Voice calls","pages":[{"title":"Voice calling availability and pricing for this organization","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls/config","href":"/api-reference/voice-calls/voice-calling-availability-and-pricing-for-this-organization"},{"title":"Voices available on the provider (pt-BR first)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls/voices","href":"/api-reference/voice-calls/voices-available-on-the-provider-pt-br-first"},{"title":"Request an AI collection call","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/voice-calls","href":"/api-reference/voice-calls/request-an-ai-collection-call"},{"title":"List voice calls (cursor-paginated, newest first)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls","href":"/api-reference/voice-calls/list-voice-calls-cursor-paginated-newest-first"},{"title":"Get a voice call","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls/{id}","href":"/api-reference/voice-calls/get-a-voice-call"},{"title":"Recording URL (presigned, 24h). Pass `?redirect=1` for a 302 to the file.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls/{id}/recording","href":"/api-reference/voice-calls/recording-url-presigned-24h-pass-`?redirect=1`-for-a-302-to-the-file"},{"title":"Cancel a call that has not started dialing yet","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/voice-calls/{id}/cancel","href":"/api-reference/voice-calls/cancel-a-call-that-has-not-started-dialing-yet"}]},{"group":"Webhook endpoints","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/developer/webhook-endpoints","href":"/api-reference/developer/list-webhook-endpoints"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/developer/webhook-endpoints","href":"/api-reference/developer/register-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/developer/webhook-endpoints/{id}","href":"/api-reference/developer/delete-a-webhook-endpoint"}]},{"group":"Sandbox","pages":[{"title":"Simulate a sandbox payment as paid (test API keys only)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test/payments/{paymentId}/simulate-paid","href":"/api-reference/developer/simulate-a-sandbox-payment-as-paid-test-api-keys-only"}]}]}]},{"language":"pt-BR","groups":[{"group":"Começar","pages":[{"title":"Introdução","href":"/pt-BR/introduction"},{"title":"Quickstart","href":"/pt-BR/quickstart"},{"title":"Conceitos","href":"/pt-BR/concepts"},{"title":"Autenticação","href":"/pt-BR/authentication"}]},{"group":"Integração","pages":[{"title":"Webhooks","href":"/pt-BR/webhooks"},{"title":"Ligações com IA","href":"/pt-BR/voice-calls"},{"title":"Recuperação","href":"/pt-BR/recovery"},{"title":"Sandbox","href":"/pt-BR/sandbox"},{"title":"Erros","href":"/pt-BR/errors"}]},{"group":"Referência da API","pages":[{"title":"Referência da API","href":"/pt-BR/api-reference/introduction"},{"group":"Clientes","pages":[{"title":"Create a new client","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients","href":"/api-reference/clients/create-a-new-client"},{"title":"Get all clients for the organization","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients","href":"/api-reference/clients/get-all-clients-for-the-organization"},{"title":"Bulk upload clients from CSV file","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/bulk-upload","href":"/api-reference/clients/bulk-upload-clients-from-csv-file"},{"title":"Run a bulk action on clients","description":"delete | mark_paid. Max 100 ids.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/bulk","href":"/api-reference/clients/run-a-bulk-action-on-clients"},{"title":"Get a client by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/clients/{id}","href":"/api-reference/clients/get-a-client-by-id"},{"title":"Update a client","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/clients/{id}","href":"/api-reference/clients/update-a-client"},{"title":"Delete a client (hard delete with cascading)","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/clients/{id}","href":"/api-reference/clients/delete-a-client-hard-delete-with-cascading"},{"title":"Mark client as paid and clear all debts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/mark-paid","href":"/api-reference/clients/mark-client-as-paid-and-clear-all-debts"},{"title":"Settle all client debts and permanently block further messages","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/settle","href":"/api-reference/clients/settle-all-client-debts-and-permanently-block-further-messages"},{"title":"Reactivate a blocked communication channel","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/channels/{channel}/reactivate","href":"/api-reference/clients/reactivate-a-blocked-communication-channel"},{"title":"End an active channel snooze","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/channels/{channel}/end-snooze","href":"/api-reference/clients/end-an-active-channel-snooze"},{"title":"Record a one-time opt-out bypass for a send","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/clients/{id}/channels/{channel}/bypass-send","href":"/api-reference/clients/record-a-one-time-opt-out-bypass-for-a-send"}]},{"group":"Cobranças","pages":[{"title":"Create a new debt","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts","href":"/api-reference/debts/create-a-new-debt"},{"title":"List all debts for the organization (paginated)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/debts","href":"/api-reference/debts/list-all-debts-for-the-organization-paginated"},{"title":"Run a bulk action on debts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/bulk","href":"/api-reference/debts/run-a-bulk-action-on-debts"},{"title":"Get all debts for a client","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/debts/client/{clientId}","href":"/api-reference/debts/get-all-debts-for-a-client"},{"title":"Get signed public payment link for a debt","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/debts/{id}/payment-link","href":"/api-reference/debts/get-signed-public-payment-link-for-a-debt"},{"title":"Get a debt by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/debts/{id}","href":"/api-reference/debts/get-a-debt-by-id"},{"title":"Update a debt","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/debts/{id}","href":"/api-reference/debts/update-a-debt"},{"title":"Delete a debt","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/debts/{id}","href":"/api-reference/debts/delete-a-debt"},{"title":"Mark a debt as paid and stop the collection flow","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/{id}/settle","href":"/api-reference/debts/mark-a-debt-as-paid-and-stop-the-collection-flow"},{"title":"Mandar uma cobrança em aberto para a Recuperação agora (sai da régua de Cobrança)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/{id}/recovery","href":"/api-reference/debts/mandar-uma-cobrança-em-aberto-para-a-recuperação-agora-sai-da-régua-de-cobrança"},{"title":"Tirar a cobrança da passagem automática para a Recuperação (para sempre; a manual continua possível)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/{id}/recovery/opt-out-handoff","href":"/api-reference/debts/tirar-a-cobrança-da-passagem-automática-para-a-recuperação-para-sempre;-a-manual-continua-possível"},{"title":"Resolver a contestação de uma cobrança da Recuperação: devida retoma a cadência; indevida cancela sem taxa e avisa o cliente","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/debts/{id}/dispute/resolve","href":"/api-reference/debts/resolver-a-contestação-de-uma-cobrança-da-recuperação:-devida-retoma-a-cadência;-indevida-cancela-sem-taxa-e-avisa-o-cliente"}]},{"group":"Cobranças recorrentes","pages":[{"title":"Get a recurring charge series","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/recurring-charges/{id}","href":"/api-reference/recurring-charges/get-a-recurring-charge-series"},{"title":"Pause a recurring charge series","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/recurring-charges/{id}/pause","href":"/api-reference/recurring-charges/pause-a-recurring-charge-series"},{"title":"Cancel a recurring charge series","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/recurring-charges/{id}/cancel","href":"/api-reference/recurring-charges/cancel-a-recurring-charge-series"}]},{"group":"Pagamentos PIX","pages":[{"title":"Generate a charge for a debt (public checkout) — pix returns a QR code to poll, boleto/hosted_redirect card return a hostedUrl to open","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/pix/generate-for-debt/{debtId}","href":"/api-reference/payments/generate-a-charge-for-a-debt-public-checkout-—-pix-returns-a-qr-code-to-poll-boletohosted_redirect-card-return-a-hostedurl-to-open"},{"title":"Get payment details for checkout page (public)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/pix/payments/{paymentId}","href":"/api-reference/payments/get-payment-details-for-checkout-page-public"},{"title":"Get debt info for payment page (public)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/pix/debt/{debtId}/info","href":"/api-reference/payments/get-debt-info-for-payment-page-public"}]},{"group":"Ligações com IA","pages":[{"title":"Voice calling availability and pricing for this organization","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls/config","href":"/api-reference/voice-calls/voice-calling-availability-and-pricing-for-this-organization"},{"title":"Voices available on the provider (pt-BR first)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls/voices","href":"/api-reference/voice-calls/voices-available-on-the-provider-pt-br-first"},{"title":"Request an AI collection call","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/voice-calls","href":"/api-reference/voice-calls/request-an-ai-collection-call"},{"title":"List voice calls (cursor-paginated, newest first)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls","href":"/api-reference/voice-calls/list-voice-calls-cursor-paginated-newest-first"},{"title":"Get a voice call","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls/{id}","href":"/api-reference/voice-calls/get-a-voice-call"},{"title":"Recording URL (presigned, 24h). Pass `?redirect=1` for a 302 to the file.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/voice-calls/{id}/recording","href":"/api-reference/voice-calls/recording-url-presigned-24h-pass-`?redirect=1`-for-a-302-to-the-file"},{"title":"Cancel a call that has not started dialing yet","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/voice-calls/{id}/cancel","href":"/api-reference/voice-calls/cancel-a-call-that-has-not-started-dialing-yet"}]},{"group":"Endpoints de webhook","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/developer/webhook-endpoints","href":"/api-reference/developer/list-webhook-endpoints"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/developer/webhook-endpoints","href":"/api-reference/developer/register-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/developer/webhook-endpoints/{id}","href":"/api-reference/developer/delete-a-webhook-endpoint"}]},{"group":"Sandbox","pages":[{"title":"Simulate a sandbox payment as paid (test API keys only)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/test/payments/{paymentId}/simulate-paid","href":"/api-reference/developer/simulate-a-sandbox-payment-as-paid-test-api-keys-only"}]}]}]}]},"title":"Get a client by ID - Payable API","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}