Create credit card offer Use case
We are creating a credit card offer for a particular person with sample data.
Use case data
API parameters with values
The path parameter is the person ID for which you want to create the offer.
Credit type and price list for the credit offer
Servicing account details
Maximum amount offered by a bank to customers
Interests proposed to customers
Sample API call
To create the credit card offer, use the following endpoint:
Sample request
The sample request body is as follows:
Copy {
"offerTypeCode": "NEW_CREDIT",
"creditTypeCode": "REVOLVING_MONTHLY",
"priceListCode": "CREDIT_PL",
"servicingAccount": {
"servicingAccountRef": "12345",
"servicingAccountSource": "EXTERNAL"
},
"requestedMoney": {
"amount": "1000",
"currencyCode": "EUR"
},
"offeredMoney": {
"amount": "1000",
"currencyCode": "EUR"
},
"maxMoney": {
"amount": "1000",
"currencyCode": "EUR"
},
"interests": [
{
"interestTypeCode": "CASH_INT",
"rate": 11.00
},
{
"interestTypeCode": "OVERLIMIT_INT",
"rate": 15.00
},
{
"interestTypeCode": "PUR_INT",
"rate": 13.00
}
],
"invoiceDay": 1,
"invoiceDueDay": 20,
"countryCode": "EE",
"tenantCode": "MB"
}
Copy curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/persons/ID-3382/cards/offers' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMTBUMTI6NTc6MDEiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODg5OTM4MjF9.JTKWIOONauvHAmOgGZzY8py3Ne_x4OLMfO8_sy3GbwY' \
--header 'x-channel-code: system' \
--header 'Content-Type: application/json' \
--data '{
"offerTypeCode": "NEW_CREDIT",
"creditTypeCode": "REVOLVING_MONTHLY",
"priceListCode": "CREDIT_PL",
"servicingAccount": {
"servicingAccountRef": "12345",
"servicingAccountSource": "EXTERNAL"
},
"requestedMoney": {
"amount": "1000",
"currencyCode": "EUR"
},
"offeredMoney": {
"amount": "1000",
"currencyCode": "EUR"
},
"maxMoney": {
"amount": "1000",
"currencyCode": "EUR"
},
"interests": [
{
"interestTypeCode": "CASH_INT",
"rate": 11.00
},
{
"interestTypeCode": "OVERLIMIT_INT",
"rate": 15.00
},
{
"interestTypeCode": "PUR_INT",
"rate": 13.00
}
],
"invoiceDay": 1,
"invoiceDueDay": 20,
"countryCode": "EE",
"tenantCode": "MB"
}' Sample response
Below you will find the response to the sample request:
Copy {
"errors": null,
"validationErrors": null,
"data": {
"offerId": "C001664282471",
"applicationId": null,
"creditTypeCode": "REVOLVING_MONTHLY",
"priceListCode": "CREDIT_PL",
"offerTypeCode": "NEW_CREDIT",
"personId": "ID-3382",
"servicingAccount": {
"servicingAccountRef": "12345",
"servicingAccountSource": "EXTERNAL",
"servicingAccountNumber": null
},
"applicationScore": null,
"requestedMoney": {
"amount": 1000.00,
"currencyCode": "EUR"
},
"offeredMoney": {
"amount": 1000.00,
"currencyCode": "EUR"
},
"maxMoney": {
"amount": 1000.00,
"currencyCode": "EUR"
},
"invoiceDay": 1,
"invoiceDueDay": 20,
"repaymentRuleCode": "PERCENTAGE",
"statusCode": "PRESENTED",
"offerDate": "2023-07-10",
"offerValidUntilDate": "2023-07-20",
"apr": 13.80,
"monthlyRepaymentMoney": {
"amount": null,
"currencyCode": "EUR"
},
"monthlyRepaymentRate": 10,
"additionalData": null,
"countryCode": "EE",
"channelCode": "system",
"source": {
"sourceName": "",
"sourceRef": "",
"sourceLink": null
},
"contractHeaderId": null,
"contractNumber": null,
"currentVersionId": null,
"creditAccountId": null,
"statusChangeReasonCode": null,
"statusChangeReasonDetails": null,
"tenantCode": null,
"interests": [
{
"interestTypeCode": "CASH_INT",
"rate": 11.00,
"daysRuleCode": "ACTUAL/ACTUAL",
"validityRange": null
},
{
"interestTypeCode": "OVERLIMIT_INT",
"rate": 15.00,
"daysRuleCode": "ACTUAL/ACTUAL",
"validityRange": null
},
{
"interestTypeCode": "PUR_INT",
"rate": 13.00,
"daysRuleCode": "ACTUAL/ACTUAL",
"validityRange": null
}
]
}
} Result
We have created the credit card offer with the status PRESENTED and an offer ID in the response. After this, you can accept. decline, or cancel the offer using the offer ID.
