List installments

get https://api.credix.finance/v1/installments

Lists all installments (assets) linked to your account.

Response

Response body

array of objects

object

string

required

Credipay's internal installment (asset) ID. UUID v4 format.

faceValueCents

number

required

Installment (asset) face value in cents.

assetStatus

string

required

deprecated

Installment (asset) state.

Created IssuancePending IssuancePendingRetry IssuanceFailed IssuanceSuccess AcquisitionPending AcquisitionSuccess AcquisitionFailed AdvancePending Advanced NotAdvanced Ineligible Recourse

status

string

required

Installment (asset) state.

collectionStatus

string

required

Installment (asset) collection status.

Open ProcessingPayment Repaid Settled Default Canceled

refundAmountCents

number

required

Refund value cents.

refundStatus

string

required

Refund status.

NoRefund PartialRefund FullRefund

settledAt

date-time

The date, in UTC ISO 8601 format, when the amounts were paid to CrediPay.

maturityDate

date-time

required

The date, in UTC ISO 8601 format, when the asset is expected to be paid.

invoice

object

required

The invoice that originated this installment (asset)

200Successful operation.