Sempre que houver um novo pagamento confirmado e liberado para o parceiro, enviaremos uma chamada do tipo POST para a URL informada no painel do 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. Cada parceiro pode gerar a chave diretamente no seu painel.


BODY

ChaveTipoDescrição
timestampIntTimestamp do momento exato em que a chamada é disparada.
idParceiroStringID único que identifica qual parceiro está sendo pago.
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 de qual cliente veio o pagamento. Use este campo para saber pra quem vai o crédito.


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. O parceiro terá um campo em cada ordem dentro do seu painel onde poderá verificar se o disparo de integração foi enviado para o sistema de gestão com sucesso (status code 200 como retorno), ou não.


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 feito pelo e-mail do cliente.


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.