确认收款单付款

此端点用于确认收款单的付款。

收款单

此类收费由服务特许经营商（水、电、电话和燃气账单）及政府机构（税款）发行。它们不在银行间支付清算所（CIP/Núclea）登记，因此返回的信息与银行划账单不同。

Request

Request Endpoint

ENDPOINT

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

MÉTODO

PATCH

Request Path Params

字段	类型	描述	字符数
`account_key` *	uuid4	账户的唯一标识键。	36
`payment_key` *	uuid4	付款的唯一标识键。	36

通过邮件和短信认证

Request Body: 确认收款单付款

{
  "token": "329adf"
}

通过设备认证

要通过设备认证批准并完成认证，请求必须以空负载发送。验证在内部进行，无需在请求体中提供额外信息。需要注意的是，此端点仅应在付款请求启动后使用。

Request Body: 确认收款单付款

{

}

Body Params

字段	类型	描述	字符数
`token`	string	发送给账户转账审批人的认证码，通过短信或邮件进行二次验证时为必填项	6

Response

Success Response

STATUS

200

Response Body: 付款已执行

{
  "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

字段	类型	描述
`payment_key` *	uuid4	付款的唯一标识键。
`request_control_key` *	uuid4	客户请求的唯一标识键。
`payer_name` *	string	实际付款人姓名。
`payer_document_number` *	string	实际付款人的证件号（CPF/CNPJ）。
`source_account_key` *	uuid4	被扣款账户的键。
`transaction_key` *	uuid4	付款交易的键。
`transaction_revert_key`	uuid4	付款冲销交易的键。
`paid_amount` *	number	实际付款金额。
`payment_date` *	string	付款日期。
`payment_type` *	enum	付款类型。
`bank_slip`	object	银行划账单。
`collection_slip`	object	收款单。
`payment_status` *	enum	付款状态。

Enumeradores payment_type

枚举值	类型	描述
`bank_slip`	string	银行划账单
`collection_slip`	string	收款单

注意

bank_slip 枚举值不适用于收款单流程，bank_slip 对象始终为 null。

Enumeradores payment_status

枚举值	描述
`executed`	已执行
`reverted`	已冲销
`rejected`	已拒绝
`error`	错误

Objeto collection_slip

字段	类型	描述
`barcode`	string	条形码。
`digitable_line`	string	可输入行。
`collection_name` *	string	协议名称。
`collection_document_number`	string	协议文件编号（CPF/CNPJ）。
`expiration_date` *	string	到期日期。
`total_amount` *	number	总金额。

Error Response

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}

HTTP 代码	QI 代码	标题	描述（英文）	描述（葡文）
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	BIP000034	Bad Request	Collection slip already paid.	Fatura de recolhimento já paga.
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.
400	BIP000080	Bad Request	A token is required for SMS or email validation.	Um token é necessário para validação via SMS ou email.

Request​

Request Endpoint​

Request Path Params​

通过邮件和短信认证​

通过设备认证​

Body Params​

Response​

Success Response​

Response Body Params​

Enumeradores payment_type​

Enumeradores payment_status​

Objeto collection_slip​

Error Response​