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
Authorizatione umaIdempotency-Keyem todo pedido que escreve — veja Autenticação; - os exemplos de
curlefetchdo 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çascustomers— cadastro de clientespayouts— saques via Pixrefunds— listar estornosevents— consultar e reenviar eventosbalance— saldo da contawebhook_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
}
}
| Campo | Descrição |
|---|---|
type | Categoria do erro |
code | Código do erro — a lista está em Erros |
message | Explicação legível |
request_id | ID do pedido — envie ao suporte |
retryable | Se o mesmo pedido pode ser reenviado (com a mesma Idempotency-Key) |