跳到主要内容

确认或拒绝认购付款

此端点允许确认或拒绝与认缴认购关联的付款。付款状态将根据请求体中提供的值进行更新。


更新付款状态 (PATCH)

Request

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

Path Params

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

Request Body

{
"subscription_payment_status": "confirmed"
}

Request Body Params

字段类型描述必填
subscription_payment_status*string新付款状态。可能的值:confirmeddenied

Response

STATUS
200
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": "2025-01-24T11:30:00Z"
}

Response Body Params

字段类型描述
subscription_payment_keystring认购付款的唯一键(UUID v4)。
amountnumber已登记付款的申报金额。
descriptionnumber收据内容说明。
subscription_payment_statusstring已更新的付款状态。可能的值:waiting_confirmationconfirmeddenied
updated_atstring付款状态更新日期和时间(格式:ISO 8601)。