54 - Pagar Boleto

Realiza o pagamento de um boleto bancário.

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/Pagar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "pagador": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>",
    "tipoConta": 1,
    "modeloConta": 1
  },
  "tipoProcessamento": 3,
  "titulo": {
    "linhaDigitavel": "<string>",
    "codigoBarras": "<string>"
  },
  "valorTitulo": 123,
  "dataVencimento": "2023-11-07T05:31:56Z",
  "valorPagamento": 123,
  "codOperacaoCli": "<string>",
  "descCliente": "<string>"
}
'

{
  "sucesso": true,
  "mensagem": "<string>",
  "valorTransacao": 123,
  "custoTransacao": 123,
  "codigoAutenticacao": "<string>",
  "codigoTransacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigoMovimento": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dadosBoleto": {
    "linhaDigitavel": "<string>",
    "codigoBarras": "<string>"
  },
  "origemConsulta": 1
}

POST

api

Boleto

Pagar

Realiza o pagamento de um boleto bancário.

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/Pagar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "pagador": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>",
    "tipoConta": 1,
    "modeloConta": 1
  },
  "tipoProcessamento": 3,
  "titulo": {
    "linhaDigitavel": "<string>",
    "codigoBarras": "<string>"
  },
  "valorTitulo": 123,
  "dataVencimento": "2023-11-07T05:31:56Z",
  "valorPagamento": 123,
  "codOperacaoCli": "<string>",
  "descCliente": "<string>"
}
'

{
  "sucesso": true,
  "mensagem": "<string>",
  "valorTransacao": 123,
  "custoTransacao": 123,
  "codigoAutenticacao": "<string>",
  "codigoTransacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigoMovimento": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dadosBoleto": {
    "linhaDigitavel": "<string>",
    "codigoBarras": "<string>"
  },
  "origemConsulta": 1
}

Por meio deste endpoint utilizando uma conta pagadora 274 o correntista conseguirá efetuar o pagamentos de boletos de quaisquer Instituições Financeiras.

Authorizations

Authorization

string

header

required

Copie 'Bearer ' + token

Headers

IdempotencyKey

string

required

IgnoraHandshake

boolean

default:true

required

(somente em homologação)

Body

pagador

object

Objeto detalhado da conta bancária do pagador do título.*

Mostrar atributos filhos

pagador.agencia

string | null

Número da agência bancária.*

Observações:

O número da agência pode ter no máximo 4 caracteres.

pagador.agenciaDigito

string | null

Dígito verificador da agência bancária.

Observações:

O dígito verificador da agência bancária pode ter no máximo 1 caracter.

pagador.conta

string | null

Número da conta bancária.

Observações:

O número da conta bancária pode ter no máximo 12 caracteres.
Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
Caso o 'número da conta com dígito' (contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito).
Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.

pagador.contaDigito

string | null

Dígito verificador do número da conta bancária.

Observações:

O dígito verificador do número da conta bancária pode ter no máximo 1 caracter.

pagador.contaPgto

string | null

Número da conta bancária seguido do dígito verificador.

Observações:

O número da conta seguido do dígito verificador pode ter no máximo 20 caracteres.

pagador.tipoConta

enum<integer>

Tipo da conta.*

Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario

Opções disponíveis:

1,

2,

3,

4

pagador.modeloConta

enum<integer>

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Opções disponíveis:

1,

2,

3

tipoProcessamento

enum<integer>

Tipo de Processamento.*

Valores: 3 - TRA 4 - TIT 5 - TRACR

Opções disponíveis:

3,

4,

5

titulo

object

Objeto detalhado do título para pagamento.*

Observação:

Para prosseguir com o pagamento do título será necessário informar a 'linha digitável' (linhaDigitavel) ou o 'código de barras' (codigoBarras) do título para pagamento.

Mostrar atributos filhos

titulo.linhaDigitavel

string | null

Sequência numérica digitável presente no boleto bancário.

titulo.codigoBarras

string | null

Sequência numérica que corresponde ao código de barras impresso no boleto bancário.

valorTitulo

number<double>

Valor do título.*

Observação:

O valor do título deve ser maior que zero.

dataVencimento

string<date-time>

Data de vencimento do título.*

valorPagamento

number<double>

Valor do pagamento do título.*

Observação:

O valor do pagamento do título deve ser maior que zero.

codOperacaoCli

string | null

Código personalizado informado pelo cliente. Pode servir para identificar ou rastrear a operação.

descCliente

string | null

Descrição livre fornecida pelo cliente para a operação.

Response

Success

sucesso

boolean

mensagem

string | null

valorTransacao

number<double>

custoTransacao

number<double>

codigoAutenticacao

string | null

codigoTransacao

string<uuid>

codigoMovimento

string<uuid>

dadosBoleto

object

Mostrar atributos filhos

dadosBoleto.linhaDigitavel

string | null

Sequência numérica digitável presente no boleto bancário.

dadosBoleto.codigoBarras

string | null

Sequência numérica que corresponde ao código de barras impresso no boleto bancário.

origemConsulta

enum<integer>

Opções disponíveis:

1,

2

53 - Cadastro de Favorecido 55 - Registrar Boleto

⌘I

Guia Inicial

Guia do Desenvolvedor

Referências de API

Layouts de CNAB

54 - Pagar Boleto

Authorizations

Headers

Body

Response