Pagamentos e Transferências

A API de Pagamentos e transferências permite que você efeitue pagamentos de diversos tipos e realize transferências de PIX, TED, TEF. Esta API permite também realizar o cancelamento e a listagem dos pagamentos e transferências.

Casos de Uso

Inserir numa plataforma a possibilidade de pagar contas.
Receber notificações de pagamentos.

Segurança

📘
BTG Id
O Authorization Server do BTG Empresas se chama BTG Id. Usando o BTG Id, um aplicativo parceiro consegue consentimento e autorização para executar operações nas APIs do BTG em nome do cliente. Para saber mais, acesse a documentação do BTG Id

Idempotência

A API de pagamentos e transferência do BTG Pactual Empresas utiliza a idempotência como forma de garantir que você possa repetir uma requisição, em casos adversos como por exemplo uma perda de conexão, sem o risco de duplicar uma operação.

Isto é feito por meio de um header x-idempotency-key.

x-idempotency-key é utilizado para passar a chave de idempotência definida pelo usuário. Aceita qualquer valor.

A chave presente em x-idempotency-key ficará atrelada ao operador que emitiu o token. Assim, operadores diferentes podem usam a mesma chave, contanto que estejam utilizando token diferentes.

Recomendamos que seja utilizado um uuid para cada requisição que posteriormente será armazenado por vocês para controle. Assim, caso não haja resposta da API e o mesmo uuid seja utilizado, a requisição não será duplicada.

📘
Exemplo

curl --location 'https://api.empresas.btgpactual.com/1111111111/banking/payments?pageSize=10&pageNumber=1' \
--header 'Authorization: ••••••' \
--header 'x-idempotency-key: f08jjj6b-00bc-1e3e-ad99-acb353333914'

Caso não seja enviado o x-idempotency-key, a API entenderá que não deseja utilizar a idempotência e, assim, assumirá o comportamento padrão.

Escopos necessários

O token para consumir a API de Pagamentos deve ser gerado usando o Authorization Code.

O escopo openidé obrigatório. Ele permite consultar o perfil do usuário BTG com acesso à conta.

É necessário escolher um dos seguintes escopos:

Escopo	Descrição
`empresas.btgpactual.com/payments`	Permite criar e consultar pagamentos.
`empresas.btgpactual.com/payments.readonly`	Permite consultar pagamentos.

Recursos Disponíveis

Os recursos da API de Pagamentos estão disponíveis no API Reference.

📘
API Reference
Pagamentos e Transferências

Modalidades de pagamentos e transferências

A API de pagamentos de transferências oferecem uma serie de modalidades de pagamento, diferenciando entre si somente nos dados enviados no corpo da requisição dentro do objeto details e no tipo selecionado.

PIX_QR_CODE

Esta modalidade exige que seja informado dentro do details o emv, também chamado de código do copia e cola, do QR code. Esta modalidade cria uma iniciação de um pagamento ou transferência do tipo PIX.

BANKSLIP

Esta modalidade exige que seja informado dentro do details a linha digitável digitableLine do boleto a ser pago. Não aceita linhas digitáveis que se iniciam com 8

UTILITIES

Esta modalidade exige que seja informado dentro do details a linha digitável digitableLine da conta de utilidades(conta de energia, água...) ou FGTS a ser pago. Aceita linhas digitáveis que se iniciam com 8.

TED e PIX_MANUAL

Esta modalidade exige que seja informado dentro do details as informações da conta do beneficiário do pagamento ou transação. O tipo do pagamento ou transferência depende do tipo informado:

PIX_MANUAL consiste num PIX
TED consiste em um TED ou TEF com base no que é informado.

PIX_KEY

Esta modalidade exige que seja informado dentro do details uma chave pix válida de qualquer tipo. Origina um pagamento ou transferência do tipo PIX

DARF

Esta modalidade exige que sejam informados dentro do details as informações do documento a ser pago.

PIX_REVERSAL

Esta modalidade exige que seja informado dentro do details o originalEndToEndId do pix recebido. Esta modalidade consiste em uma devolução de pix recebido para a conta de onde se originou a transação.

Status de pagamentos e máquina de estados

Um pagamento pode ter diversos status.

Status	Descrição
CREATED	Pagamento online em processamento.
CONFIRMED	Pagamento confirmado
REVERTED	Pagamento estornado
FAILED	Falha no pagamento
SCHEDULED	Pagamento agendado
ADJOURNED	Pagament em retentativa, será reprocessado pelo sistema
PROCESSED	Pagamento processado
CANCELED	Pagamento cancelado

Os status CANCELED, FAILED e REVERTED não podem ser revertidos. Ao receber esses status, um pagamento é fechado.

O status CONFIRMED indica que houve débito na conta de origem, mas pode ser estornado:

