Consultar pagamento
Consulte a situação de um pagamento PIX ou cartão na My Gateway pelo paymentId e saiba quais situações são finais.
Nesta página
/payments/v1/situation/by/{paymentId}Devolve a situação atual de um pagamento PIX ou cartão.
Cabeçalhos
AuthorizationstringobrigatórioValor de
authenticationTokenretornado na autenticação, sem o prefixoBearer.x-api-keystringobrigatórioChave do API Gateway do ambiente.
Parâmetros de caminho
paymentIdUUIDobrigatórioIdentificador recebido na criação do PIX ou do pagamento no cartão.
Requisição
curl --request GET \
--url 'https://api.mygateway.com.br/payments/v1/situation/by/f3da8969-3db8-49f1-91cf-50ff444252e7' \
--header 'Authorization: TOKEN_DE_AUTENTICACAO' \
--header 'x-api-key: SUA_API_KEY'const response = await fetch("https://api.mygateway.com.br/payments/v1/situation/by/f3da8969-3db8-49f1-91cf-50ff444252e7", {
method: "GET",
headers: {
Authorization: token,
"x-api-key": process.env.MYGATEWAY_API_KEY,
},
});
const result = await response.json();<?php
$ch = curl_init('https://api.mygateway.com.br/payments/v1/situation/by/f3da8969-3db8-49f1-91cf-50ff444252e7');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: ' . $token,
'x-api-key: ' . getenv('MYGATEWAY_API_KEY'),
],
CURLOPT_RETURNTRANSFER => true,
]);
$result = json_decode(curl_exec($ch), true);import os
import requests
response = requests.get(
"https://api.mygateway.com.br/payments/v1/situation/by/f3da8969-3db8-49f1-91cf-50ff444252e7",
headers={
"Authorization": token,
"x-api-key": os.environ["MYGATEWAY_API_KEY"],
},
)
result = response.json()Respostas
Situação atual do pagamento. Os atributos variam conforme o meio de pagamento.
Cartão
{
"situation": "Paid",
"nsu": "123456789012",
"authorizationCode": "A1B2C3",
"value": 10000,
}Ou
PIX
{
"situation": "Paid",
"endToEndId": "E1234567820261029123456789012345",
"value": 1050,
}Token ausente, inválido ou expirado.
JSON
{
"message": "Não autorizado",
"timestamp": "2026-10-29T21:30:00Z"
}Atributos da resposta
situationstringobrigatórioSituação atual do pagamento. Veja a tabela de situações.
nsustringopcionalCartão. Número Sequencial Único, quando disponível.
authorizationCodestringopcionalCartão. Código de autorização, quando disponível.
errorDescriptionstringopcionalFalha ou recusa. Descrição da falha, quando disponível.
endToEndIdstringopcionalPIX pago. Identificador de ponta a ponta do PIX, quando disponível.
valueintegerobrigatórioValor da transação em centavos.
Situações possíveis#
Os valores são strings, exatamente com a capitalização abaixo.
| Situação | Significado | O que fazer |
|---|---|---|
New | Pagamento criado e em processamento inicial. | Aguarde e consulte de novo. |
WaitingPayment | Aguardando pagamento ou confirmação. | Ainda não entregue o produto como pago. |
Challenge | O cartão exige autenticação adicional. | Execute o desafio 3DS. |
Paid | Pagamento confirmado. | Estado de sucesso. |
UnPaid | Não pago ou expirado. | Estado final sem pagamento. |
Canceled | Pagamento cancelado. | Estado final sem pagamento. |
Reproved | Pagamento recusado. | Estado final sem pagamento. |
Fail | Falha no processamento. | Estado final de erro. Avalie nova tentativa conforme a mensagem. |
Frequência de consulta#
Consulte pagamentos pendentes com intervalo progressivo e limite de tentativas. Evite polling agressivo.
Última atualização em
