Skip to main content

Confirmação ou Rejeição do Pagamento de Subscrição

Este endpoint permite confirmar ou rejeitar o pagamento associado a uma subscrição de integralização. O status do pagamento é atualizado conforme o valor fornecido no corpo da requisição.


Atualização do Status do Pagamento (PATCH)

Request

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

Path Params

CampoTipoDescriçãoCaracteres
INTEGRALIZATION-KEYstringChave única da integralização (UUID v4).36
SUBSCRIPTION-KEYstringChave única da subscrição associada (UUID v4).36
SUBSCRIPTION-PAYMENT-KEYstringChave única do pagamento da subscrição (UUID v4).36

Request Body

{
"subscription_payment_status": "confirmed"
}

Request Body Params

CampoTipoDescriçãoObrigatório
subscription_payment_statusstringNovo status do pagamento. Valores possíveis: confirmed ou denied.Sim

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

CampoTipoDescrição
subscription_payment_keystringChave única do pagamento da subscrição (UUID v4).
amountnumberValor declarado do pagamento registrado.
descriptionnumberDescrição do conteudo do recibo.
subscription_payment_statusstringStatus atualizado do pagamento. Valores possíveis:waiting_confirmation confirmed, denied.
updated_atstringData e hora da atualização do status do pagamento (formato: ISO 8601).