Eventos de webhook

A propriedade "detail" assumirá o formato referente ao seu "type". Consulte a API Reference de Criar iniciação de pagamento ou transferência

Eventos possíveis

payments.*
payments.confirmed
payments.created
payments.canceled
payments.failed
payments.processed
payments.adjourned
payments.reverted
payments.scheduled

payments.adjourned

{
    "eventId": "payments.adjourned",
    "message": {
      "tags": { "externalId": "83406184-4115-4386-a90c-58b9727cec9f" },
      "type": "BANKSLIP",
      "amount": 1646.5,
      "detail": {
        "fine": 0,
        "payee": {
          "taxId": "1111111111",
          "bankCode": "208",
          "socialName": "NOME",
          "fantasyName": "NOME DE FANTASIA"
        },
        "barcode": "99999966300009999991090000051649999989343000",
        "dueDate": "2024-03-22",
        "discount": 0,
        "interest": 0,
        "bankSlipType": "BIT",
        "digitableLine": "99999966300009999991090000051649999989343000",
        "expirationDate": "2034-03-22"
      },
      "errors": [{ "code": "insufficient-balance" }],
      "status": "ADJOURNED",
      "paymentId": "e18d5387-87e2-4d7c-b604-b9f2956a6525",
      "debitParty": {
        "name": "Nome",
        "taxId": "11111111",
        "number": "1234567",
        "bankCode": "208",
        "branchCode": "50"
      },
      "paymentDate": "2024-03-22",
      "scheduledDate": "2024-03-22"
    }
  }

payments.failed

{
    "eventId": "payments.failed",
    "message": {
      "tags": { "externalId": "boleto234744" },
      "type": "BANKSLIP",
      "amount": 125,
      "detail": {
        "fine": 0,
        "payee": {
          "taxId": "11111111",
          "bankCode": "208",
          "socialName": "Nome",
          "fantasyName": "Nome de fantasia"
        },
        "barcode": "111111111111111111111111111111",
        "dueDate": "2024-03-18",
        "discount": 0,
        "interest": 0,
        "bankSlipType": "BIT",
        "digitableLine": "11111111111111111111111111111",
        "expirationDate": "2024-03-18"
      },
      "errors": [{ "code": "operation-expired" }],
      "status": "FAILED",
      "paymentId": "7b87f46c-4fe2-49b3-85f9-84c02cad051c",
      "debitParty": {
        "name": "Nome",
        "taxId": "111111111",
        "number": "11111111",
        "bankCode": "208",
        "branchCode": "50"
      },
      "paymentDate": "2024-03-13",
      "scheduledDate": "2024-03-13"
    }
  }

payments.canceled

{
    "eventId": "payments.canceled",
    "message": {
      "tags": {},
      "type": "BANKSLIP",
      "amount": 95,
      "detail": {
        "payee": {
          "taxId": "11111111",
          "bankCode": "208",
          "socialName": "NOME",
          "fantasyName": "NOME DE FANTASIA"
        },
        "barcode": "1111111111111111111111111",
        "dueDate": "2024-02-10",
        "digitableLine": "11111111111111111111"
      },
      "category": "BANKSLIP",
      "paymentId": "a38c803b-ef9e-45a3-9251-be7dde4a30c4",
      "debitParty": {
        "name": "Nome",
        "taxId": "11111111111",
        "number": "1111111",
        "bankCode": "208",
        "branchCode": "50"
      },
      "scheduledDate": "2024-02-14"
    }
  }

payments.reverted

{
    "eventId": "payments.reverted",
    "message": {
      "tags": {},
      "type": "TED",
      "amount": 128,
      "detail": {
        "creditParty": {
          "name": "NOME",
          "taxId": "1111111111",
          "account": {
            "ispb": "90400888",
            "type": "PP",
            "branch": "3561",
            "number": "0324134124",
            "bankCode": "033"
          }
        }
      },
      "errors": [{ "code": "incorrect-receiver-data" }],
      "status": "REVERTED",
      "paymentId": "8e454e0d-5b9e-425a-b7cd-e5ba9dc6a5db",
      "debitParty": {
        "name": "NOME",
        "taxId": "1111111111111",
        "number": "12412341234",
        "bankCode": "208",
        "branchCode": "50"
      },
      "paymentDate": "2024-03-11",
      "scheduledDate": "2024-03-11"
    }
  }

payments.processed

