Saltar para o conteúdo principal
GET
Use GET /payment/inquiry/{id} para recuperar o status atual e os detalhes de qualquer pagamento. Passe o paymentCode que o Therius devolveu quando o pagamento foi criado (p. ex. PC-1234567890) ou o UUID de pagamento interno. Este endpoint é útil para fazer polling de pagamentos pendentes, conciliação e depuração.
Diferente das respostas de pagamento/assinatura no resto desta API, amount aqui é um inteiro simples nas unidades menores da moeda, com um campo currency separado no nível superior — não um objeto { currency, value, exponent }.

​
Buscar um pagamento recusado

​
Consultar um pagamento de sandbox

O ambiente vem da sua credencial, então uma chave de sandbox consulta pagamentos de sandbox.
Este endpoint exige autenticação: uma chave de API privada (Bearer prv_...) a partir do seu servidor, ou o clientToken de uma sessão do Checkout Widget a partir do navegador. Você só pode consultar os pagamentos do seu próprio merchant. Se o pagamento não existir, ou pertencer a outro merchant, a API devolve 404 Not Found. Credenciais ausentes ou inválidas devolvem 401 Unauthorized. Verifique o paymentCode ou o UUID e certifique-se de que você está usando uma chave do ambiente correto (produção vs. sandbox).
Você pode usar este endpoint para fazer polling do status final de pagamentos pending_3ds ou pending_action se você preferir não usar webhooks. No entanto, os webhooks são recomendados para produção — eles empurram o status final para o seu servidor assim que ele está disponível, sem exigir polling.

Autorizações

​
Authorization
string
header
obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parâmetros de caminho

​
id
string
obrigatório

The paymentCode (e.g. PC-1234567890) or the internal payment UUID.

Resposta

Payment details

Current state of a payment. Note amount here is a flat integer in minor units with a separate currency, unlike the Amount object used elsewhere.

​
id
string

Internal Therius payment UUID.

​
merchantId
integer

Your merchant account ID.

​
orderCode
string

Your original order reference.

​
paymentCode
string

Therius receipt ID.

​
status
enum<string>

captured - funds settled; authorized - funds reserved, call capture to settle; declined - issuer declined, see refusalCode; pending_3ds - a 3DS challenge is required, see actionRequired; pending_action - an external action (redirect, voucher) is required, see actionRequired; failed - processing error unrelated to the issuer; canceled - authorization voided; refunded - captured funds returned.

Opções disponíveis:
captured,
authorized,
declined,
pending_3ds,
pending_action,
failed,
canceled,
refunded
​
amount
integer

Payment amount in the currency minor units.

​
currency
string

ISO 4217 currency code.

​
authorizationCode
string

Issuer authorization code. Present on authorized and captured payments.

​
refusalCode
object

Present when status is declined. See the Declined Payments concept page for the full code table and how to react to each recoveryAction. For alternative payment methods reasonCode is an APM_* code.