PApalomma
Settlements

Get settlement by date and cycle

Retrieves a single settlement by date and cycle.

get/settlements/{date}/{cycle}

Request

  • Base URL
    https://api.palomma.com/v1
  • Auth
    HTTP bearer

Path parameters

datestring date required

Settlement date in YYYY-MM-DD format.

cyclestring required

Settlement cycle identifier.

Response

Settlement found

datestring required

Settlement date (YYYY-MM-DD).

cyclestring required

Settlement cycle identifier.

status'processing' | 'paid' | 'credited' | 'error' required

Settlement status: processing, paid, credited, or error.

numberOfInvoicesnumber required

Total number of invoices included in this settlement.

amountCollectednumber required

Gross amount collected in COP.

feesnumber required

Total fees deducted in COP.

feesPostpaidboolean required

Whether fees are billed separately (postpaid) for this settlement.

adjustmentsnumber required

Any adjustments applied to the settlement amount in COP.

gatewayboolean required

Whether this is a gateway settlement.

paymentAmountnumber required

Net amount paid out in COP.

Changes

No recorded changes to this operation across all 1 revision of this API.