Payment Confirmation

This endpoint allows an investor to confirm or reject a payment receipt within a SettlementProcessPayment.

---

Payment Confirmation (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

METHOD

PATCH

Path Params

Field	Type	Description	Characters
SECURITY-KEY	string	Unique security key (UUID v4).	36
INSTALLMENT-KEY	string	Unique installment key (UUID v4).	36
SETTLEMENT-PROCESS-KEY	string	Unique settlement process key (UUID v4).	36
SETTLEMENT-PROCESS-PAYMENT-KEY	string	Unique payment key within the process (UUID v4).	36
SETTLEMENT-PROCESS-PAYMENT-RECEIPT-KEY	string	Unique payment receipt key (UUID v4).	36

---

Request Body

{
    "settlement_process_payment_receipt_status": "confirmed"
}

---

Request body params

Field	Type	Description	Required
settlement_process_payment_receipt_status	string	Receipt status. Must be confirmed or denied. settlement_process_payment_receipt_status enumerators.	Yes

---

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

Field	Type	Description
settlement_process_payment_receipt_key	string	Unique payment receipt key.
settlement_process_payment_receipt_status	string	Updated receipt status. settlement_process_payment_receipt_status enumerators.
updated_at	string	Date and time of last receipt update (format: ISO 8601).

---

settlement_process_payment_receipt_status Enumerators

Enum	Description
confirmed	The investor confirmed receipt of the payment.
denied	The investor rejected the payment receipt.