跳到主要内容

执行票据付款

Request​

ENDPOINT
/bank_slip/payment
MÉTODO
POST
Request Body
{
    "digitable_line": "42297034020000453753620034706323183380000005000",
    "resource_account_key": "21af482f-b8ac-48dd-8f9a-ea23429d28be",
    "payment_date": "2020-08-05"
}

Body params​

字段类型描述字符数
digitable_line *string票据可输入行10
resource_account_key *string将要使用的账户键10
payment_datedate付款执行日期。若未发送，日期默认为今天10
信息

若要查看已接受的付款协议，请点击此处。

Response​

STATUS
200
Response Body：通过自由账户付款
{
    "data": {
        "digitable_line": "09990001029100010009895007444201283400000001000",
        "resource_account_key": "21af482f-b8ac-48dd-8f9a-ea23429d28be"
    },
    "event_datetime": "2020-08-06 19:22:06",
    "key": "e7719f95-a31d-4171-ae83-2d8b3d419dc2",
    "status": "success",
    "webhook_type": "bank_slip_payment"
}
STATUS
200
Response Body：通过托管账户付款
{
    "data": {
        "digitable_line": "09990001029100010009895007444201283400000001000",
        "resource_account_key": "21af482f-b8ac-48dd-8f9a-ea23429d28be"
    },
    "event_datetime": "2020-08-06 19:22:06",
    "key": "e7719f95-a31d-4171-ae83-2d8b3d419dc2",
    "status": "waiting_approval",
    "webhook_type": "bank_slip_payment"
}

STATUS
400
Response Body
{
    "code": "LEG000069"
    "title": "Bad Request",
    "description": "Invalid request body.",
    "translation": "Corpo da requisição inválido.",
    "extra_fields": {}
}
STATUS
423 - 付款超出受理时间
Response Body
{
	"code": "BLP000024",
	"title": "Locked",
	"http_status": 423,
    "description": "Operation window closed. System available from {OPENING_TIME} to {CLOSING_TIME}",
    "translation": "Operação encerrada. Sistema disponível de {OPENING_TIME} a {CLOSING_TIME}",
	"extra_fields": {
		"next_available_datetime": "2023-08-13T18:00:00.000Z"
	}
}

STATUS
400

Response Body
{
  "code": "IPP000015",
  "title": "Bad Request",
  "http_status": 400,
  "description": "Invalid amount",
  "translation": "O valor inserido é inválido",
  "extra_fields": {} 
}

STATUS
422

Response Body
{
  "code": "IPP000013",
  "title": "Incompatible Payment Value",
  "http_status": 422,
  "description": "The input amount does not match tax collection value",
  "translation": "O valor do pagamento é diferente da arrecadação",
  "extra_fields": {} 
}

STATUS
422

Response Body
{
  "code": "IPP000012",
  "title": "Tax Collection Already Paid",
  "http_status": 422,
  "description": "This tax collection is already paid",
  "translation": "A arrecadação já foi paga",
  "extra_fields": {} 
}

STATUS
422

Response Body
{
  "code": "IPP000017",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "The tax collection is overdue",
  "translation": "A arrecadação está vencida",
  "extra_fields": {} 
}

STATUS
422

Response Body
{
  "code": "IPP000023",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "Max retries exceeded, while trying to complete payment.",
  "translation": "Número máximo de tentativas excedido, ao tentar concluir o pagamento.",
  "extra_fields": {}
}

STATUS
422

Response Body
{
  "code": "IPP000024",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "Error while processing payment output. Try again.",
  "translation": "Erro ao processar a saída do pagamento. Tente novamente.",
  "extra_fields": {}
}

STATUS
422

Response Body
{
  "code": "IPP000025",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "Outside of covenant payment hours.",
  "translation": "Fora do horário de pagamento do convênio.",
  "extra_fields": {}
}

沙盒环境​

协议/税务票据​

协议/税务票据由政府机构（如市政府、州政府或联邦政府）发行，用于征收税款、费用、社会保险金、罚款及其他应缴政府款项。

在我们的沙盒环境中，我们提供模拟的可输入行用于成功支付模拟和错误场景测试。

成功场景​

可输入行
828300000007411100972013905080001546763201900028
838000000009235700481007241345219112001474229880
848000000006308600802021201071261517689002201070
858200000015000000643025703477209504800448091020

错误场景​

可输入行错误代码
858900000034050002701002700011434710592720230733IPP000015
858400000000750002701007700011434710592720230733IPP000013
858800000040450004322322120716192390688090088931IPP000012
858900000000350004322326120716192390688090083760IPP000014

银行票据​

银行票据（boleto bancário），也称 boleto 或 bloqueto，是巴西广泛用于支付商品或服务的凭证。通过票据，发行人或企业可以向付款人收取所欠款项。

在我们的沙盒环境中，我们提供模拟的可输入行用于成功支付模拟。

成功场景​

可输入行
32990001039000210987502864982109595090000063958
32990001039000000006836762871105695090000010000
32990001031000699960099000000200195070000025527
32990001039000000000103194237800895060001000000
32990001031000699960095000000208497790000030990