Subscription Payment Confirmation or Rejection

This endpoint allows confirming or rejecting the payment associated with an integralization subscription. The payment status is updated according to the value provided in the request body.

---

Payment Status Update (PATCH)

Request

ENDPOINT

/integralization_integralization_process/INTEGRALIZATION-KEY/subscription/SUBSCRIPTION-KEY/subscription_payment/SUBSCRIPTION-PAYMENT-KEY

METHOD

PATCH

Path Params

Field	Type	Description	Characters
INTEGRALIZATION-KEY	string	Unique integralization key (UUID v4).	36
SUBSCRIPTION-KEY	string	Unique associated subscription key (UUID v4).	36
SUBSCRIPTION-PAYMENT-KEY	string	Unique subscription payment key (UUID v4).	36

---

Request Body

{
  "subscription_payment_status": "confirmed"
}

Request Body Params

Field	Type	Description	Required
subscription_payment_status*	string	New payment status. Possible values:confirmed or denied.	Yes

---

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

Field	Type	Description
subscription_payment_key	string	Unique subscription payment key (UUID v4).
amount	number	Declared value of the registered payment.
description	number	Description of the receipt content.
subscription_payment_status	string	Updated payment status. Possible values:waiting_confirmation confirmed, denied.
updated_at	string	Date and time of payment status update (format: ISO 8601).