{
    "eventId": "payments.processed",
    "message": {
      "tags": { "externalId": "boleto211179" },
      "type": "BANKSLIP",
      "amount": 150,
      "detail": {
        "fine": 0,
        "payee": {
          "taxId": "11111111111",
          "bankCode": "341",
          "socialName": "nome",
          "fantasyName": "nome de fantasia"
        },
        "barcode": "111111111111111111",
        "dueDate": "2024-03-10",
        "discount": 0,
        "interest": 0,
        "bankSlipType": "BIT",
        "digitableLine": "111111111111111111",
        "expirationDate": "2024-06-08"
      },
      "status": "PROCESSED",
      "paymentId": "9529d0ce-6e03-40fa-9445-95f614133d60",
      "debitParty": {
        "name": "NOME",
        "taxId": "11111111111",
        "number": "1234123421",
        "bankCode": "208",
        "branchCode": "50"
      },
      "paymentDate": "2024-03-11",
      "scheduledDate": "2024-03-11"
    }
  }

payments.created

{
    "eventId": "payments.created",
    "message": {
        "paymentId": "b2e2cfa6-2b39-45af-8865-30594748f496",
        "type": "PIX_KEY",
        "amount": 973,
        "scheduledDate": "2024-11-15",
        "paymentDate": "2024-11-15",
        "status": "CREATED",
        "debitParty": {
            "taxId": "11111111111",
            "name": "NOME",
            "number": "111111111",
            "branchCode": "50",
            "bankCode": "208"
        },
        "detail": {
            "key": {
                "value": "example-de-chave",
                "type": "TAX_ID"
            },
            "endToEndId": "E303061142111111118111e3b49d67b8",
            "creditParty": {
                "taxId": "11188136911",
                "name": "NOME CREDIT PARTY",
                "account": {
                    "type": "11",
                    "number": "123123123",
                    "branch": "50",
                    "bankCode": "208",
                    "ispb": "123123"
                }
            }
        },
        "tags": {
            "externalId": "2145265"
        }
    }
}

payments.scheduled

{
    "eventId": "payments.scheduled",
    "message": {
      "type": "BANKSLIP",
      "amount": 163.46,
      "detail": {
        "payee": {
          "taxId": "42383685000142",
          "bankCode": "41",
          "socialName": "NOME",
          "fantasyName": "NAO INFORMADO"
        },
        "barcode": "11111111111111111",
        "digitableLine": "11111111111111111111111111111111"
      },
      "batchId": null,
      "category": "BANKSLIP",
      "paymentId": "70c482c8-020a-4236-8831-a44fd5f010a5",
      "debitParty": {
        "name": "",
        "taxId": "12431241243214",
        "number": "123123123123",
        "bankCode": "208",
        "branchCode": "50"
      },
      "paymentDate": "2024-03-15T00:00:00",
      "scheduledDate": "2024-03-15T00:00:00"
    }
  }

payments.confirmed

{
    "eventId": "payments.confirmed",
    "message": {
      "tags": { "externalId": "boleto197054" },
      "type": "BANKSLIP",
      "amount": 3000,
      "detail": {
        "fine": 0,
        "payee": {
          "taxId": "132412341234",
          "bankCode": "341",
          "socialName": "nome",
          "fantasyName": "nome de fantasia"
        },
        "barcode": "12341234123412412421341242143",
        "dueDate": "2024-03-10",
        "discount": 0,
        "interest": 0,
        "bankSlipType": "BIT",
        "digitableLine": "11111111111111111111111111111",
        "expirationDate": "2024-06-08"
      },
      "status": "CONFIRMED",
      "paymentId": "bc09a2cd-990f-466d-83e5-e18806fc3470",
      "debitParty": {
        "name": "nome",
        "taxId": "23412431234",
        "number": "1243214214214",
        "bankCode": "208",
        "branchCode": "50"
      },
      "paymentDate": "2024-03-11",
      "scheduledDate": "2024-03-11"
    }
  }

payments.confirmed no caso de PIX

{
    "paymentId": "999ed999-e2e3-999b-abdd-b6dc9999ef1d",
    "type": "PIX_KEY", //Pode assumir o valor de qualquer um dos tipos de PIX
    "amount": 1,
    "scheduledDate": "2024-06-04",
    "paymentDate": "2024-06-04",
    "status": "CONFIRMED",
    "debitParty": {
        "taxId": "9999995980990112",
        "name": "EXEMPLO",
        "number": "0099999941",
        "branchCode": "50",
        "bankCode": "208"
    },
    "detail": {
        "creditParty": {
            "taxId": "499999990009999",
            "name": "Criar Agencia",
            "account": {
                "type": "CC",
                "number": "39999919",
                "branch": "1",
                "bankCode": "999",
                "ispb": "99899899096"
            }
        },
        "key": {
            "type": "TAX_ID",
            "value": "9999995999915"
        },
        "endToEndId": "E9999999999041446999999d16d"
    },
    "tags": {}
}

Códigos de erro

Abaixo estão os erros possíveis ao realizar uma requisição na API juntamente com as suas descrições. Todos os erros estarão prefixados na response com btg:enterprise:banking:payments

