Referência

Padrão de Respostas

Todas as respostas da API seguem uma estrutura JSON consistente. Entender este padrão facilita o tratamento de erros e o processamento de dados na sua integração.

Resposta de Sucesso

Quando uma requisição é processada com sucesso, a API retorna HTTP 200 OK com o seguinte formato:

Formato de sucessojson

{
  "data": {
    // Dados retornados pelo endpoint
  },
  "success": true
}

Resposta de Erro

Quando ocorre um erro, a API retorna o código HTTP apropriado (4xx ou 5xx) com o seguinte formato:

Formato de errojson

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Dados de requisição inválidos",
    "details": []
  },
  "success": false
}

Status de Transações PIX

O campo status em transações PIX pode assumir os seguintes valores:

PENDING

Aguardando Pagamento

A transação foi criada e aguarda o pagamento via PIX pelo cliente.

AUTHORIZED

Pago e Autorizado

O pagamento foi confirmado e a transação está autorizada.

FAILED

Falhou

Houve uma falha no processamento da transação.

CHARGEBACK

Chargeback Iniciado

Uma contestação foi iniciada pelo cliente junto ao banco.

IN_DISPUTE

Em Disputa

A transação está sob análise de disputa.

Status de Cashouts

approved

Cashout aprovado e transferência concluída

pending

Cashout aguardando processamento

processing

Cashout em processamento pelo banco

failed

Falha no processamento do cashout

rejected

Cashout rejeitado pela instituição financeira

Dica de implementação

Sempre verifique o campo success antes de processar o campo data. Trate os erros verificando o campo error.message para mensagens descritivas.