Essa funcionalidade permite que os clientes efetuem pagamentos de boletos ou tributos (conta de água, luz, gás, telefone, etc, consulte a lista de convênios disponíveis).

Processo de pagamento de contas

O processo de pagamento consiste nas seguintes etapas:

Consultar as informações do "pagamento de contas"
Conforme o resultado obtido, o sistema cliente deve realizar algumas verificações antes de efetivar o pagamento
1. Validar o status do pagamento de conta. Somente pagamento de contas com status igual a PENDIG_PAYMENT deve ser efetivado
2. Validar a flag isAllowPartialPayment, onde esta, indica se é permitido pagamento parcial. Caso esta flag seja true, verificar o intervalo valores conforme as informações presente no objeto de cálculo de pagamento paymentCalculation
Após as devidas verificações, realizar o processo de efetivação de pagamento.

Consulta das informações do pagamento

Requisição

GET 'https://apisandbox.delbank.com.br/baas/api/v1/bill-payments/43594939800000003250001112000000200000311672'

curl -X 'GET' \
  'https://apisandbox.delbank.com.br/baas/api/v1/bill-payments/43594939800000003250001112000000200000311672' \
  -H 'x-delbank-api-key: {{apiKey}}'

Cabeçalhos (Headers)

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API

Parâmetros (path):

Informar o código de barras ou a linha digitável do pagamento.

Por exemplo: https://apisandbox.delbank.com.br/baas/api/v1/bill-payments/${PAYMENT_IDENTIFIER}

Resposta (response)

{
    "identifierNumber": "3023063000107986253",
    "type": "BANKSLIP",
    "status": "PAYMENT_DEADLINE_EXCEEDED",
    "amount": 3.25,
    "dueDate": "2023-07-01T19:30:00",
    "barCode": "43594939800000003250001112000000200000311672",
    "digitableLine": "43590001161200000020300003116720493980000000325",
    "isAllowPartialPayment": false,
    "paymentCalculation": {
        "rebateAmount": 0.0,
        "interesetAmount": 2.23,
        "fineAmount": 3.25,
        "discountAmount": 0.0,
        "chargedAmount": 8.73,
        "minimumPaymentAmount": 8.73,
        "maximumPaymentAmount": 8.73
    },
    "payer": {
        "document": "1234567123",
        "name": "JAMES XPTO",
        "type": "NATURAL"
    },
    "overduePaymentInterest": {
        "date": "2023-07-02",
        "amount": 23.53,
        "type": "PERCENTAGE"
    },
    "overduePaymentFine": {
        "date": "2023-07-02",
        "amount": 3.25,
        "type": "FIXED"
    },
    "discounts": [],
    "beneficiary": {
        "document": "11468192000181",
        "name": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "fantasyName": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "type": "LEGAL"
    },
    "issuer": {
        "ispb": "38224857",
        "name": "DELCRED SCD S.A.",
        "nameFantasy": "DELBANK"
    }
}

