Consultar pagamento do checkout

get

https://api-hml.alliancepay.app/acquiring/payment-links/public/{public_token}/payments/{payment_id}

Consulta o pagamento vinculado ao public_token e pode reconciliar estados pendentes junto ao provedor. Retorna status, falha e next_action quando disponível. APPROVED é o estado de aprovação financeira; HTTP 200, AUTHENTICATING, PROCESSING ou PENDING_CONFIRMATION não comprovam pagamento. O endpoint pode retornar o formato Pix para um payment_id Pix.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Consulta, continuação ou repetição concluída; confira o status do recurso.

400Parâmetros, corpo ou cabeçalhos inválidos. A resposta pode conter mensagens por campo.

401Token ausente, inválido ou expirado, ou credencial revogada.

403Permissão ou escopo insuficiente, ou requisição bloqueada pelo firewall.

404Recurso inexistente ou fora do escopo, rota não publicada, ou public_token de link que não pertence ao parceiro autenticado.

409Conflito com o estado do link/tentativa ou reutilização incompatível de chave de idempotência.

413Corpo acima do limite aceito pela infraestrutura. O bloqueio de 16 KB do firewall pode retornar 403.

414Query string codificada acima de 4096 caracteres.

429Limite de requisições atingido. Aguarde antes de tentar novamente. O firewall também pode responder 403.

500Falha interna no gateway ou na autorização.

502Falha de comunicação com o serviço ou resposta acima de 4 MB.

503Serviço temporariamente indisponível ou resultado do provedor incerto. Recupere o resultado pela mesma chave antes de repetir uma escrita.

504Tempo limite excedido. Em escritas, consulte o resultado antes de repetir; preserve a chave nas operações idempotentes.