Erro	Descrição
account-not-found	Conta não encontrada.
aegis-integration-error	Houve um erro durante a geração do contrato. Cheque seu extrato antes de tentar novamente.
amount-above-limit	O valor do boleto é acima do permitido. Por favor realize o pagamento em outra instituição financeira.
amount-below-limit	O valor do boleto é abaixo do permitido. Por favor realize o pagamento em outra instituição financeira.
amount-doesnt-match	O valor do pagamento não corresponde ao valor informado.
balance-rejected	Saldo insuficiente.
bank-code-not-found	Código do banco não encontrado.
bankslip-canceled	O boleto não está mais disponível para pagamento. O mesmo pode já ter sido pago ou cancelado pela instituição que o emitiu.
batch-id-with-different-owner	Este pagamento não pode ser adicionado ao lote.
batch-not-found	Lote não encontrado.
blocked-account-status	Não é possível movimentar uma conta totalmente bloqueada.
business-day-validation-error	Não foi possível validar se é dia útil.
cannot-adjourn-payment	Não foi possível adiar o pagamento.
cannot-cancel-payment	Não foi possível cancelar o agendamento do pagamento.
cannot-confirm-payment	Não foi possível efetuar o pagamento.
cannot-confirm-without-authentication-code	Não é possível confirmar o pagamento sem código de autenticação.
cannot-confirm-without-settlement-date	Não é possível confirmar o pagamento sem data de liquidação.
cannot-fail-payment	Não foi possível falhar o pagamento.
cannot-process-payment	Não foi possível processar o agendamento do pagamento.
cannot-revert-payment	Não foi possível reverter o pagamento.
cannot-schedule-overdue-payment	Pagamento não pode ser agendado após a data de vencimento.
cannot-schedule-payment	Não foi possível agendar o pagamento.
cannot-translate-confirm-event	Erro ao traduzir o evento de confirmação de pagamento.
cash-grid-not-open	A grade horária não está aberta para essa operação.
cash-grid-validation-error	Não foi possível validar grade de liquidação.
closing-account-status	Não é possível movimentar uma conta em processo de encerramento.
contract-expiration-overdue	Operação expirada, por favor refaça o pagamento.
covenant-not-allowed	Este boleto só pode ser pago em instituições afiliadas.
customer-service	Consulte o atendimento ao cliente.
debit-party-different-from-original-movement	Conta de saída deve ser a mesma do movimento original.
duplicate-payment	Erro ao efetuar o pagamento. Operação já efetuada ou em andamento.
empty-account	Não foi possível efetuar o pagamento. Não encontramos a conta informada.
empty-bank-slip-type	Categoria do boleto não informada.
empty-credit-account	Não foi possível efetuar o pagamento. Não encontramos a conta de crédito informada.
empty-credit-party	Não foi possível efetuar o pagamento. Dados do recebedor não informados.
empty-party	Não foi possível efetuar o pagamento. Dados do pagador não informados.
emv-invalid	Emv é inválido.
emv-required	Emv é obrigatório.
error-adjourn-payment	Ocorreu um erro ao adiar o pagamento.
error-cancel-payment	Ocorreu um erro ao cancelar o pagamento.
error-checking-activation-account	Não foi possível verificar o status da conta.
error-confirm-payment	Ocorreu um erro ao confirmar o pagamento.
error-create-payment	Ocorreu um erro ao criar o pagamento.
error-create-payment-event	Ocorreu um erro ao criar o evento de pagamento.
error-decode-filters	Erro ao filtrar os pagamentos. Verifique os parâmetros de filtro.
error-dispatch-payment	Ocorreu um erro ao efetuar o pagamento.
error-fail-payment	Ocorreu um erro ao falhar o pagamento.
error-invalid-settlement-date	Não foi possível criar a data de liquidação. Valor vazio.
error-retrieving-account	Não foi possível obter os dados da conta.
error-retrieving-account-information	Error ao efetuar o pagamento. Tente novamente mais tarde.
error-revert-payment	Ocorreu um erro ao reverter o pagamento.
error-validate-balance-account	Erro ao validar saldo para operação.
escrow-account	Não foi possível efetuar o pagamento. Conta de garantia não permite essa operação.
expired-barcode-or-digitable-line	Boleto vencido.
expired-payment-date	Data de pagamento inválida.
expired-qr-code	Esse código QR já está expirado.
failed-to-parse-close-date	Não foi possível calcular a data de fechamento da devolução do PIX.
forbidden	Operação não autorizada.
identifier-reused	Ocorreu um erro interno. Tente novamente mais tarde.
inactive-account	Não foi possível efetuar o pagamento. Conta inativa ou bloqueada.
inactive-account-status	Não é possível movimentar uma conta encerrada.
inactive-credit-account	Não foi possível efetuar o pagamento. Conta creditada inativa ou bloqueada.
incorrect-receiver-data	Dados do beneficiário inválidos, verifique o CPF/CNPJ e dados da conta antes de tentar novamente.
institution-does-not-support-payment-type	Instituição do beneficiário não aceita este tipo de pagamento.
insufficient-balance	Erro ao efetuar o pagamento. Saldo insuficiente.
integration-error	Ocorreu um erro interno. Tente novamente mais tarde.
integration-timeout-error	Seu pagamento está sendo processado. Verifique o extrato e a área de pagamentos.
internal	Ocorreu um erro interno. Tente novamente mais tarde.
invalid-account	Conta bancária inválida.
invalid-account-status	Erro ao efetuar o pagamento. Dados da conta inválidos. Entre em contato com atendimento através do nosso chat.
invalid-account-type	Não foi possível efetuar o pagamento. O tipo da conta de débito é invalido.
invalid-account-type-ii	Erro ao efetuar o pagamento. Operação negada pois a conta selecionada não está apta. Entre em contato com atendimento através do nosso chat.
invalid-amount	Valor inválido.
invalid-amount-comparison	A soma dos valores principal, juros e multa difere do valor total.
invalid-authentication-code	Código de autenticação inválido.
invalid-barcode-or-digitable-line	Código de barras ou linha digitável é inválido.
invalid-base-payment	Não foi possível efetuar o pagamento. Este não é um pagamento base.
invalid-branch	Agência inválida.
invalid-business-day	Erro ao efetuar o pagamento. Data de pagamento inválida.
invalid-business-day-date	Data de pagamento inválida. A data de pagamento válida mais próxima é {{newDate}}.
invalid-credit-account	Conta crédito é inválida para essa operação.
invalid-credit-account-type	Não foi possível efetuar o pagamento. Tipo de conta de crédito informado é inválido.
invalid-date-time	Data e hora inválidos.
invalid-ddi	DDI inválido.
invalid-description	Descrição inválida.
invalid-digitable-line	Linha digitável inválida.
invalid-dynamic-pix-qr-code-info-identifier	O location do Qr Code é inválido.
invalid-end-to-end-id	Ocorreu um erro interno, tente novamente mais tarde.
invalid-fgts-barcode	Código de barras inválido.
invalid-format-business-day-date	Data com formato inválido {{date}}.
invalid-ispb	ISPB inválido.
invalid-json-input	Entrada inválida. Deve ser em formato JSON.
invalid-json-schema-field-account-type	Campo {{fieldName}} é inválido. Tipo de conta não suportado.
invalid-json-schema-field-amount	Parâmetro {{fieldName}} é inválido. Deve ser numérico e maior que 0.
invalid-json-schema-field-bank-code	Campo {{fieldName}} é inválido. Deve ser numérico com três dígitos.
invalid-json-schema-field-bank-slip-digitable-line	Campo {{fieldName}} é inválido. Deve ser numérico com 47 ou 48 dígitos.
invalid-json-schema-field-barcode	Campo {{fieldName}} é inválido. Deve ser numérico com 44 dígitos.
invalid-json-schema-field-barcode-or-digitable-line	digitableLine ou barcode são obrigatórios.
invalid-json-schema-field-branch	Campo {{fieldName}} é inválido. Deve ser numérico com um ou mais dígitos.
invalid-json-schema-field-date	Campo {{fieldName}} é inválido. A Data deve ser no formato yyyy-mm-dd.
invalid-json-schema-field-date-time	Campo {{fieldName}} é inválido. O tempo e data deve estar no formato: YYYY-MM-DDThh:mm:ss.SSSZ.
invalid-json-schema-field-description	Descrição inválida. Deve possuir tamanho máximo de 140 caracteres, contendo apenas letras, números e espaços.
invalid-json-schema-field-digitable-line	Campo {{fieldName}} é inválido. Deve ser numérico com 47 ou 48 dígitos.
invalid-json-schema-field-emv	Campo {{fieldName}} é inválido. Deve estar em um formato emv válido.
invalid-json-schema-field-gte-number	Campo {{fieldName}} é inválido. Precisa ser um valor numérico maior ou igual a {{fieldParam}}.
invalid-json-schema-field-id	Campo {{fieldName}} é inválido. Deve ser um identificador unico universal (uuid).
invalid-json-schema-field-ispb	Campo {{fieldName}} é inválido. Deve ser numérico com oito dígitos.
invalid-json-schema-field-lte-number	Campo {{fieldName}} é inválido. Precisa ser um valor numérico menor ou igual a {{fieldParam}}.
invalid-json-schema-field-name	Campo {{fieldName}} é inválido. Deve possuir caracteres alfanumericos, espaços, hífens e apóstrofos.
invalid-json-schema-field-number	Campo {{fieldName}} é inválido. Deve ser numérico.
invalid-json-schema-field-numeric	Campo {{fieldName}} é inválido. Deve ser numérico.
invalid-json-schema-field-payment-end-to-end-id	Campo {{fieldName}} é inválido. Deve iniciar com o prefixo E seguido pelo ISPB da instituição iniciadora seguido de tempo e data no formato YYYYMMDDhhmm e onze caracteres alfanuméricos.
invalid-json-schema-field-pix-key-type	Campo {{fieldName}} é inválido. Tipo de chave pix não suportado.
invalid-json-schema-field-pix-qr-code-type	Campo {{fieldName}} é inválido. Deve indicar o tipo de qr code, STATIC ou DYNAMIC.
invalid-json-schema-field-reference-number	Campo {{fieldName}} é inválido. Deve ser numérico com oito dígitos.
invalid-json-schema-field-required	Campo {{fieldName}} é obrigatório.
invalid-json-schema-field-reversal-end-to-end-id	Campo {{fieldName}} é inválido. Deve iniciar com o prefixo D30306294 seguido de tempo e data no formato YYYYMMDDhhmm e onze caracteres alfanuméricos.
invalid-json-schema-field-tax-id	Campo {{fieldName}} é inválido. Deve ser numérico e possuir 11 dígitos para CPF ou 14 para CNPJ.
invalid-json-schema-field-treasury-revenue-code	Campo {{fieldName}} é inválido. Deve ser numérico com quatro dígitos.
invalid-json-schema-field-type	Campo {{fieldName}} é inválido. Tipo de pagamento não suportado.
invalid-json-schema-field-utilities-digitable-line	Campo {{fieldName}} é inválido. Deve ser numérico e possuir 48 caracteres.
invalid-json-schema-param-gte-number	Parâmetro {{fieldName}} é inválido. Precisa ser um valor numérico maior ou igual a {{fieldParam}}.
invalid-json-schema-param-lte-number	Parâmetro {{fieldName}} é inválido. Precisa ser um valor numérico menor ou igual a {{fieldParam}}.
invalid-json-schema-param-numeric	Parâmetro {{fieldName}} é inválido. Deve ser numérico.
invalid-json-schema-param-payment-end-to-end-id	Parâmetro {{fieldName}} é inválido. Deve iniciar com o prefixo E30306294 seguido de tempo e data no formato YYYYMMDDhhmm e onze caracteres alfanuméricos.
invalid-json-schema-param-required	Parâmetro {{fieldName}} é obrigatório.
invalid-json-schema-param-tax-id	Parâmetro {{fieldName}} é inválido. Deve ser numérico e possuir 11 caracteres para CPF e 14 para CNPJ.
invalid-name	Nome da conta inválido.
invalid-ownership	Não foi possível efetuar o pagamento. Dados da conta não identificam o titular informado.
invalid-parameter-required	Parâmetro {{fieldName}} é obrigatório.
invalid-parties-comparison	Não foi possível validar se pagador e recebedor têm a mesma conta bancária.
invalid-payload	Payload inválido.
invalid-payment-adjourning-status	Não foi possível adiar o pagamento
invalid-payment-amount-for-time-limit	Não foi possível efetuar o pagamento. Pagamentos acima de R$ {{maxAmount}} são permitidos até {{closeTime}}h.
invalid-payment-canceling-status	Não foi possível cancelar o pagamento.
invalid-payment-confirming-status	Não foi possível confirmar o pagamento.
invalid-payment-date	Data de pagamento inválida.
invalid-payment-failing-status	Não foi possível falhar o pagamento.
invalid-payment-id	Id do pagamento inválido.
invalid-payment-method	Não é possível pagar este boleto usando este método de pagamento.
invalid-payment-paying-status	Não foi possível efetuar o pagamento.
invalid-payment-processing-statu	Não foi possível processar o pagamento.
invalid-payment-retaining-status	Não foi possível reter o pagamento.
invalid-payment-reverting-status	Não foi possível reverter o pagamento.
invalid-payment-scheduling-status	Não foi possível agendar o pagamento.
invalid-payment-status	Status de pagamento inválido.
invalid-payment-time	O pagamento pode ser efetuado entre {{openTime}} e {{closeTime}}.
invalid-payment-time-limit	Não foi possível efetuar o pagamento. O horário permitido é entre {{openTime}} e {{closeTime}}.
invalid-payment-type	Tipo de pagamento é inválido. Os possíveis valores são: [BANKSLIP, DARF, PIX_KEY, PIX_MANUAL, PIX_QR_CODE, PIX_REVERSAL, TED, TEF, UTILITIES].
invalid-person-type	Tipo de pessoa (física/júridica) inválido.
invalid-phone	Telefone inválido.
invalid-phone-format	Formato de telefone inválido.
invalid-pix-branch	Não foi possível efetuar o pagamento. Agência inválida para pagamentos Pix.
invalid-pix-qr-code-info-identifier	Emv, location ou chave pix e id da transação são inválidos.
invalid-qr-code	QR Code rejeitado pela instituição financeira destino.
invalid-remaining-amount	Erro ao consultar o valor restante do pagamento original.
invalid-reversal-amount	Não foi possível efetuar o pagamento. O valor da devolução é maior do que o saldo restante de pagamento.
invalid-reversal-payment-date	Não foi possível efetuar o pagamento. A data de devolução para esse Pix expirou.
invalid-static-pix-qr-code-info-identifier	A chave pix ou o transaction id são inválidos.
invalid-tag-key	Chave da tag inválida.
invalid-tag-value	Valor da tag inválido.
invalid-tags	Tags inválidas.
invalid-tax-id	Deve ser um CPF/CNPJ válido.
invalid-time	Horário inválido.
invalid-time-interval	Intervalo inválido.
invalid-transaction-id	Identificador da transação do QrCode é inválido.
invalid-transfer-type	Tipo de transferência inválida.
ispb-not-found	ISPB não encontrado.
limit-rejected	Limite transacional não disponível.
limit-validation-error	Não foi possível validar limites transacionais.
linked-account	Não foi possível efetuar o pagamento. Conta vinculada não permite essa operação.
missing-identification-header	Header de identificação obrigatório não foi enviado.
missing-required-header	Headers obrigatórios não foram enviados.
no-balance-account	Saldo insuficiente para a operação.
no-response-transactional-limit-service	Erro ao consultar o limite transacional.
not-business-day	Não é dia útil.
not-found-result	Pagamento não encontrado.
onboarding-validation-error	Não foi possível validar o onboarding.
operation-canceled	Operação cancelada.
operation-expired	Pagamento não aprovado a tempo, por favor refaça a operação.
out-of-payment-hours	Erro ao efetuar o pagamento. Fora do horário permitido.
parent-already-closed	Não é possível adicionar pagamentos em um contrato que foi fechado.
parser-response-error-transactional-limit-service	Erro ao consultar o limite transacional.
partially-blocked-account-status	Não é possível movimentar uma conta parcialmente bloqueada.
parties-are-the-same	Pagador e recebedor têm a mesma conta bancária.
past-payment-date	Não é possível realizar pagamentos para datas no passado.
payer-restricted	Pagamento não efetuado. Confira se a empresa tem pendências.
payer-restrictions	Não foi possivel efetuar o pagamento. Verifique se a empresa possui pendências.
payment-already-adjourned	Pagamento já está em processo de retentativa.
payment-already-canceled	Pagamento já está cancelado.
payment-already-confirmed	Pagamento já está confirmado.
payment-already-created	Pagamento já está em processo de pagamento.
payment-already-exists	O pagamento já existe. Cheque seu extrato antes de tentar novamente.
payment-already-processed	Pagamento já está processado.
payment-already-processing	Pagamento já está em processo de pagamento.
payment-already-reverted	Pagamento já está estornado.
payment-already-scheduled	Pagamento já está agendado.
payment-already-started	Pagamento já está pendente aprovação.
payment-amount-changed	O valor do boleto mudou desde sua emissão.
payment-date-after-expiration	Não foi possivel efetuar o pagamento. A data do pagamento é superior a data de expiração.
payment-details-not-found	Não foi possível encontrar detalhes do pagamento.
payment-expired	O pagamento expirou às {{expirationDateTime}} e não pôde ser processado.
payment-failed-by-credit-party	Houve uma falha no recebimento do pagamento na instituição financeira de destino.
payment-not-allowed	Não foi possivel efetuar o pagamento. Verifique se já está vencido, ou se está dentro do horário permitido.
payment-not-authorized	Pagamento não autorizado.
payment-not-found	Pagamento não encontrado.
payment-timed-out	O pagamento foi interrompido pelo provedor devido a um alto tempo de espera de resposta.
payment-type-not-supported	Tipo de pagamento {{paymentType}} não suportado.
pending-approval	Pendente aprovação de representante legal.
pending-ciba	Pendente validação em outro dispositivo.
pending-fraud-task	Pendente desafio.
pix-key-not-found	Chave pix não encontrada.
pix-key-not-supported	Chave Pix inválida.
pix-key-type-not-supported	Tipo de chave pix {{pixKeyType}} não suportado.
pix-qr-code-type-not-supported	Tipo de qr code {{pixQRCodeType}} não suportado.
pix-reversal-original-pix-not-found	O PIX original não foi encontrado.
quick-transfer-fetch-error	Consulte o atendimento ao cliente.
reject-transactional-limit-amount-daily	Ultrapassou o limite diário. Verifique seus limites.
reject-transactional-limit-default	Ultrapassou o limite transacional.
reject-transactional-limit-global-amount-daily	Ultrapassou o valor limite permitido. Verifique seus limites.
reject-transactional-limit-global-number-daily-operations	Ultrapassou a quantidade de limite de operações diárias. Verifique seus limites.
reject-transactional-limit-number-daily-operations	Ultrapassou a quantidade de operações diárias. Verifique seus limites.
required-pix-qr-code-credit-party	Dados da conta de crédito são obrigatórios.
required-pix-qr-code-emv	Emv é obrigatório.
required-pix-qr-code-end-to-end-id	EndToEndId é obrigatório.
required-pix-qr-code-pix-key	Id de transação é obrigatório.
required-pix-qr-code-transaction-id	Chave pix é obrigatória.
required-pix-qr-code-type	Tipo do Pix QR Code é obrigatório.
reserve-account	Não foi possível efetuar o pagamento. Conta creditada inválida para conta BTG.
un-sanctioned-account	Conta sancionada pelas Nações Unidas.
unauthorized-user	Usuário não autorizado.
unavailable-accounts-table-service	Erro ao consultar o informações da conta.
unavailable-ispb-table	Não foi possível obter as informações de ISPB.
unavailable-transactional-limit-service	Erro ao consultar o limite transacional.
unmapped-error	Houve um erro durante a execução do pagamento. Cheque seu extrato antes de tentar novamente.
unprocessable-barcode-or-digitable-line	Boleto não reconhecido pela instituição financeira.
unregistered-barcode-or-digitable-line	Este boleto ainda não foi registrado. Tente novamente mais tarde.
whitelist-validation	Não foi possível validar a whitelist.
wrong-payment-type	Tipo de pagamento inválido.
invalid-payment-edition	Pagamento não pode ser editado.
invalid-payment-type-edition	Tipo do pagamento não pode ser editado.
invalid-payment-status-edition	Apenas pagamentos pendentes aprovação e sem nenhuma assinatura podem ser editados.
invalid-payment-system-origin-edition	Pagamentos realizados por planilha ou cnab ainda não podem ser editados.
invalid-payment-amount-edition	Valor do pagamento não pode ser editado.
invalid-payment-system-origin-edition	Pagamentos realizados por planilha ou cnab ainda não podem ser editados.
invalid-payment-amount-edition	Valor do pagamento não pode ser editado.
invalid-payment-credit-party-edition	Dados do recebedor não podem ser editados.
payment-no-changes-edition	Nenhuma informação do pagamento foi alterada.
contract-not-found	Pagamento não encontrado.
contract-partially-signed	Pagamento já contém assinaturas e não pode ser editado.
invalid-report-status	Status de contestação de pagamento inválido.
invalid-report-type	Tipo de contestação de pagamento inválido.
invalid-reason-type	Motivo de contestação de pagamento inválido.
invalid-system-origin	Origem do sistema inválida.
invalid-payment-type-for-infraction	Contestação não está disponível para esse tipo de pagamento.
invalid-infraction-period	Pagamento realizado há mais de {{maxDaysInfraction}} dias.
infraction-already-created	Pagamento já foi contestado e está em análise pela instituição de destino.
report-not-found	Contestação de pagamento não encontrada.
btg:enterprise:contract:create:error:status	Verifique com o atendimento seus poderes e refaça essa operação.

