Início rápido
Do token ao checkout pago em alguns comandos
curl.Autenticação
Credenciais de cliente OAuth 2.0, escopos e validade do token.
Erros
O objeto de erro, códigos de status e IDs de requisição.
Checkouts
Abra um checkout e receba o pagamento.
Webhooks
Seja avisado quando um pagamento é confirmado, recusado ou estornado.
URL base
/v1.
Requisições e respostas
A API é REST sobre HTTPS com corpos em JSON. EnvieContent-Type: application/json em requisições POST e PATCH — a única exceção é POST /oauth/token, que usa application/x-www-form-urlencoded (veja Autenticação). Campos desconhecidos no corpo são rejeitados com 400, não ignorados.
Respostas de sucesso usam
2xx (criações retornam 201, o resto 200); falhas retornam 4xx/5xx com um objeto de erro estruturado. Recursos individuais têm um campo object com o tipo; coleções retornam um objeto de lista.
Versionamento — a versão atual é v1, no caminho da URL. Mudanças aditivas entram na v1 sem aviso, então trate as respostas de forma tolerante.
IDs de recurso
IDs são strings com um prefixo de tipo e um UUID, ex.cus_9b2c4f1a-3d5e-4a7b-8c9d-1e2f3a4b5c6d.
Valores monetários
Valores são inteiros na unidade menor da moeda (centavos para BRL).R$ 49,90 é 4990. Códigos de moeda seguem o ISO 4217 em maiúsculas — a MoneyDev liquida em BRL.
IDs de requisição
Toda resposta traz o headerX-Request-Id, e os corpos de erro repetem esse valor em error.request_id. Informe-o ao acionar o suporte.
Uma integração típica
1
Obtenha um token de acesso
Troque suas credenciais de cliente em
POST /oauth/token. Veja Autenticação.3
Abra um checkout
Crie um checkout para uma oferta. A resposta inclui uma
checkout_url.4
Envie o comprador para pagar
Redirecione-o para a
checkout_url, a página hospedada onde ele paga com Pix. Consulte o checkout até o status ser completed, ou assine o webhook payment.succeeded para ser avisado — mantendo a consulta como reconciliação.