Pesquisar Pagamento

GET/v1/payments/{paymentId}

Consulta o status e os detalhes de uma transação específica pelo seu identificador.

Realizar Consulta de Pagamento

Parâmetros

Exemplo de requisição

curl --request GET \
  --url 'https://api.enoqpay.com.br/gateway/v1/payments/{paymentId}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta

{
  "paymentId": "020037308007081506570001580648030000000000",
  "statusDescription": "Cancelada",
  "transactionDate": "2024-07-08T12:06:57.07",
  "authorizationCode": "078704",
  "value": 15000
}

Dicionário de dados

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Exemplo documentado

[
  {
    "tag": "__general__",
    "description": "Transação não localizada, verifique os dados informados."
  }
]

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.