Princípios básicos

Retorno padrão

Pensando na facilidade de integração com as APIs da MT Pagamentos, todos os retornos da requisição possuem um retorno padrão, exceto a API de geração de token de acesso.

Exemplo de retorno bem-sucedido

{"StatusCode": 200, "Title": "Success", "Type" : "https://tools.ietf.org/html/rfc7231#section-6.3.1", "Extensions": { "Message": "Consulta realizada com sucesso", "Data" : "object" }}

StatusCode: indica o código de status HTTP da resposta. No exemplo, é "200", o que indica que a solicitação foi bem-sucedida.
Title: fornece uma descrição textual do status da resposta. No exemplo, é "Success", indicando que a operação foi realizada com êxito.
Type: fornece um link para uma especificação ou documentação que descreve o tipo de resposta. No exemplo, é uma referência à seção 6.3.1 da RFC 7231, que é a especificação para códigos de status HTTP.
Extensions: inclui informações adicionais na resposta. No exemplo, há um atributo message que exibe a mensagem indicando que a requisição foi bem sucedida e também o atributo data associada a um objeto, que seria a carga útil da resposta, contendo os dados relevantes para a operação realizada.

Exemplo de retorno malsucedido

{"StatusCode": 400, "Title": "Bad Request", "Type" : "https://tools.ietf.org/html/rfc7231#section-6.5.1", "Extensions": { "errors" : [ { "source": "request:taxNumber", "code": "prospective_client.cpf.invalid", "description": "O CPF é inválido, conforme o módulo 11." } ] }}

Extensions: no exemplo, há uma chave chamada "errors" associada a uma lista de mensagens de erro. Essas mensagens de erro fornecem detalhes específicos sobre o motivo pelo qual a solicitação foi considerada como requisição inválida.