OpenAPI 3.1 · Complete API contract

Build financial products on one clear contract.

Browse every DuckLedger capability in one contract, including the complete Asaas compatibility surface, control-plane operations, authentication, webhooks and health checks.

Explore the API OpenAPI JSON

quickstart.sh

curl --request GET \
  --url https://api.duckledger.com/api/v1/customers \
  --header "Authorization: Bearer dlk_live_..." \
  --header "Accept: application/json"

208

Asaas operations mapped

208

Available equivalents

Planned for parity

Capability groups

Authenticate

Use environment-scoped bearer keys. Test and live credentials are visibly different and can be limited by workspace and permission.

Read authentication

Call the API

Use the interactive reference for paths, examples, generated client snippets, and the canonical response envelope.

Open reference

Receive events

Verify timestamped HMAC signatures, process deliveries idempotently, and inspect delivery attempts before going live.

Webhook guide

Endpoint coverage

Complete Asaas capability map

This table comes from Asaas's public OpenAPI reference. Every listed operation has a callable DuckLedger equivalent, implemented natively or through the secured compatibility gateway.

Interactive reference Download contract

Showing 40 of 208 operations

Open interactive reference

MethodOperationDuckLedger targetStatus

POST

(Apenas Sandbox) Aprovar conta

Ações em sandbox

/api/v1/sandbox/myAccount/approve

Asaas: POST /v3/sandbox/myAccount/approve

Available

POST

(Apenas sandbox) Confirmar o pagamento

Ações em sandbox

/api/v1/sandbox/payment/{id}/confirm

Asaas: POST /v3/sandbox/payment/{id}/confirm

Available

POST

(Apenas sandbox) Forçar o vencimento de uma cobrança

Ações em sandbox

/api/v1/sandbox/payment/{id}/overdue

Asaas: POST /v3/sandbox/payment/{id}/overdue

Available

GET

Listar antecipações

Antecipações

/api/v1/anticipations

Asaas: GET /v3/anticipations

Available

POST

Solicitar antecipação

Antecipações

/api/v1/anticipations

Asaas: POST /v3/anticipations

Available

GET

Recuperar uma única antecipação

Antecipações

/api/v1/anticipations/{id}

Asaas: GET /v3/anticipations/{id}

Available

POST

Cancelar antecipação

Antecipações

/api/v1/anticipations/{id}/cancel

Asaas: POST /v3/anticipations/{id}/cancel

Available

GET

Recuperar status da antecipação automática

Antecipações

/api/v1/anticipations/configurations

Asaas: GET /v3/anticipations/configurations

Available

PUT

Atualizar status da antecipação automática

Antecipações

/api/v1/anticipations/configurations

Asaas: PUT /v3/anticipations/configurations

Available

GET

Recuperar limites de antecipações

Antecipações

/api/v1/anticipations/limits

Asaas: GET /v3/anticipations/limits

Available

POST

Simular antecipação

Antecipações

/api/v1/anticipations/simulate

Asaas: POST /v3/anticipations/simulate

Available

GET

Listar assinaturas

Assinaturas

/api/v1/subscriptions

Asaas: GET /v3/subscriptions

Available

POST

Criar nova assinatura

Assinaturas

/api/v1/subscriptions

Asaas: POST /v3/subscriptions

Available

POST

Criar assinatura com cartão de crédito

Assinaturas

/api/v1/subscriptions

Asaas: POST /v3/subscriptions/

Available

POST

Remover assinatura

Assinaturas

/api/v1/subscriptions/{id}/cancel

Asaas: DELETE /v3/subscriptions/{id}

Available

GET

Recuperar uma única assinatura

Assinaturas

/api/v1/subscriptions/{id}

Asaas: GET /v3/subscriptions/{id}

Available

PUT

Atualizar assinatura existente

Assinaturas

/api/v1/subscriptions/{id}

Asaas: PUT /v3/subscriptions/{id}

Available

PUT

Atualiza o cartão de crédito sem efetuar cobrança

Assinaturas

/api/v1/subscriptions/{id}/creditCard

Asaas: PUT /v3/subscriptions/{id}/creditCard

