跳到主要内容

支付征税发票（协议/税务）

此端点用于支付征税发票。支付必须在查询之后进行，使用查询返回的信息以确保流程正常运行，避免支付过程中出现失败。

征税发票

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

Request​

请求端点​

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

请求路径参数​

字段类型描述字符数
account_key *uuid4账户唯一标识键。36
Request Body: 使用数字行支付征税发票
{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "digitable_line": "00190000090361557400500000024174396700000991000",
  "payment_amount": 1156.8
}
Request Body: 使用条形码支付征税发票
{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "barcode": "00190000090361557400500000024174396700000991000",
  "payment_amount": 1156.8
}

Body 参数​

字段类型描述
request_control_key *uuid4客户请求唯一标识键。
barcodestring条形码。
digitable_linestring数字行。
payment_amount *number待支付金额。
警告

payment_amount 必须始终等于银行票据查询返回的 total_amount。

Response​

成功响应​

STATUS
201
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"
}
STATUS
202
Webhook

当支付返回状态 202 时，处理仍在进行中。在通过 webhook 收到最终状态更新之前，请勿重试支付。

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": "pending"
}

Response Body 参数​

字段类型描述
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_keyuuid4支付冲销交易键。
paid_amount *number实际支付金额。
payment_date *string支付日期。
payment_type *enum支付类型。
bank_slipobject银行票据。
collection_slipobject征税发票。
payment_status *enum支付状态。

payment_type 枚举值​

枚举值类型描述
bank_slipstring银行票据
collection_slipstring征税发票
警告

bank_slip 枚举值不适用于征税发票流程，bank_slip 对象也始终为空。

payment_status 枚举值​

枚举值描述
pending待处理
executed已执行
reverted已冲销
rejected已拒绝
error错误

collection_slip 对象​

字段类型描述
barcodestring条形码。
digitable_linestring数字行。
collection_name *string协议名称。
collection_document_numberstring协议文件号码（CPF/CNPJ）。
expiration_date *string到期日期。
total_amount *number总金额。

错误响应​

STATUS
4XX
Response Body
{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}
HTTP 代码QI 代码标题描述（英文）描述（葡文）
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 环境​

在我们的 sandbox 环境中，我们提供了模拟的数字行，用于模拟成功支付和测试错误场景。

成功场景​

数字行
828300000007411100972013905080001546763201900028
838000000009235700481007241345219112001474229880
848000000006308600802021201071261517689002201070
858200000015000000643025703477209504800448091020

错误场景​

数字行错误代码
858500000037350000643217212883260006147448091022BIP000035