Pagamentos e Transferências

Casos de Uso

Segurança

📘
BTG Id

Idempotência

📘
Exemplo

Escopos necessários

Recursos Disponíveis

📘
API Reference

Modalidades de pagamentos e transferências

PIX_QR_CODE

BANKSLIP

UTILITIES

TED e PIX_MANUAL

PIX_KEY

DARF

PIX_REVERSAL

Status de pagamentos e máquina de estados

Eventos de webhook

Eventos possíveis

payments.adjourned

payments.failed

payments.canceled

payments.reverted

payments.processed

payments.created

payments.scheduled

payments.confirmed

payments.confirmed no caso de PIX

Códigos de erro

Casos de Uso

Segurança

📘BTG Id

Idempotência

📘Exemplo

Escopos necessários

Recursos Disponíveis

📘API Reference

Modalidades de pagamentos e transferências

PIX_QR_CODE

BANKSLIP

UTILITIES

TED e PIX_MANUAL

PIX_KEY

DARF

PIX_REVERSAL

Status de pagamentos e máquina de estados

Eventos de webhook

Eventos possíveis

payments.adjourned

payments.failed

payments.canceled

payments.reverted

payments.processed

payments.created

payments.scheduled

payments.confirmed

payments.confirmed no caso de PIX

Códigos de erro

📘
BTG Id

📘
Exemplo

📘
API Reference