Available

GET

Listar notas fiscais das cobranças de uma assinatura

Assinaturas

/api/v1/subscriptions/{id}/invoices

Asaas: GET /v3/subscriptions/{id}/invoices

Available

DELETE

Remover configuração para emissão de Notas Fiscais

Assinaturas

/api/v1/subscriptions/{id}/invoiceSettings

Asaas: DELETE /v3/subscriptions/{id}/invoiceSettings

Available

GET

Recuperar configuração para emissão de notas fiscais

Assinaturas

/api/v1/subscriptions/{id}/invoiceSettings

Asaas: GET /v3/subscriptions/{id}/invoiceSettings

Available

POST

Criar configuração para emissão de Notas Fiscais

Assinaturas

/api/v1/subscriptions/{id}/invoiceSettings

Asaas: POST /v3/subscriptions/{id}/invoiceSettings

Available

PUT

Atualizar configuração para emissão de Notas Fiscais

Assinaturas

/api/v1/subscriptions/{id}/invoiceSettings

Asaas: PUT /v3/subscriptions/{id}/invoiceSettings

Available

GET

Gerar carnê de assinatura

Assinaturas

/api/v1/subscriptions/{id}/paymentBook

Asaas: GET /v3/subscriptions/{id}/paymentBook

Available

GET

Listar cobranças de uma assinatura

Assinaturas

/api/v1/subscriptions/{id}/payments

Asaas: GET /v3/subscriptions/{id}/payments

Available

GET

Recuperar configuração da pré-autorização

Cartão de crédito

/api/v1/creditCard/preAuthorization/config

Asaas: GET /v3/creditCard/preAuthorization/config

Available

POST

Salvar ou atualizar configuração da pré-autorização

Cartão de crédito

/api/v1/creditCard/preAuthorization/config

Asaas: POST /v3/creditCard/preAuthorization/config

Available

POST

Tokenização de cartão de crédito

Cartão de crédito

/api/v1/payment-methods/tokenize

Asaas: POST /v3/creditCard/tokenizeCreditCard

Available

GET

Listar chargebacks

Chargeback

/api/v1/chargebacks

Asaas: GET /v3/chargebacks/

Available

POST

Criar disputa de chargeback

Chargeback

/api/v1/chargebacks/{id}/dispute

Asaas: POST /v3/chargebacks/{id}/dispute

Available

GET

Recuperar um único chargeback

Chargeback

/api/v1/payments/{id}/chargeback

Asaas: GET /v3/payments/{id}/chargeback

Available

POST

Criar novo checkout

Checkout

/api/v1/checkouts

Asaas: POST /v3/checkouts

Available

POST

Cancelar um checkout

Checkout

/api/v1/checkouts/{id}/cancel

Asaas: POST /v3/checkouts/{id}/cancel

Available

GET

Listar clientes

Clientes

/api/v1/customers

Asaas: GET /v3/customers

Available

POST

Criar novo cliente

Clientes

/api/v1/customers

Asaas: POST /v3/customers

Available

DELETE

Remover cliente

Clientes

/api/v1/customers/{id}

Asaas: DELETE /v3/customers/{id}

Available

GET

Recuperar um único cliente

Clientes

/api/v1/customers/{id}

Asaas: GET /v3/customers/{id}

Available

PUT

Atualizar cliente existente

Clientes

/api/v1/customers/{id}

Asaas: PUT /v3/customers/{id}

Available

GET

Recuperar notificações de um cliente

Clientes

/api/v1/customers/{id}/notifications

Asaas: GET /v3/customers/{id}/notifications

Available

POST

Restaurar cliente removido

Clientes

/api/v1/customers/{id}/restore

Asaas: POST /v3/customers/{id}/restore

Available

One source of truth

The endpoint matrix and interactive reference are generated from the same versioned OpenAPI inventory. The repository also includes ReadMe's official sync workflow, so the contract can be published to a ReadMe developer hub without rewriting it.

Machine-readable by default

Import the OpenAPI file into Postman, Insomnia, or an SDK generator. Coding agents can also use the concise and full LLM context files maintained with the API.

llms.txt llms-full.txt