Você pode criar um link de pagamento e depois direcionar o cliente para realizá-lo. O cliente poderá se cadastrar na plataforma, caso ainda não tenha cadastro e depois realizar o pagamento, os dados enviados na criação deste link serão mantidos até o final do pagamento.


Uma chamada JSON do tipo POST deve ser realizada para o endpoint:


https://sxgiftcards.com/api/parceiro/paymentNew


Com a seguinte estrutura:


Headers

{

    "Authorization": "<Chave gerada no painel do parceiro na área de integração>"

}


Body

{

    "email": "emaildocliente@gmail.com",

    "value": 430,

    "externalId": "608b4818cb1d091fed3d236b"

}


Descrição dos campos:

email - Email do cliente do tipo String.

value - Valor do pagamento em USD do tipo Inteiro.

externalId - ID utilizado pelo seu sistema de gestão para identificar o pagamento. Tipo String.


Caso tudo corra bem com a chamada a resposta será a seguinte (Status: 200):


Body

{

  "id": "608b5054b09661258f21debf",

  "paymentLink": "https://sxgiftcards.com/lp/608b5054b09661258f21debf",

  "externalId": "608b4818cb1d091fed3d236b",

  "value": 430,

  "status": "CRIADO"

}


Descrição dos campos:

id - ID único da plataforma SX para identificar o link de pagamento criado.

paymentLink - Link para o qual o cliente deverá ser direcionado para iniciar o pagamento.

externalId - ID que você definiu para o pagamento para identificá-lo no seu sistema de gestão. Este ID deve ser único para cada link de cobrança criado.

value - Valor em USD.

status - Status atual do pagamento. (Status possíveis: CRIADO | NAO_PAGO | REVISAO | PAGO | CONCLUIDO | CANCELADO)


Caso algum erro ocorra a resposta será a seguinte:


Body

{

    "error": "<Mensagem descrevendo o erro>"

}



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 mas o link de resgate ainda não foi disponibilizado para o parceiro. Este status deve ser utilizado para a confirmação de pagamento dentro sistema de gestão.
CONCLUIDO - Significa que o pagamento foi confirmado e que o link para resgate do valor já está disponível para o parceiro.

CANCELADO - Significa que uma ordem foi criada e cancelada para o link de pagamento. O cliente pode criar uma nova ordem e pagar caso queira, neste caso após o pagamento o status será alterado para PAGO.