# Payable API > Payable API documentation: automate collections with clients, debts, webhooks and AI voice calls. ## Get started - [Introduction](https://docs.payable.run/introduction.md): Automate collections from your ERP, CRM or internal system with the Payable REST API. - [Quickstart](https://docs.payable.run/quickstart.md): Make your first integration in 5 minutes with a test key. - [Core concepts](https://docs.payable.run/concepts.md): The four objects you will work with and how they relate. - [Authentication](https://docs.payable.run/authentication.md): API keys, scopes, idempotency and rate limits. ## Integrate - [Webhooks](https://docs.payable.run/webhooks.md): Signed outbound events delivered through Svix. - [AI voice calls](https://docs.payable.run/voice-calls.md): Collect by voice, over phone or WhatsApp, through the API. - [Recuperação](https://docs.payable.run/recovery.md): Overdue portfolios, the R0…R+180 cadence and the Cobrança and Recuperação fees - [Sandbox](https://docs.payable.run/sandbox.md): Build and test without cost or real messages. - [Errors](https://docs.payable.run/errors.md): HTTP status codes, stable error codes and how to retry. ## API reference - [API reference](https://docs.payable.run/api-reference/introduction.md): Every public endpoint, generated from the OpenAPI spec. ### Clients - [Create a new client](https://docs.payable.run/api-reference/clients/create-a-new-client.md) - [Get all clients for the organization](https://docs.payable.run/api-reference/clients/get-all-clients-for-the-organization.md) - [Bulk upload clients from CSV file](https://docs.payable.run/api-reference/clients/bulk-upload-clients-from-csv-file.md) - [Run a bulk action on clients](https://docs.payable.run/api-reference/clients/run-a-bulk-action-on-clients.md): delete | mark_paid. Max 100 ids. - [Get a client by ID](https://docs.payable.run/api-reference/clients/get-a-client-by-id.md) - [Update a client](https://docs.payable.run/api-reference/clients/update-a-client.md) - [Delete a client (hard delete with cascading)](https://docs.payable.run/api-reference/clients/delete-a-client-hard-delete-with-cascading.md) - [Mark client as paid and clear all debts](https://docs.payable.run/api-reference/clients/mark-client-as-paid-and-clear-all-debts.md): Sets currentAmount to 0 for all debts of the client and updates client status to UP_TO_DATE. - [Settle all client debts and permanently block further messages](https://docs.payable.run/api-reference/clients/settle-all-client-debts-and-permanently-block-further-messages.md): Zeros all debts, sets client status to UP_TO_DATE, and marks the WhatsApp conversation as permanently unreachable so no automated messages are sent. - [Reactivate a blocked communication channel](https://docs.payable.run/api-reference/clients/reactivate-a-blocked-communication-channel.md) - [End an active channel snooze](https://docs.payable.run/api-reference/clients/end-an-active-channel-snooze.md) - [Record a one-time opt-out bypass for a send](https://docs.payable.run/api-reference/clients/record-a-one-time-opt-out-bypass-for-a-send.md) ### Debts - [Create a new debt](https://docs.payable.run/api-reference/debts/create-a-new-debt.md) - [List all debts for the organization (paginated)](https://docs.payable.run/api-reference/debts/list-all-debts-for-the-organization-paginated.md) - [Run a bulk action on debts](https://docs.payable.run/api-reference/debts/run-a-bulk-action-on-debts.md): settle | delete | pause_collection | resume_collection | resend_current_step | send_to_recovery. Max 100 ids. send_to_recovery: 403 RECOVERY_UNAVAILABLE / RECOVERY_TERMS_REQUIRED for the whole batch; per debt, `reason` says why one did not go. - [Get all debts for a client](https://docs.payable.run/api-reference/debts/get-all-debts-for-a-client.md) - [Get signed public payment link for a debt](https://docs.payable.run/api-reference/debts/get-signed-public-payment-link-for-a-debt.md) - [Get a debt by ID](https://docs.payable.run/api-reference/debts/get-a-debt-by-id.md) - [Update a debt](https://docs.payable.run/api-reference/debts/update-a-debt.md) - [Delete a debt](https://docs.payable.run/api-reference/debts/delete-a-debt.md) - [Mark a debt as paid and stop the collection flow](https://docs.payable.run/api-reference/debts/mark-a-debt-as-paid-and-stop-the-collection-flow.md) - [Mandar uma cobrança em aberto para a Recuperação agora (sai da régua de Cobrança)](https://docs.payable.run/api-reference/debts/mandar-uma-cobrança-em-aberto-para-a-recuperação-agora-sai-da-régua-de-cobrança.md) - [Tirar a cobrança da passagem automática para a Recuperação (para sempre; a manual continua possível)](https://docs.payable.run/api-reference/debts/tirar-a-cobrança-da-passagem-automática-para-a-recuperação-para-sempre;-a-manual-continua-possível.md) - [Resolver a contestação de uma cobrança da Recuperação: devida retoma a cadência; indevida cancela sem taxa e avisa o cliente](https://docs.payable.run/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.md) ### Recurring charges - [Get a recurring charge series](https://docs.payable.run/api-reference/recurring-charges/get-a-recurring-charge-series.md) - [Pause a recurring charge series](https://docs.payable.run/api-reference/recurring-charges/pause-a-recurring-charge-series.md) - [Cancel a recurring charge series](https://docs.payable.run/api-reference/recurring-charges/cancel-a-recurring-charge-series.md) ### PIX payments - [Generate a charge for a debt (public checkout) — pix returns a QR code to poll, boleto/hosted_redirect card return a hostedUrl to open](https://docs.payable.run/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.md) - [Get payment details for checkout page (public)](https://docs.payable.run/api-reference/payments/get-payment-details-for-checkout-page-public.md) - [Get debt info for payment page (public)](https://docs.payable.run/api-reference/payments/get-debt-info-for-payment-page-public.md) ### Voice calls - [Voice calling availability and pricing for this organization](https://docs.payable.run/api-reference/voice-calls/voice-calling-availability-and-pricing-for-this-organization.md) - [Voices available on the provider (pt-BR first)](https://docs.payable.run/api-reference/voice-calls/voices-available-on-the-provider-pt-br-first.md) - [Request an AI collection call](https://docs.payable.run/api-reference/voice-calls/request-an-ai-collection-call.md): Queues an outbound call to the client about a debt. `medium=whatsapp` first asks the debtor for WhatsApp call permission and dials once accepted. Returns the call row (status `queued` or `awaiting_permission`) plus soft `warnings`. Errors: `VOICE_CALLS_DISABLED`, `VOICE_MEDIUM_UNAVAILABLE`, `VOICE_I… - [List voice calls (cursor-paginated, newest first)](https://docs.payable.run/api-reference/voice-calls/list-voice-calls-cursor-paginated-newest-first.md) - [Get a voice call](https://docs.payable.run/api-reference/voice-calls/get-a-voice-call.md) - [Recording URL (presigned, 24h). Pass `?redirect=1` for a 302 to the file.](https://docs.payable.run/api-reference/voice-calls/recording-url-presigned-24h-pass-`?redirect=1`-for-a-302-to-the-file.md) - [Cancel a call that has not started dialing yet](https://docs.payable.run/api-reference/voice-calls/cancel-a-call-that-has-not-started-dialing-yet.md) ### Webhook endpoints - [List webhook endpoints](https://docs.payable.run/api-reference/developer/list-webhook-endpoints.md) - [Register a webhook endpoint](https://docs.payable.run/api-reference/developer/register-a-webhook-endpoint.md) - [Delete a webhook endpoint](https://docs.payable.run/api-reference/developer/delete-a-webhook-endpoint.md) ### Sandbox - [Simulate a sandbox payment as paid (test API keys only)](https://docs.payable.run/api-reference/developer/simulate-a-sandbox-payment-as-paid-test-api-keys-only.md) ## OpenAPI Specs - [openapi](/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Brazilian Portuguese (51 pages)](https://docs.payable.run/_llms/pt-br.txt): Documentation for Brazilian Portuguese. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.