Confirmação do Pagamento

Este endpoint permite que um investidor confirme ou rejeite um comprovante de pagamento dentro de um SettlementProcessPayment.

---

Confirmação do Pagamento (PATCH)

Request

ENDPOINT

/security/security/SECURITY-KEY/installment/INSTALLMENT-KEY/settlement_process/SETTLEMENT-PROCESS-KEY/settlement_process_payment/SETTLEMENT-PROCESS-PAYMENT-KEY/settlement_process_payment_receipt/SETTLEMENT-PROCESS-PAYMENT-RECEIPT-KEY

MÉTODO

PATCH

Path Params

Campo	Tipo	Descrição	Caracteres
SECURITY-KEY	string	Chave única da security (UUID v4).	36
INSTALLMENT-KEY	string	Chave única da parcela (UUID v4).	36
SETTLEMENT-PROCESS-KEY	string	Chave única do processo de liquidação (UUID v4).	36
SETTLEMENT-PROCESS-PAYMENT-KEY	string	Chave única do pagamento dentro do processo (UUID v4).	36
SETTLEMENT-PROCESS-PAYMENT-RECEIPT-KEY	string	Chave única do comprovante de pagamento (UUID v4).	36

---

Request Body

{
    "settlement_process_payment_receipt_status": "confirmed"
}

---

Request body params

Campo	Tipo	Descrição	Obrigatório
settlement_process_payment_receipt_status	string	Status do comprovante. Deve ser confirmed ou denied. Enumeradores settlement_process_payment_receipt_status.	Sim

---

Response

STATUS

200

Response Body

{
    "settlement_process_payment_receipt_key": "47fa434a-68cc-47d4-af8c-6a84061f38a6",
    "settlement_process_payment_receipt_status": "confirmed",
    "updated_at": "2025-02-18T18:45:32.127654"
}

---

Response body params

Campo	Tipo	Descrição
settlement_process_payment_receipt_key	string	Chave única do comprovante de pagamento.
settlement_process_payment_receipt_status	string	Status atualizado do comprovante. Enumeradores settlement_process_payment_receipt_status.
updated_at	string	Data e hora da última atualização do comprovante (formato: ISO 8601).

---

Enumeradores settlement_process_payment_receipt_status

Enum	Descrição
confirmed	O investidor confirmou o recebimento do pagamento.
denied	O investidor rejeitou o comprovante de pagamento.