For each credit account, a credit limit is defined. When the account is created the credit limit value is set with the default value inherited from the product configuration; it can be also set during the creation of a contract.
Each permanent credit limit can be updated during the contract and credit card account lifecycle, within the range allowed by the Issuer.
Once updated, the new credit limit value is immediately available for next authorizations.
Issuers can also use temporary credit limit management for a credit card account.
The temporary credit limit can be added to an existing credit card account:
- for a given period
- the temporary credit limit value can be higher or lower than the permanent one but is limited by an exceptional amount, which is allowed by the Issuer per product
Once added the temporary credit limit is immediately available for next authorizations.
In our solution each Temporary Credit Limit is identified by a unique temporaryCreditLimitReference.
A set of API is provided in order to:
- Retrieve current credit limit for an account
- Update account credit limit
- Retrieve the list of temporary credit limits for a given account
- Create temporary credit limit
- Delete temporary credit limit
Retrieve Account Credit Limit
The API allows the permanent credit limit for a given account to be retrieved.
API links
Below an example of request for the:
- Account: 12348153189268935960
- Issuer: 1234
GET /api/v2/issuers/1234/accounts/12348153189268935960/credit-limit
Response data
{
" ""data":" "{
" ""creditLimitAmount":" "{
" ""value": 100000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
}
}Update Account Credit Limit
The API allows the permanent credit limit for a given account to be updated.
API links
Below an example of request for the:
- Account: 12348153189268935960
- Issuer: 1234
PUT /api/v2/issuers/1234/accounts/12348153189268935960/credit-limit
Request data
{
" ""creditLimitAmount":" "{
" ""value": 500000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}
}Response data
{
" ""responseMetadata":" "{
" ""correlationId":" ""75119fff-0da4-4ffd-841b-7bf1744ecdf4",
" ""statusMessage":" ""Executed successfully",
" ""statusCode": 200,
" ""responseDateTime":" ""2023-02-03T16:22:57.481+0100",
" ""timeTakenMs": 132
},
" ""data":" "{
" ""creditLimitAmount":" "{
" ""value": 500000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
}
}Retrieve Temporary Credit Limits For An Account
The API allows the temporary credit limits for a given account to be retrieved.
It is possible to request either only the active temporary credit limit or the history of temporary limits for the account.
API links
Below an example of request for the:
- Account: 12348153189268935960
- Issuer: 1234
GET /api/v2/issuers/1234/accounts/12348153189268935960/temporary-credit-limits?all=false
Response data
{
" ""data":" "[
" "{
" ""temporaryCreditLimitIdentifier":" "{
" ""temporaryCreditLimitReference":" ""94d757e5-7bca-4394-95e9-e8d9e00e7cd5"" "
},
" ""activationStartTime":" ""2023-02-03T00:00:00.000+00:00",
" ""activationEndTime":" ""2023-04-01T00:00:00.000+00:00",
" ""temporaryCreditLimitAmount":" "{
" ""value": 750000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
}" "
}" "
]
}Create A Temporary Credit Limit For An Account
The API allows temporary credit limits for a given account to be created.
In response, a temporary credit limit reference is provided.
Once added, the temporary credit limit is immediately available for next authorizations.
Idempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once. The response will be retrieved directly from our system.
API links
Below an example of request for the:
- Account: 12348153189268935960
- Issuer: 1234
POST /api/v2/issuers/1234/accounts/12348153189268935960/temporary-credit-limits
Request data
{
" ""temporaryCreditLimitAmount":" "{
" ""value": 750000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""activationStartTime":" ""2023-02-03T00:00:00.000Z",
" ""activationEndTime":" ""2023-04-01T00:00:00.000Z"
}Response data
{
" ""responseMetadata":" "{
" ""correlationId":" ""fe5eaec9-c707-4ee8-aac3-fb36804b44df",
" ""statusMessage":" ""Executed successfully",
" ""statusCode": 200,
" ""responseDateTime":" ""2023-02-03T16:34:11.810+0100",
" ""timeTakenMs": 149
},
" ""data":" "{
" ""temporaryCreditLimitIdentifier":" "{
" ""temporaryCreditLimitReference":" ""94d757e5-7bca-4394-95e9-e8d9e00e7cd5"" "
},
" ""temporaryCreditLimitAmount":" "{
" ""value": 750000,
" ""exponent": 2,
" ""isoCode":" ""EUR"" "
},
" ""activationStartTime":" ""2023-02-03T00:00:00.000+00:00",
" ""activationEndTime":" ""2023-04-01T00:00:00.000+00:00"" "
}
}Delete A Temporary Credit Limit For An Account
An existing temporary credit limit (active or scheduled) can be disabled at any moment.
The API allows a temporary credit limit for a given account to be deleted by providing the temporary credit limit reference.
API links
Below an example of request and response for:
- the account 12346393393948083995
- the issuer 1234
- the temporary credit limit reference: 94d757e5-7bca-4394-95e9-e8d9e00e7cd5
DELETE /api/1234/accounts/12348153189268935960/temporary-credit-limits/94d757e5-7bca-4394-95e9-e8d9e00e7cd5
Response data
{
" ""responseMetadata":" "{
" ""correlationId":" ""e064d310-8c97-40fb-8331-02443e986945",
" ""statusMessage":" ""Executed successfully",
" ""statusCode": 200,
" ""responseDateTime":" ""2023-02-03T16:48:04.819+0100",
" ""timeTakenMs": 131
},
" ""data":" "{
" ""temporaryCreditLimitIdentifier":" "{
" ""temporaryCreditLimitReference":" ""94d757e5-7bca-4394-95e9-e8d9e00e7cd5"" "
}" "
}
}