GuidesAPI ReferenceCommunity
GuidesCommunityLog In

Mensagens de erro

Descrição das mensagens de erro

Erros de consentimento

{
  "errors": [
    {
      "code": "FORMA_PGTO_INVALIDA",
      "title": "Forma de pagamento inválida",
      "detail": "Meio de pagamento inválido"
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "DATA_PGTO_INVALIDA",
      "title": "Data de pagamento inválida",
      "detail": "data de pagamento inválida no contexto, por exemplo, data no passado"
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "NAO_INFORMADO_RESPONSE",
      "title": "Não informado",
      "detail": "Não reportado/indetificado pela instiuição detentora de conta"
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}

Forma de pagamento inválida:

Esta mensagem ocorrerá caso a forma de pagamento seja diferente de PIX.

Outros meios de pagamento serão inclusos no âmbito de Open Banking e esta documentação será atualizada.

Data de pagamento inválida:

Esta mensagem ocorrerá quando a data de pagamento informado for diferente da data atual (D+0)

Dentro da especificação Open Banking é possível realizar PIX agendado (D+1) porém no momento nossa solução não suporta essa funcionalidade.

Dentro da resolução é incluso também o pagamento recorrente porém ainda não é especificação quanto a pagamento recorrente.

Resposta não informada:

Esta mensagem ocorrerá quando a resposta da detentora não for identificado ou não for reportado para a Bit Capital.

Erros de pagamento

❗️

Experiência do usuário

Todas as mensagens de erro referente a pagamento PIX devem atender o requisito mínimo para a experiência do usuário. Na documentação que segue abaixo os erros serão identificados com um informativo a respeito do ponto do guia.

{
  "errors": [
    {
      "code": "SALDO_INSUFICIENTE",
      "title": "Saldo insuficiente.",
      "detail": "Esta conta não possui saldo suficiente para realizar o pagamento."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "BENEFICIARIO_INCOMPATIVEL",
      "title": "Beneficiário incompatível.",
      "detail": "O beneficiário informado no consentimento não é o mesmo do esperado pelo DICT."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "PAGAMENTO_DIVERGENTE_DO_CONSENTIMENTO",
      "title": "Divergência entre pagamento e consentimento.",
      "detail": "Dados do pagamento divergentes dos dados do consentimento."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "CONSENTIMENTO_INVALIDO",
      "title": "Consentimento inválido.",
      "detail": "Consentimento inválido (status não é "authorised" ou está expirado)."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "VALOR_INCOMPATIVEL",
      "title": "Valor da transação incompatível.",
      "detail": "O valor informado no consentimento não é o mesmo valor do informado no payload de pagamento."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "VALOR_ACIMA_LIMITE",
      "title": "Acima do limite estabelecido.",
      "detail": "O valor (ou quantidade de transações) ultrapassa a faixa de limite parametrizada na detentora para permitir a realização de transações pelo cliente."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "DIVERGENTE_QRCODE_PROXY",
      "title": "Divergente QRCode proxy",
      "detail": "Proxy informado no body é divergente ao proxy do QRCode"
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "DIVERGENTE_QRCODE",
      "title": "Divergente QRCode",
      "detail": "O Qrcode informado no pagamento é divergente ao QRCode do consentimento"
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "VALOR_INVALIDO",
      "title": "Valor inválido.",
      "detail": "O valor enviado não é válido para o QR Code informado."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "COBRANCA_INVALIDA",
      "title": "Cobrança inválida.",
      "detail": "Validação de expiração, validação de vencimento, Status Válido."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}
{
  "errors": [
    {
      "code": "NAO_INFORMADO",
      "title": "Não informado.",
      "detail": "Não informada pela detentora de conta."
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "0000-00-00T00:00:00Z"
  }
}

Saldo insuficiente:

Esta mensagem ocorrerá caso o pagador não possua saldo em sua conta na instituição detentora selecionada.

Beneficiário incompatível:

Esta mensagem ocorrerá caso a chave PIX informada no consentimento não seja encontrada no DICT.

📘

Beneficiário incompatível

O requisito mínimo de experiência do usuário define que a mensagem informada pelo cliente deve evidenciar que a transação não foi realizada e que há problema no formato da chave.

Exemplo de mensagens:
Transação não concluída. Formato da chave inválida
Ocorreu um problema no formato da chave. Tente novamente
Ocorreu um erro. Confira o formato dessa chave.
Seu PIX não foi concluído. Verifique o formado da chave informada

Pagamento divergente do consentimento:

Esta mensagem ocorrerá caso algum dado de pagamento seja diferente do informado no consentimento.
Os dados que são validados junto ao consentimento são do objeto details, segue os campos:

  • Forma de iniciação de pagamento (localInstrument)
  • QR Code (qrCode)
  • Chave PIX (proxy)

Consentimento inválido:

Esta mensagem ocorrerá caso uma iniciação de pagamento seja realizada quando o consentimento não estiver no estado de Autorizado (authorised).

Valor incompatível:

Esta mensagem ocorrerá caso o valor informado no pagamento seja diferente do valor informado no consentimento.
O dado que é validado junto ao consentimento é do objeto paymentConsent, segue o campo:

  • Valor (amount)

Valor acima do limite:

Esta mensagem ocorrerá caso o valor informado ultrapasse o limite definido pelo pagador em sua conta na instituição detentora.

Proxy QR code divergente:

Esta mensagem ocorrerá caso a chave PIX informada no pagamento seja divergente a chave PIX informada no QR Code.

QR code divergente:

Esta mensagem ocorrerá caso o QR code Informado no pagamento seja diferente do QR code informado no consentimento.

📘

QR Code divergente

O requisito mínimo de experiência do usuário define que a mensagem informada pelo cliente deve evidenciar que a transação não foi concluída e especifica o erro.

Exemplo de mensagens:
Transação não concluída. QR Code inválido
Erro ao realizar o Pix. QR Code inválido. Faça uma nova tentativa

Valor inválido:

Esta mensagem ocorrerá caso o valor informado no pagamento seja diferente do valor do QR code

Cobrança inválida:

Esta mensagem ocorrerá caso o pagamento esteja com data expirada. Neste caso ocorre uma validação de vencimento. (P.ex. Vencimento do QR Code)

📘

Cobrança inválida

O requisito mínimo de experiência do usuário define que a mensagem informada pelo cliente deve evidenciar que a transação não foi concluída e especifica o erro.

Exemplo de mensagens:
Transação não concluída. QR Code vencido. Esse QR Code não
aceita pagamento após o vencimento.

Pix não realizado.QR Code vencido.

Não informado:

Esta mensagem ocorrerá quando a resposta da detentora não for identificado ou não for reportado para a Bit Capital.


Did this page help you?