O retorno das requisições de cadastro contém a confirmação de que o comando foi executado com sucesso. Em alguns casos, como no comando add-customer, ele também traz de volta informações que serão usadas para fazer referência ao cadstro do cliente no futuro. Estas informações são enviadas dentro do elemento .

 

Estrutura do XML de retorno

 

<api-response>
    <errorCode/>
    <errorMessage/>
    <command/>
    <time/>
    <result>
        ...
    </result>
</api-response>

 

Parâmetros retornados pelas requisições de cadastro

 

Os parâmetros retornados pelas requisições de cadastro são:

Nome

Descrição

errorCode

Còdigo de retorno da operação. Sucesso = 0

errorMessage

Mensagem de erro, se houver

command

Confirmação do comando enviado

time

Data/hora da transação em formato epoch

customerId

Presente só no comando add-consumer. É retornado o ID único daquele cliente, dentro do elemento .
É muito importante guardar esta informação para futura referência!

token

Presente só no comando add-card-onfile. É retornado o token único daquele cartão, dentro do elemento .
É muito importante guardar esta informação para futura referência!