Termos utilizados:

Parceiro: Redirecionador/Personal shopper que faz seus recebimentos com a SX.

Cliente: Cliente final do Redirecionador/Personal shopper que faz o pagamento com a SX.


Nossa plataforma trabalha de forma ativa, enviando uma chamada para o sistema de gestão integrado. Sempre que houver um novo pagamento confirmado e liberado para o parceiro, enviaremos uma chamada do tipo POST para a URL informada na área de integração do painel de parceiro com um conteúdo do tipo JSON contendo a seguinte estrutura:


HEADER

ChaveTipoDescrição
AuthorizationStringChave responsável por confirmar que de fato o sistema que está enviando a chamada é da SX, uma forma de autenticação da chamada. O parceiro pode obter a chave diretamente no seu painel, ela é gerado quando uma URL de integração é definida.


BODY

ChaveTipoDescrição
timestampIntTimestamp do momento exato em que a chamada foi disparada pela primeira vez.
idParceiroStringID único que identifica qual parceiro está sendo pago. Pode ser obtido no painel do parceiro.
idOrdemString

ID único que identifica o pagamento. Você deve fazer tratamentos internos utilizando este campo para que em caso de duplicidade na chamada por qualquer motivo não sejam constados pagamentos duplicados.


emailClienteString

Esta é a chave que irá identificar qual cliente fez o pagamento, uma conciliação. O e-mail de cadastro do cliente deverá ser o mesmo tanto no sistema de gestão quanto na nossa plataforma para que tudo funcione de acordo.


valorPagoFloatValor em USD que foi pago.


Exemplo:

//Header
{
    "Authorization": "auhsrq94w8ew8r09j0wj8fu9834",
}
//Body
{    
    "timestamp": 1604627702,
    "idParceiro": "5fa46dd2760f63001608fa6d",
    "idOrdem": "5fa4a47f145517001601f365",
    "emailCliente": "emailcliente@hotmail.com",
    "valorPago": 1098.86
}


O sistema espera receber de volta qualquer resposta com http status code 200. Caso um status diferente seja recebido na chamada o sistema tentará uma nova chamada a cada 10 minutos até que um status 200 seja retornado.


Nosso sistema não exige uma prévia comunicação do pagamento que será feito, cada parceiro possui um link único que pode enviar para que seus clientes paguem. Então não precisaremos receber nada do sistema de gestão previamente. A identificação para o pagamento dentro do sistema de gestão deve ser feita utilizando o e-mail do cliente. Caso você queira disponibilizar dentro do seu sistema o link único de pagamento do parceiro o endereço é o seguinte:


https://sxgiftcards.com/lu/{idParceiro}


Este link possibilitará que o cliente faça cotação, escolha de forma de pagamento, cadastro (caso ainda não possua) e o pagamento, ou seja, o processo completo de pagamento.


Após concluir a integração você pode solicitar que o parceiro faça uma chamada de teste através do botão "Chamada de teste para a URL" presente na área de integração do painel de parceiro. Este botão irá enviar uma chamada com o mesmo e-mail do cliente no exemplo acima. O teste retornará para o parceiro se tudo correu bem ou se houve algum erro.


Abaixo dois prints da tela de integração no painel de parceiro caso você (desenvolvedor) precise instruí-lo no preenchimento dos dados.

Print sem URL de integração definida (integração desativada):


Print com a URL  de integração definida (integração ativada):


Se você precisar de auxilio adicional teremos prazer em ajudá-lo através do e-mail info@sxgiftcards.com.