Settlement Resource

The Settlement resource returns information about any settlement activities that have occurred with the given batch or order.

Whenever a settlement payment has been received by Convera, this endpoint will display the amount received, amount due, and the order information associated with the payment. This endpoint can be used to track under or overpayments.

Currently, this endpoint does not track activity when settling orders from holding balances.

Settlement Resource

{
    "customerId": string,
    "batchId": string,
    "settlementOrder": [
        {
            "orderId": string,
            "lastDateReceived": string,
            "settlementCurrency": string,
            "amountReceived": 0,
            "remainingAmountDue": 0,
            "totalDue": 0
        }
    ]
}

Sample Response

{
    "customerId": "Customer123",
    "batchId": "Batch123",
    "settlementOrder": [
        {
            "orderId": "Order123",
            "lastDateReceived": "2022-01-01T00:00:00",
            "settlementCurrency": "USD",
            "amountReceived": 500.0,
            "remainingAmountDue": 300.0,
            "totalDue": 800.0
        }
    ]
}