Payment Receipt Submission

This endpoint allows registering a payment receipt for a SettlementProcessPayment within an installment settlement process.

---

Payment Receipt Submission (POST)

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

METHOD

POST

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

---

Request Body

{
    "document_base64": "iVBORw0KGgoAAAANSUhEUgAAABQAAA==",
    "amount": 200.35
}

---

Request body params

Field	Type	Description	Required
document_base64	string	Payment receipt file in Base64 format.	Yes
amount	number	Payment amount recorded in the receipt.	Yes

---

Response

STATUS

201

Response Body

{
    "settlement_process_payment_receipt_key": "47fa434a-68cc-47d4-af8c-6a84061f38a6",
    "settlement_process_payment_receipt_status": "waiting_confirmation",
    "updated_at": "2025-02-18T18:39:47.153603",
    "amount": 200.35
}

---

Response body params

Field	Type	Description
settlement_process_payment_receipt_key	string	Unique key of the registered payment receipt.
settlement_process_payment_receipt_status	string	Receipt status. settlement_process_payment_receipt_status enumerators.
updated_at	string	Date and time of last receipt update (format: ISO 8601).
amount	number	Amount recorded in the payment receipt.

---

settlement_process_payment_receipt_status Enumerators

Enum	Description
waiting_confirmation	The receipt was registered and awaits investor confirmation.
confirmed	The receipt was validated by the investor.
denied	The receipt was rejected by the investor.