Skip to main content

Creditarrangement

Represents a credit arrangement.

amountnumberrequired

The maximum credit amount the client can be exposed to.

approvedDatestring<date-time>

The date when the credit arrangement was approved.

Example: 2016-09-06T13:37:50+03:00
availableCreditAmountnumber

The available amount of the credit arrangement.

closedDatestring<date-time>

The date when the credit arrangement was closed.

Example: 2016-09-06T13:37:50+03:00
consumedCreditAmountnumber

The consumed amount of the credit arrangement, which is calculated as the difference between the amount and available amount.

creationDatestring<date-time>

The date when the credit arrangement was created.

Example: 2016-09-06T13:37:50+03:00
currency object

Represents a currency eg. USD, EUR.

codestring

Fiat(ISO-4217) currency code or NON_FIAT for non fiat currencies.

Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SLE, SOS, SRD, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VEF, VES, VND, VUV, WST, XAG, XAU, XAF, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZIG, ZWG, ZMK, ZWL, ZMW, SSP, NON_FIAT]

currencyCodestring

Currency code for NON_FIAT currency.

encodedKeystring

The encoded key of the credit arrangement, it is auto generated, and unique.

expireDatestring<date-time>required

The date when the credit arrangement expires.

Example: 2016-09-06T13:37:50+03:00
exposureLimitTypestring

The type of exposure limit calculation method used for the credit arrangement.

Possible values: [APPROVED_AMOUNT, OUTSTANDING_AMOUNT]

holderKeystringrequired

The encoded key of the credit arrangement holder (individual client or group).

holderTypestringrequired

Indicated the account holder type.

Possible values: [CLIENT, GROUP]

idstring

The ID of credit arrangement, can be generated and customized, and must be unique.

lastModifiedDatestring<date-time>

The last date when the credit arrangement was modified.

Example: 2016-09-06T13:37:50+03:00
notesstring

The notes or description of the credit arrangement.

startDatestring<date-time>required

The start date from which the credit arrangement became active.

Example: 2016-09-06T13:37:50+03:00
statestring

The state of the credit arrangement.

Possible values: [PENDING_APPROVAL, APPROVED, ACTIVE, CLOSED, WITHDRAWN, REJECTED]

subStatestring

The substate of credit arrangement.

Possible values: [PENDING_APPROVAL, APPROVED, ACTIVE, CLOSED, WITHDRAWN, REJECTED]

Creditarrangement
{
  "amount": 0,
  "approvedDate": "2016-09-06T13:37:50+03:00",
  "availableCreditAmount": 0,
  "closedDate": "2016-09-06T13:37:50+03:00",
  "consumedCreditAmount": 0,
  "creationDate": "2016-09-06T13:37:50+03:00",
  "currency": {
    "code": "AED",
    "currencyCode": "string"
  },
  "encodedKey": "string",
  "expireDate": "2016-09-06T13:37:50+03:00",
  "exposureLimitType": "APPROVED_AMOUNT",
  "holderKey": "string",
  "holderType": "CLIENT",
  "id": "string",
  "lastModifiedDate": "2016-09-06T13:37:50+03:00",
  "notes": "string",
  "startDate": "2016-09-06T13:37:50+03:00",
  "state": "PENDING_APPROVAL",
  "subState": "PENDING_APPROVAL"
}