Registro de Pagamento de Subscrição

Este endpoint permite registrar um pagamento associado a uma subscrição de integralização. O pagamento inclui um valor declarado e um comprovante em Base64.

---

Registro de Pagamento (POST)

Request

ENDPOINT

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

MÉTODO

POST

Path Params

Campo	Tipo	Descrição	Caracteres
INTEGRALIZATION-KEY	string	Chave única da integralização (UUID v4).	36
SUBSCRIPTION-KEY	string	Chave única da subscrição associada (UUID v4).	36

---

Request Body

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

Request Body Params

Campo	Tipo	Descrição	Obrigatório
document_base64	string	Comprovante de pagamento codificado em Base64.	Sim
amount	number	Valor declarado do pagamento realizado.	Sim
description	number	Descrição do conteúdo do comprovante.	Sim

---

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

Campo	Tipo	Descrição
subscription_payment_key	string	Chave única do pagamento da subscrição (UUID v4).
amount	number	Valor declarado do pagamento registrado.
subscription_payment_status	string	Status atual do pagamento. Valores possíveis: waiting_confirmation confirmed denied
description	number	Descrição do conteúdo do comprovante.

---