Integração
Idempotência
Envie o cabeçalho Idempotency-Key em todo POST. Assim uma requisição repetida nunca cria um segundo pagamento.
Por que usar
A rede falha. Se a resposta de um POST se perder, você não sabe se o pagamento foi criado. Com a Idempotency-Key, você repete a mesma requisição sem medo: a API devolve o resultado da primeira vez e não cria nada novo.
Faça assim
- Gere a chave a partir do seu pedido, por exemplo
pedido-1234. Ela precisa ter de 8 a 200 caracteres. - Envie a chave no cabeçalho
Idempotency-Keyde todoPOST. - Ao repetir por falha de rede, envie a mesma chave e o mesmo corpo.
- Para um pedido novo, use uma chave nova.
Idempotency-Key: pedido-1234O que a API responde
| Situação | Resposta |
|---|---|
| Chave nova | A API executa e guarda o resultado. |
| Mesma chave e mesmo corpo | A API devolve o resultado guardado. Nada novo é criado. |
| Mesma chave e corpo diferente | 422 com o código idempotency_key_reused. |
| Mesma chave ainda em andamento | 409 com o código idempotency_in_progress. Espere e repita. |
| Sem a chave | 400 com o código idempotency_key_required. |
A API guarda a chave por 24 horas. A resposta repetida é a da criação: para ver o status atual, use Buscar um pagamento.