Envio de Comprovante de Pagamento

Este endpoint permite o cadastro de um comprovante de pagamento para um SettlementProcessPayment dentro de um processo de liquidação de parcelas.

---

Envio de Comprovante de Pagamento (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

MÉTODO

POST

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

---

Request Body

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

---

Request body params

Campo	Tipo	Descrição	Obrigatório
document_base64	string	Arquivo do comprovante de pagamento em formato Base64.	Sim
amount	number	Valor do pagamento registrado no comprovante.	Sim

---

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

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

---

Enumeradores settlement_process_payment_receipt_status

Enum	Descrição
waiting_confirmation	O comprovante foi cadastrado e aguarda a confirmação do investidor.
confirmed	O comprovante foi validado pelo investidor.
denied	O comprovante foi rejeitado pelo investidor.