Retornos

Por se tratar de uma API REST , os Status HTTP retornados são tão relevantes quanto as resposta retornadas no corpo de uma requisição à API.

O corpo da requisição retornada será sempre JSON ("JavaScript Object Notation"), bem conhecida por ser o formato de representação de objetos do javascript e que tem sido cada vez mais utilizada principalmente em API's que utilizam o conceito de REST.

Exemplos de retorno

Abaixo seguem exemplos de erro sendo retornado em formato JSON pela API.

Erro ocorrendo no servidor do meio de pagamento:

{ "transacao":{ "erro":{
      "codigo":"999","mensagem":"TRANSACAO DESFEITA"
} } }

Erro ocorrendo no Gateway de Pagamento:

{ "transacao":{ "erro":{
      "codigo":"001","mensagem":"Credenciais inv\u00e1lidas"
} } }

Operação executada com sucesso:

{
  "transacao": {
    "id": 314,
    "status": "paga",
    "meio_pagamento": "redecard_ws",
    "numero_pedido": 123,
    "total": "100.00",
    "detalhes": {
      "numero_sequencial": "948",
      "numero_comprovante_venda": "7227",
      "numero_autenticacao": "9002",
      "numero_autorizacao": "4243",
      "url_comprovante": "https://ecommerce.redecard.com.br/pos_virtual/cupom.asp?DATA=20120306&TRANSACAO=201&NUMAUTOR=4243&NUMCV=7227&FILIACAO=1234567890"
    },
    "erro": null
  }
}

Status HTTP

As operações executadas no gateway podem retornar os seguintes códigos HTTP com suas respostas:

Status	Definição	Descrição
200	Sucesso	O recurso ou a operação foi executada com sucesso e você deve receber os dados no corpo do retorno.
201	Criado	O recurso e você tentou acessar foi criado com sucesso , esse código provavelmente será visto no retorno de uma requisição de criação executada com sucesso.
301	Movido Permamentemente	A Url que você está tentando acessar foi movida , provavelmente você está sendo redirecionado pelo gateway para o ambiente de um meio de pagamento.
304	Não Modificado	Você já havia requisitado esse conteudo antes e ele não foi modificado desde a ultima request.
400	Requisição Incorreta	A requisição que foi enviada estava malformatada ou incorreta e por isso sua requisição falhou, recomendamentos checar o JSON que está sendo enviado.
401	Não Autorizado	Você não tem permissão para acessar o dado requisitado, provavelmente o token enviado está incorreto.
404	Recurso não encontrado	A transação ou recurso desejado não existe em nossos registros.
500	Erro Interno no Servidor	Ocorreu um erro interno no sistema do gateway, entre em contato com o suporte da locaweb.