Padrão de resposta

Todos os endpoints disponíveis seguem um mesmo padrão no corpo da resposta da requisição. 
No caso bem sucedido, retornaremos a informação esperada dentro de um campo data;
Já em caso de falha, o data virá vazio, mas adicionaremos um campo error com detalhes do problema. 
Em todos os casos, retornamos um campo status, que replica o status da requisição.
Seguimos a RFC 2616. 
Segue um exemplo de sucesso:
{
    "data": {
        "id": "9f191a91f151e894d6dfe4bcaa7d36e498f9331e2c3a5f74fa60fef5468e520d",
        "fields": null,
        "createdAt": "2020-06-11T16:14:25.000Z",
        "balances": [
            {
                "assetId": "92ab92ac7f8a8e331f69cd2d22c21cf00f90a77a3317d153a154b0c871dd8887",
                "amount": "126.78"
            },
            {
                "assetId": "478a17fa01925abf10b06181ec08341d761e86d6dff0fa78f18e2329dd4e09ed",
                "amount": "0"
            }
        ]
    },
    "status": 200
}
E um exemplo de falha:
{
    "status": 401,
    "error": {
        "name": "UNAUTHORIZED",
        "message": "Não autorizado.",
        "code": "UNAUTHORIZED",
        "subErrors": []
    }
}
Para detalhes sobre nosso modelo de paginação, consulte esta página.
Last modified 2yr ago