跳到主要内容

登记认购付款

此端点允许登记与认缴认购关联的付款。付款包括申报金额和 Base64 格式的凭证。


登记付款 (POST)

Request

ENDPOINT
/integralization_integralization_process/INTEGRALIZATION-KEY/subscription/SUBSCRIPTION-KEY/subscription_payment
MÉTODO
POST

Path Params

字段类型描述字符数
INTEGRALIZATION-KEYstring认缴的唯一键(UUID v4)。36
SUBSCRIPTION-KEYstring关联认购的唯一键(UUID v4)。36

Request Body

{
"document_base64": "dGVzdGVfZG9jdW1lbnRfYmFzZTY0",
"amount": 100000.00,
"description": "Comprovante de pagamento Itau R$100.000,00"
}

Request Body Params

字段类型描述必填
document_base64*stringBase64 编码的付款凭证。
amount*number已付款的申报金额。
description*number凭证内容说明。

Response

STATUS
201
Response Body
{
"subscription_payment_key": "7e51be5b-fdfd-4f2f-ba1a-0d81cdb08177",
"payment_receipt_document_key": "f352de14-222f-4787-bd67-2063524f8d9f/2f7e00b5-988f-4214-bb46-4728d9081148/subscription_payment/7e51be5b-fdfd-4f2f-ba1a-0d81cdb08177",
"description": "Comprovante de pagamento Itau R$100.000,00",
"amount": 100000.0,
"subscription_payment_status": "waiting_confirmation",
"updated_at": null
}

Response Body Params

字段类型描述
subscription_payment_keystring认购付款的唯一键(UUID v4)。
amountnumber已登记付款的申报金额。
subscription_payment_statusstring当前付款状态。可能的值:waiting_confirmationconfirmeddenied
descriptionnumber凭证内容说明。