Neste endpoint você pode obter o status atual de um pagamento utilizando o ID gerado pela SX no momento da criação do link.
Uma chamada JSON do tipo GET deve ser realizada para o endpoint abaixo, onde {ID} corresponde ao ID da plataforma da SX retornado na criação do link de pagamento:
https://sxgiftcards.com/api/parceiro/paymentStatus/{ID}
Com a seguinte estrutura:
Headers
{
"Authorization": "<Chave gerada no painel do parceiro na área de integração>"
}
Caso tudo corra bem com a chamada a resposta será a seguinte:
Body
{
"id": "608b5b7b2f409e2f8f2ec2c1",
"idOrdem": "608b5bb52f409e2f8f2ec2c9",
"emailCliente": "emaildocliente@gmail.com",
"externalId": "608b4818cb1d091fed3d236b",
"value": 430,
"status": "CONCLUIDO"
}
Descrição dos campos:
id - ID único da plataforma SX para identificar o link de pagamento criado, o mesmo do endpoint.
idOrdem - ID da Ordem criada pelo cliente utilizando o link de pagamento. Será retornado apenas se o cliente já tiver iniciado o pagamento, caso contrário a resposta virá sem este campo.
emailCliente - E-mail de cadastro do cliente que realizou o pagamento. Será retornado apenas se o cliente já tiver iniciado o pagamento, caso contrário a resposta virá sem este campo.
externalId - ID que você definiu para identificar o pagamento no seu sistema de gestão.
value - Valor pago pelo cliente em USD.
status - Status atual do pagamento.
Status possíveis do pagamento:
CRIADO - Significa que o link de pagamento foi criado mas um pagamento ainda não foi iniciado pelo cliente.
NAO_PAGO - Significa que o cliente iniciou o pagamento através do link mas não o concluiu.
REVISAO - Significa que a ordem está em revisão antifraude.
PAGO - Significa que o pagamento do cliente foi confirmado. Este status deve ser utilizado para a confirmação de pagamento dentro sistema de gestão.
CONCLUIDO - Significa que o pagamento do cliente já está disponível para saque no painel do parceiro.
CANCELADO - Significa que uma ordem foi criada e cancelada para o link de pagamento. Este status permite que o cliente crie e pague uma nova ordem caso queira, neste caso após o pagamento o status será alterado para PAGO.