Começar

Ambientes

Os exemplos de todas as páginas usam a base URL do ambiente escolhido no topo. Os caminhos são relativos a ela: POST /charges é <base URL>/charges. As credenciais do sandbox são diferentes das de produção: uma não funciona no outro ambiente.

ProduçãoNos exemplos

https://api.sancopay.com/api/v1

Pix e saldos reais.

Sandbox

https://sandbox.sancopay.com/api/v1

Mesma API, sem dinheiro real. Credenciais próprias.

Convenções

JSON: Corpo e respostas em JSON, com campos em snake_case e objetos aninhados (customer.email, pix.key). Envie Content-Type: application/json.
Valores: Em reais, como número JSON: 150 ou 150.5 (R$ 150,50). Mínimo de R$ 1,00 em cobranças e saques.
Datas: ISO 8601 em UTC, como 2026-11-09T15:04:05.000000Z. Vencimentos da recorrência e filtros de data usam YYYY-MM-DD.
Status: Sempre em minúsculas (pending, paid, completed…). Os filtros status das listas aceitam os mesmos nomes.
Recurso: Uma consulta ou criação devolve o objeto direto, sem envelope.
Listas: Formato { "data": [...], "meta": { "page", "per_page", "total", "last_page" } }, paginadas por page e per_page (1 a 100, padrão 20).
Erros: Formato { "message", "code", "errors"? }. Veja Erros.
Seus ids: reference é o identificador do seu sistema; metadata guarda dados livres (objeto) que voltam nas respostas e nos webhooks.
Conta: Toda chamada age na conta da credencial que gerou o token; não há parâmetro para escolher outra conta.
Versão: A base termina em /v1. Mudanças incompatíveis sairão numa versão nova, sem alterar a v1.