Nome	Tipo	Descrição
type	`enum`	Tipo do pagamento. Domínios: - `BANKSLIP` - Boleto - `TAXES` - Tributos ou impostos. Contas de consumo ou de órgãos convernamentais
status	`enum`	Status do pagamento. Domínios: - `PAID` - Pago - `PENDING_PAYMENT` - Pendente de pagamento - `BLOCKED_PAYMENT` - Pagamento bloqueado - `PAYMENT_DEADLINE_EXCEEDED` - Data limite de pagamento excedida
amount	`number`	Valor da cobrança/pagamento
dueDate	`datetime`	Data de vencimento, incluindo a HORA limite de pagamento
barCode	`string`	Código de barras
digitableLine	`string`	Linha digitável
isAllowPartialPayment	`boolean`	Flag que indica se é permitido pagamento parcial
payer	`object`	Informações do pagador
payer.document	`string`	Documento do pagador
payer.name	`string`	Nome do pagador
payer.type	`enum`	Tipo de pessoa do pagador. Domínios: - `NATURAL` - Pessoa Física - `LEGAL` - Pessoa Jurídica
issuer	`object`	Informações do banco emissor
issuer.ispb	`string`	ISPB do banco emissor do boleto
issuer.name	`string`	Nome do banco emissor do boleto
issuer.nameFantasy	`string`	Nome fantasia do banco emissor do boleto
beneficiary	`object`	Informações do beneficiário
beneficiary.name	`string`	Nome do beneficiário
beneficiary.document	`string`	Documento do beneficiário
overduePaymentInterest	`object`	Parâmetros de juros
overduePaymentInterest.date	`date`	Data referência para aplicação do juros
overduePaymentInterest.amount	`number`	Valor de juros
overduePaymentFine.type	`enum`	Modalidade de cobrança de juros. Domínios: - `PERCENTAGE` - Percentual - `FIXED` - Fixo - valor absoluto
overduePaymentFine	`object`	Parâmetros de multa
overduePaymentInterest.date	`date`	Data referência para aplicação da multa
overduePaymentInterest.amount	`number`	Valor de multa
overduePaymentFine.type	`enum`	Modalidade de cobrança de multa. Domínios: - `PERCENTAGE` - Percentual - `FIXED` - Fixo - valor absoluto
paymentCalculation	`object`	Informações auxiliares para uso durante o cálculo de pagamento
paymentCalculation.rebateAmount	`number`	Valor de abatimento (Boleto)
paymentCalculation.interesetAmount	`number`	Valor total de juros
paymentCalculation.fineAmount	`number`	Valor total de multa
paymentCalculation.discountAmoun	`number`	Valor total de desconto
paymentCalculation.chargedAmount	`number`	Valor total a ser cobrado
paymentCalculation.minimumPaymentAmount	`number`	Valor mínimo de pagamento
paymentCalculation.maximumPaymentAmount	`number`	Valor máximo de pagamento

Efetivação do pagamento

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v1/bill-payments'

curl --request POST \
     --url https://apisandbox.delbank.com.br/baas/api/v1/bill-payments \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "amount": 691.71,
    "barCode": "43596938200000691710001112000000200000309361"
}
'

Cabeçalhos (Headers)

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API
IdempotencyKey	Obrigatório. Chave idempotência da requisição. Informe um GUID, sendo um novo cada requisição.

Corpo da requisição (Body)

Nome	Tipo	Descrição
amount	`number`	Obrigatório. Valor do pagamento
barCode	`string`	Código de barras do pagamento de contas * Utilizar essa informação caso não informe a `digitableLine`
digitableLine	`string`	Linha digitável do pagamento de contas * Utilizar essa informação caso não informe o `barCode`

Resposta (Response)

O status code 200 indicará sucesso na transação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
    "id": "1694017754",
    "identifierNumber": "3023061406106689529",
    "barCode": "43596938200000691710001112000000200000309361",
    "digitableLine": "43590001161200000020300003093614693820000069171",
    "status": "PAID",
    "dueDate": "2023-06-15T19:30:00",
    "createdAt": "2023-09-06T16:29:14.950Z",
    "originalAmount": 691.71,
    "paidAmount": 691.71,
    "paymentCalculation": {
        "rebateAmount": 0.0,
        "interesetAmount": 862.92,
        "fineAmount": 100.0,
        "discountAmount": 0.0,
        "chargedAmount": 1654.63,
        "minimumPaymentAmount": 1654.63,
        "maximumPaymentAmount": 1654.63
    },
    "beneficiary": {
        "document": "11468192000181",
        "name": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "fantasyName": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "type": "LEGAL"
    },
    "issuer": {
        "ispb": "38224857",
        "name": "DELCRED SCD S.A.",
        "nameFantasy": "DELBANK"
    }
}

📘
Collection no postman
Para mais informações e simulações de requisição, segue a collection do postman, acesse o Collection Postman.

Pagamento de Boleto ou Tributo

Processo de pagamento de contas

Consulta das informações do pagamento

Requisição

Cabeçalhos (Headers)

Parâmetros (path):

Resposta (response)

Efetivação do pagamento

Requisição

Cabeçalhos (Headers)

Corpo da requisição (Body)

Resposta (Response)

📘
Collection no postman

Processo de pagamento de contas

Consulta das informações do pagamento

Requisição

Cabeçalhos (Headers)

Parâmetros (path):

Resposta (response)

Efetivação do pagamento

Requisição

Cabeçalhos (Headers)

Corpo da requisição (Body)

Resposta (Response)

📘Collection no postman

📘
Collection no postman