Formato das Respostas

Todas as respostas da API pública sob o namespace /v1 utilizam um envelope JSON unificado para respostas de sucesso e mensagens de erro.

Envelope de Sucesso (HTTP 2xx)

O campo data inclui o recurso individual retornado ou a lista de entidades, acompanhado de metadados em meta.

Estrutura de Sucesso

{
  "success": true,
  "data": {
    "id": "pay_982f1b4c7a10",
    "amount": 1500.00,
    "currency": "MZN",
    "status": "completed"
  },
  "meta": {
    "request_id": "req_8f192b0c44e2",
    "timestamp": "2026-11-07T12:00:00Z"
  }
}

Envelope de Erro (HTTP 4xx / 5xx)

Quando ocorre um erro, a chave error contém detalhes estruturados: type, code, message e details específicos dos campos invalidados.

Estrutura de Erro

{
  "success": false,
  "error": {
    "type": "invalid_request_error",
    "code": "amount_below_minimum",
    "message": "The transaction amount is below the minimum required for this payment method.",
    "details": {
      "field": "amount",
      "minimum": 10.00,
      "provided": 5.00
    }
  },
  "meta": {
    "request_id": "req_9921cba34011",
    "timestamp": "2026-11-07T12:01:05Z"
  }
}