Skip to main content

Make payment of collection invoice (agreement/tribute)

This endpoint allows the payment of collection invoices. The payment should be made after a consultation, using the information returned in it, to ensure the correct flow and avoid failures during the payment process.

Collection Invoice

This type of charge is issued by utility companies (water, electricity, telephone, and gas bills) and public entities (taxes). They are not registered with the Interbank Payment Clearinghouse (CIP/Núclea), and thus, do not return the same information as a bank slip.

Request

Request Endpoint

ENDPOINT
/account/ACCOUNT_KEY/payment/collection_slip
MÉTODO
POST

Request Path Params

FieldTypeDescriptionCharacters
account_key *uuid4Unique account identification key.36
Request Body: Payment of collection invoice with digitable line
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"digitable_line": "00190000090361557400500000024174396700000991000",
"payment_amount": 1156.8
}
Request Body: Payment of collection invoice with barcode
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"barcode": "00190000090361557400500000024174396700000991000",
"payment_amount": 1156.8
}

Body Params

FieldTypeDescription
request_control_key *uuid4Unique identification key for the client's request.
barcodestringBarcode.
digitable_linestringDigitable line.
payment_amount *numberAmount to be paid.
Warning

The payment_amount must always be equal to the total_amount returned in the bank slip query.

Response

Success Response

STATUS
201
Response Body: Payment executed
{
"payment_key": "33860ad0-bcb0-47b7-bbe7-c7e3ec2fc61a",
"request_control_key": "ae4508df-f2cb-4e28-9f04-a19b7f2758c9",
"payer_name": "COOPERATIVA INDUSTRIAL MURILO",
"payer_document_number": "62069937000118",
"source_account_key": "daae79e6-ee8b-449f-aa1e-96959d5d5a72",
"transaction_key": "fc9ccfd0-2f21-4207-9772-69238be74152",
"transaction_revert_key": null,
"paid_amount": 1389.21,
"payment_date": "2024-04-30",
"payment_type": "collection_slip",
"bank_slip": null,
"collection_slip": {
"barcode": null,
"digitable_line": "836200000138892100450006762142420244046000010192",
"collection_name": "CIA ULTRAGAZ SA-COD",
"collection_document_number": "00394460005887",
"expiration_date": "2024-04-15",
"total_amount": 1389.21
},
"payment_status": "executed"
}

Response Body Params

FieldTypeDescription
payment_key *uuid4Unique payment identification key.
request_control_key *uuid4Unique identification key for the client's request.
payer_name *stringName of the effective payer.
payer_document_number *stringDocument number of the effective payer (CPF/CNPJ).
source_account_key *uuid4Key of the debited account.
transaction_key *uuid4Payment transaction key.
transaction_revert_keyuuid4Payment reversal transaction key.
paid_amount *numberAmount effectively paid.
payment_date *stringPayment date.
payment_type *enumPayment type.
bank_slipobjectBank slip.
collection_slipobjectCollection invoice.
payment_status *enumPayment status.

Enumerators payment_type

EnumeratorTypeDescription
bank_slipstringBank slip
collection_slipstringCollection invoice
Warning

The enumerator bank_slip does not apply to the collection invoice flow, and the bank_slip object will always be null.

Enumerators payment_status

EnumeratorDescription
executedExecuted
revertedReverted
rejectedRejected
errorError

Object collection_slip

FieldTypeDescription
barcodestringBarcode.
digitable_linestringDigitable line.
collection_name *stringName of the agreement.
collection_document_numberstringDocument number of the agreement (CPF/CNPJ).
expiration_date *stringDue date.
total_amount *numberTotal amount.

Error Response

STATUS
4XX
Response Body
{
"title": "Título",
"description": "Description in english",
"translation": "Descrição em português",
"code": "Código"
}
HTTP CodeQI CodeTitleDescription (eng)Description (pt-br)
400BIP000032Bad RequestThe bill sent does not correspond to a collection slip.A conta enviada não corresponde a uma fatura de recolhimento.
400BIP000033Bad RequestThe barcode or digitable line of the collection slip must have 44 or 48 characters.O código de barras ou linha digitável da fatura de recolhimento deve ter 44 ou 48 caracteres.
403BIP000010ForbiddenUser is not allowed to do this actionUsuário não tem autorização para fazer essa ação
404BIP000011Not FoundThe source account key was not found.A chave da conta de origem não foi encontrada.
400BIP000012Bad RequestIt was not possible to consult the source account at this time. Please try again in a few minutes.Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400BIP000013Bad RequestThe source account is closed.A conta de origem está fechada.
400BIP000014Bad RequestThe source account is blocked.A conta de origem está bloqueada.
400BIP000023Bad RequestThe source account has insufficient balance. Payment cannot be made.A conta de origem possui saldo insuficiente. Pagamento não pode ser realizado.
400BIP000024Bad RequestRequest control key already exists.Chave de controle da requisição já existe.
400BIP000028Bad RequestThe source account has blocked balance. Payment cannot be made.A conta de origem possui saldo em conta bloqueado. Pagamento não pode ser realizado.
400BIP000034Bad RequestCollection slip already paid.Fatura de recolhimento já paga.
400BIP000035Bad RequestCovenant slip invalid barcode.Código de barras da fatura de recolhimento inválido.
400BIP000036Bad RequestCovenant slip overdue.Fatura de recolhimento vencida.
400BIP000037Bad RequestError in collection slip consultation.Erro na consulta da fatura de recolhimento.
400BIP000038Bad RequestOutside of covenant payment hours.Fora do horário de pagamento do convênio.
400BIP000039Bad RequestCollection slip not accepted.Fatura de recolhimento não aceita.
400BIP000040Bad RequestMinimum advance not reached.Mínimo de dias de adiantamento não atingido.
400BIP000041Bad RequestMax payment amount exceeded.Valor máximo de pagamento excedido.
400BIP000044Bad RequestIt was not possible to pay the collection slip at this time. Please verify your information and, if necessary, contact us for assistance.Não foi possível pagar a fatura de recolhimento neste momento. Por favor, verifique suas informações e, se necessário, entre em contato conosco para assistência.
400BIP000045Bad RequestCollection slip payment service is closed.Serviço de pagamento de fatura de recolhimento está fechado.

Sandbox Environment

In our sandbox environment, we provide mocked digitable lines for simulating successful payments and testing error scenarios.

Success Scenarios

Digitable Line
828300000007411100972013905080001546763201900028
838000000009235700481007241345219112001474229880
848000000006308600802021201071261517689002201070
858200000015000000643025703477209504800448091020

Error Scenarios

Digitable LineError Code
858500000037350000643217212883260006147448091022BIP000035