DOCS

SDKs

Integração pela API HTTP enquanto os SDKs oficiais não são publicados.

Situação dos SDKs

Os SDKs oficiais (TypeScript, PHP e Python) ainda não estão publicados no npm, no Packagist nem no PyPI. Até lá, integre direto pela API HTTP: ela é JSON simples e funciona com qualquer cliente HTTP da sua linguagem.

O que você precisa:

  • a chave secreta no cabeçalho Authorization e uma Idempotency-Key em todo pedido que escreve — veja Autenticação;
  • os exemplos de curl e fetch do Quickstart;
  • a referência das rotas em /docs/v1/... e a spec completa em /openapi.json, que serve para gerar um cliente na sua linguagem.

Este aviso sai daqui quando os pacotes forem publicados.

Recursos da API

  • charges — criar, listar, capturar, cancelar e estornar cobranças
  • customers — cadastro de clientes
  • payouts — saques via Pix
  • refunds — listar estornos
  • events — consultar e reenviar eventos
  • balance — saldo da conta
  • webhook_endpoints — gerenciar os endpoints de webhook

Erros

Todo erro volta no mesmo envelope:

{
  "error": {
    "type": "invalid_request",
    "code": "validation_error",
    "message": "...",
    "request_id": "...",
    "retryable": false
  }
}
CampoDescrição
typeCategoria do erro
codeCódigo do erro — a lista está em Erros
messageExplicação legível
request_idID do pedido — envie ao suporte
retryableSe o mesmo pedido pode ser reenviado (com a mesma Idempotency-Key)

On this page