Consulta de Cliente

Através da API de Consulta de Cliente é possível verificar se o cliente já é cadastrado no TrayCheckout pelo CPF e/ou Email do mesmo.

Para esta integração, deverá ser feito uso da API a seguir:

Endereço para Integração
Ambiente de Testes https://api.sandbox.traycheckout.com.br/v1/people/get_person_by_cpf_and_email
Ambiente de Produção https://api.traycheckout.com.br/v1/people/get_person_by_cpf_and_email
Protocolo Rest/HTTP

Para a integração com esta API, segue abaixo os dados necessários para envio:

Dados de Entrada Obrig. Formato / Tam. Max Descrição
cpf Sim 1 Texto /14 CPF do Cliente
email Sim 1 Texto /100 E-mail do Cliente

1 A consulta pode ser realizada utilizando os campo cpf e/ou email, não sendo necessário sempre enviar os dois campos.

Veja abaixo uma chamada de API, consultando uma conta através de CPF e E-mail:

    
    <?php
        /* Dados da Consulta */
        $params['cpf'] = '98489882380';
        $params['email'] = 'emaildo@cliente.com.br';

        $urlPost = "https://api.sandbox.traycheckout.com.br/v1/people/get_person_by_cpf_and_email";

        ob_start();

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $urlPost);
        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
        curl_exec($ch);

        /* XML de retorno */ 
        $resposta = simplexml_load_string(ob_get_contents());

        ob_end_clean();
        curl_close($ch);

        if($resposta->message_response->message == "success"){
            //Tratamento dos dados de resposta da consulta.
        }else{
            //Tratamento das mensagens de erro
        }
    ?>
    

A API de Consulta de Conta retorna a resposta em XML.

Abaixo um detalhamento de cada nó do XML de resposta:

XML de Resposta
<people> Nó principal da resposta
<people>
    <message_response>
Nó que contém o resultado da resposta
<people>
    <message_response>
        <message>
Resposta sobre a solicitação
Em caso de sucesso: success
Em caso de erro: error
<people>
    <data_response>
Nó que contém os dados da resposta
<people>
    <data_response>
        <name>
Nome do Cliente
<people>
    <data_response>
        <cpf>
CPF do Cliente
<people>
    <data_response>
        <email>
E-mail do Cliente

Exemplo de resposta com sucesso baseando no envio do exemplo acima:

    
    <people>
<message_response>
<message>success</message>
</message_response>
<data_response>
<name>Nome do Comprador</name>
<cpf>98489882380</cpf>
<email>emaildo@cliente.com.br</email>
</data_response>
</people>

Mensagens de Erro

No caso de erro, a API retorna uma mensagem de erro. Assim é possível identificar o erro ocorrido e realizar o tratamento através do código e/ou mensagem retornada.

Abaixo segue os detalhes de cada nó do XML de resposta:

XML de Resposta
<response> Nó principal da resposta
<response>
    <message_response>
Nó que contém o resultado da resposta
<response>
    <message_response>
        <message>
Resposta sobre a solicitação
Em caso de sucesso: success
Em caso de erro: error
<response>
    <error_response>
Nó que contém os erros encontrados
<response>
    <error_response>
        <general_errors>
Nó que contém os erros encontrados
<response>
    <error_response>
        <general_errors>
            <general_error>
Nó que contém o detalhamento de um erro
<response>
    <error_response>
        <general_errors>
            <general_error>
                <code>
Código do erro
<response>
    <error_response>
        <general_errors>
            <general_error>
                <message>
Mensagem do erro

Exemplo de um retorno com erro:


    <response>
<message_response>
<message>success</message>
</message_response>
<error_response>
<general_errors type="array">
<general_error>
<code>036004</code>
<message>Cliente não encontrado</message>
</general_error>
</general_errors>
</error_response>
</response>

A mensagem de erro retornada pela API está listada na tabela abaixo:

CódigoMensagem
036004 Cliente não encontrado