Confirm payment of collection invoice (agreement/tribute)

This endpoint allows the confirmation of collection invoice payments.

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, therefore, do not return the same information as a boleto.

Request

Request Endpoint

ENDPOINT

/account/ACCOUNT_KEY/payment/PAYMENT_KEY/collection_slip/validate_token

MÉTODO

PATCH

Request Path Params

Field	Type	Description	Characters
account_key *	uuid4	Unique account identification key.	36
payment_key *	uuid4	Unique payment identification key.	36

Request Body: Collection invoice payment confirmation

{
  "token": "329adf"
}

Body Params

Field	Type	Description
token *	string	Authentication code sent to the account's transaction approver

Response

Success Response

STATUS

200

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

Field	Type	Description
payment_key *	uuid4	Unique payment identification key.
request_control_key *	uuid4	Unique identification key for the client's request.
payer_name *	string	Name of the effective payer.
payer_document_number *	string	Document number of the effective payer (CPF/CNPJ).
source_account_key *	uuid4	Key of the debited account.
transaction_key *	uuid4	Payment transaction key.
transaction_revert_key	uuid4	Payment reversal transaction key.
paid_amount *	number	Amount effectively paid.
payment_date *	string	Payment date.
payment_type *	enum	Payment type.
bank_slip	object	Boleto bancário.
collection_slip	object	Collection invoice.
payment_status *	enum	Payment status.

Enumerators payment_type

Enumerator	Type	Description
bank_slip	string	Boleto bancário
collection_slip	string	Collection 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

Enumerator	Description
executed	Executed
reverted	Reverted
rejected	Rejected
error	Error

Object collection_slip

Field	Type	Description
barcode	string	Barcode.
digitable_line	string	Digitable line.
collection_name *	string	Name of the agreement.
collection_document_number	string	Document number of the agreement (CPF/CNPJ).
expiration_date *	string	Due date.
total_amount *	number	Total amount.

Error Response

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Description in portuguese",
    "code": "Código"
}

HTTP Code	QI Code	Title	Description (eng)	Description (pt-br)
403	BIP000010	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BIP000011	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BIP000012	Bad Request	It 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.
400	BIP000013	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BIP000014	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
400	BIP000023	Bad Request	The source account has insufficient balance. Payment cannot be made.	A conta de origem possui saldo insuficiente. Pagamento não pode ser realizado.
400	BIP000028	Bad Request	The source account has blocked balance. Payment cannot be made.	A conta de origem possui saldo em conta bloqueado. Pagamento não pode ser realizado.
400	BIP000036	Bad Request	Covenant slip overdue.	Fatura de recolhimento vencida.
400	BIP000038	Bad Request	Outside of covenant payment hours.	Fora do horário de pagamento do convênio.
400	BIP000044	Bad Request	It 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.
400	BIP000045	Bad Request	Collection slip payment service is closed.	Serviço de pagamento de fatura de recolhimento está fechado.
404	BIP000056	Not Found	Payment not found.	Pagamento não encontrado.
400	BIP000057	Bad Request	Payment status is not pending approval.	Status de pagamento não é de aprovação pendente.
400	BIP000058	Bad Request	Error while validating verification token	Erro ao validar token de verificação
400	BIP000059	Bad Request	Number of verification token validation attempts exceeded.	Número de tentativas de validação de token de verificação excedido.
400	BIP000060	Bad Request	Verification token expired.	Token de verificação expirado.
400	BIP000061	Bad Request	Verification token validation failed.	Falha na validação do token de verificação.
400	BIP000063	Bad Request	Payment type is not collection slip.	Tipo de pagamento não é fatura de recolhimento.
400	BIP000065	Bad Request	Payment verification time window exceeded.	Janela de tempo de verificação de pagamento excedida.