Subscription Payment Registration

This endpoint allows registering a payment associated with an integralization subscription. The payment includes a declared amount and a receipt in Base64.

---

Payment Registration (POST)

Request

ENDPOINT

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

METHOD

POST

Path Params

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

---

Request Body

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

Request Body Params

Field	Type	Description	Required
document_base64*	string	Payment receipt encoded in Base64.	Yes
amount*	number	Declared amount of the payment made.	Yes
description	string	Description of the receipt content.	Yes

---

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

Field	Type	Description
subscription_payment_key	string	Unique subscription payment key (UUID v4).
amount	number	Declared amount of the registered payment.
subscription_payment_status	string	Current payment status. Possible values:waiting_confirmation confirmed denied
description	string	Description of the receipt content.

---