Pagamentos

Consultar Pagamento no Meio

Pergunta agora ao meio de pagamento a situação da cobrança e atualiza o pedido

POST

/v1/pedidos/{id}/pagamentos/consultar

Escopo

pedidos.escrever

Útil quando o aviso do meio atrasou ou se perdeu. O pedido é atualizado pelo mesmo caminho do aviso (status, e-mail, estoque e webhooks).
Vale para as cobranças dos aplicativos de pagamento (PayPal, Stripe, Pagar.me, Cielo, Asaas, Iugu e PicPay). Sem cobrança: 404 sem_cobranca.
Pode ser repetida a cada 30 segundos por pedido (429 aguarde, com Retry-After).

Autorização

Authorizationstringobrigatórioheader

Chave da API no formato Bearer hdl_live_.... Crie no painel da loja em Integração › API e webhooks. Saiba mais.

Parâmetros de caminho

idintegerobrigatóriopath

Identificador do pedido.

Resposta

200 — objeto { "dados": ... } (veja o exemplo).

Erros possíveis

HTTP	código	quando
`401`	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
`401`	`chave_invalida`	Chave inexistente ou revogada.
`403`	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.
`404`	`nao_encontrado`	O recurso não existe nesta loja.
`404`	`rota_nao_encontrada`	Endereço inexistente na API v1.
`404`	`sem_cobranca`	O pedido não tem cobrança em um meio de pagamento.
`429`	`aguarde`	A ação foi repetida antes do intervalo mínimo (veja Retry-After).
`404`	`sem_rastreio`	O pedido ainda não tem código de rastreio.
`429`	`limite_excedido`	Mais de 120 chamadas no minuto (veja Retry-After).

import os, requests resposta = requests.post( "https://api.hoteldaslojas.com.br/v1/pedidos/2178/pagamentos/consultar", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/pedidos/2178/pagamentos/consultar'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE')], ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "pedido_id": 2182, "status": "pago", "situacao_pagamento": "aprovado", "consultas": [ { "gateway": "asaas", "codigo": "pay_8x2k4m9p1q", "resultado": "aprovado" } ] } }

{ "erro": { "codigo": "sem_permissao", "mensagem": "Esta chave não tem o escopo \"pedidos.ler\". Crie uma chave com esse escopo no painel da loja (Integração › API).", "request_id": "req_95f4a872c180063c" } }