LogoLogo
Developer portal
  • Welcome
    • About cookbooks
  • Authentication
    • About authentication
    • Authenticate employee
    • Create customer credentials
    • Authenticate customer
    • Refresh JSON Web Token
    • Invalidate customer credentials
    • Export-import roles
      • Export selected roles
      • Import selected roles
      • Import all roles
  • Header parameters
    • About header parameters
    • Mandatory parameters
    • Optional parameters
      • Requests with same request ID
      • Requests without request ID
  • Employee
    • Create employee
    • Find employee by ID
    • Find employee by username
  • Person
    • Create private person
    • Create legal person
    • Activate person
    • Find person
      • Find person details
      • Find person addresses
    • Create person document
    • Update personal info
    • Update person address
    • Create customer group
    • Create additional contact
    • Assign person to group
    • Create person representation
    • Close person representation
    • Create person financial data
    • Inactivate person
    • Reactivate person
    • Reactivate person
    • Forget person
    • Remove person restoration key
  • ACCOUNTS
    • Create currency account
    • Create internal account
    • Create virtual account
    • Create account application
    • Set account access rights
    • Create account limit code
    • Create account limit type
    • Create account limit
    • Create account class code
    • Create account type class rule
    • Find person accounts
    • Search account transactions
  • Reports
    • Reports
    • Request to generate account transactions report
      • Account transactions report parameters
  • Check report generation status
  • Download requested report
  • DEPOSITS
    • Deposit product management
      • Create deposit class code
      • Create deposit product
      • Update deposit product
      • Activate deposit product
      • Find deposit product
      • Inactivate deposit product
    • Deposit flow
      • Create deposit application
      • Find deposit application
      • Create deposit offer
      • Find deposit offer
      • Edit deposit offer
      • Accept deposit offer
      • Decline deposit offer
      • Find deposit contract
    • Deposit contract management
      • Change payout details
      • Change contract prolongation status
      • Update contract header
      • Adjust deposit contract interest
      • Make premature termination
  • Payments
    • Create outgoing payments
      • Create SEPA payment
      • Create SWIFT payment
      • Create domestic UK payment
      • Create domestic US payment
    • Change payment
    • Cancel payment
    • Confirm payment
    • Find AML information of a payment
    • Find settled SEPA transaction
    • Create payment template
    • Initialise FX quote request
    • Get FX quote response
    • Initiate FX order
  • LOANS
    • Create loan application
    • Accept loan application
    • Find loan application offers
    • Create loan offer
    • Accept loan offer
    • Find person contracts
    • Accept loan contract
    • Disburse loan contract
    • Create contract fee booking
    • Default loan contract
  • CARDS
    • Create price list
    • Create price for the price list
    • Card counting and summing groups
      • Create counting group
      • Create summing group
      • Find counting values for card
      • Find summing values for account
    • Add BIN
    • Create upper limit group
    • Create upper usage group
    • Create card design
    • Create debit card product
    • Activate card product
    • Create debit card application
    • Create credit product
    • Create credit card offer
    • Accept credit card offer
  • Interest base rates
    • Add interest base rate type - periodic
    • Add interest base rate type - instant
  • Interest rate caps
    • Add interest rate cap type
  • Webhooks
    • About webhooks
    • Find available webhooks
    • Enable or disable notification for webhook
      • Enable with notification type and channel code
      • Enable with notification ID
      • Disable with notification type and channel code
      • Disable with notification ID
    • Search subscribed webhooks
    • Subscribe webhook
    • Update webhook subscription
    • Unsubscribe webhook
    • Webhooks with payloads
      • Person
      • Account
      • Deposit
      • Payments
      • AML processes
      • Loan
      • Card
      • Debt
      • Finance
      • Reports
      • Processes
  • Lookups
    • About lookups
    • Find existing lookup groups
    • Find lookup values
      • Find entities
      • Find lookup type codes
      • Find lookup types
      • Find translation of lookup type
    • Create lookup values
      • Create lookup type and codes
      • Create lookup code for existing type
      • Create lookup translation
    • Manage lookup values
      • Mark lookup code as default
      • Remove default lookup code
      • Delete lookup code
  • Custom fields
    • About custom fields
    • Create custom fields
      • Create field set
      • Create fields
      • Create fields with copied values
    • Find custom fields
      • Find field sets
      • Find fields
      • Search custom field sources
      • Get custom field value
    • Update custom fields
      • Update field set
      • Update field
      • Update custom field value
    • Manage custom fields
      • Insert custom field values
      • Copy custom field values
      • Deactivate field
      • Delete custom field value
  • Holidays
    • Create holiday
    • Search existing holidays
    • Search holiday by ID
    • Delete holiday
Powered by GitBook

© Tuum 2024

On this page
  • Use case
  • Sample API call
  • Sample request
  • Sample response
  • Result

Was this helpful?

Export as PDF
  1. CARDS

Create credit product

The credit product in the card domain is designed to set specific conditions for customer credit and can be linked to a credit card product or any other card product with credit terms.

Use case

We will create a credit product with interest, penalty and transaction settings. We will also include the setup rules for invoice generation and invoice repayment.

Use case data
API parameters with values

The product name CREDIT_PRODUCT has been given to a credit product in Estonia (EE) with the EUR currency, which has been set to an ACTIVE state.

The credit details are as follows: The selected credit account type is CREDIT1, with a minimum amount of 100, a maximum of 10000, and a default of 1000. The credit offer is set to be valid for 15 days.

EFFECT is the selected method for calculating the Annual Percentage Rate (APR).

Note: returns the effective annual interest rate, given the nominal annual interest rate and the number of compounding periods per year.

The card scheme selected is MASTERCARD.

The rule for the service account selected is CURRENT_ACCOUNT, and there is no requirement for a reference number.

Payments can be made before the due date and interest calculated per transaction.

The repayment rule is a percentage of the outstanding balance plus interest and fees. The minimum invoice amount is 100, minimum repayment rate is 10% .The fee repayment rule is set to TRANSACTION, the credit contract and account transaction-related fees will be debited from the credit account.

The first invoice will be generated at least 14 days after the contract is activated. Regular invoices are generated on the first day of the month and payment is due on the 20th.

The selected minimum withdrawal rate is FIXED with a minimum amount of 100.

The penalty feature would be enabled, allowing for a grace period of three days and a grace amount of 50.

The debt condition allows for a 30-day payment delay to avoid card blocking and a 90-day payment delay to prevent credit default.

Price list applicable for the credit type

Allowed price lists for the credit product

Interest conditions

The interest rates for purchases (PUR_INT) range from 1% to 31%, and the default rate is 19%. The interest amount is calculated using the ACTUAL/ACTUAL method.

The interest rates for cash withdrawals (CASH_INT) range from 1% to 31%, and the default rate is 19%. The interest amount is calculated using the ACTUAL/ACTUAL method.

Transaction details

We will set the grace type for card purchases (CARD_PUR) to PERIOD, with 0 grace days, and PUR_INT as the method of calculating interest.

We will set the grace type for card top-up (CARD_TOPUP) to PERIOD, with 0 grace days, and CASH_INT as the method of calculating interest.

The penalty conditions for the principal (PRI_P) to use the ACTUAL/ACTUAL method and a 10% default rate.

Receivable formation rules

Group of periodic (PERIODIC) repayments. Setting principal (PRI) repayments ranked first.

Group of periodic (PERIODIC) repayments. Setting principal penalty (PRI_P) repayments ranked second.

Group of periodic (PERIODIC) repayments. Setting cash withdrawal interest (CASH_INT) repayments ranked third.

Group of periodic (PERIODIC) repayments. Setting purchase interest (PUR_INT) repayments ranked fourth.

Group of periodic (PERIODIC) repayments. Setting opening fee (OPENING_FEE) repayments ranked fifth.

Group of premature repayments (PREMATURE_REPAYMENT). Setting principal (PRI) repayments ranked first.

Group of premature repayments (PREMATURE_REPAYMENT). Setting principal penalty (PRI_P) repayments ranked second.

Group of premature repayments (PREMATURE_REPAYMENT). Setting cash withdrawal interest (CASH_INT) repayments ranked third.

Group of premature repayments (PREMATURE_REPAYMENT). Setting opening fee (OPENING_FEE) repayments ranked fourth.

Group of premature repayments (PREMATURE_REPAYMENT). Setting purchase interest (PUR_INT) repayments ranked fifth.

Receivable line rules

Group of periodic (PERIODIC) repayment items. Setting principle (PRI) repayment sorting group ranked first.

Group of periodic (PERIODIC) repayment items. Setting opening fee (OPENING_FEE) repayment sorting group ranked second.

Group of periodic (PERIODIC) repayment items. Setting principle penalty (PRI_P) repayment sorting group ranked third.

Group of periodic (PERIODIC) repayment items. Setting cash withdrawal interest (CASH_INT) repayment sorting group ranked fourth.

Group of periodic (PERIODIC) repayment items. Setting purchase interest (PUR_INT) repayment sorting group ranked fifth.

Group of premature repayment (PREMATURE_REPAYMENT) items. Setting principle (PRI) repayment sorting group ranked first.

Group of premature repayment (PREMATURE_REPAYMENT) items. Setting opening fee (OPENING_FEE) repayment sorting group ranked second.

Group of premature repayment (PREMATURE_REPAYMENT) items. Setting principle penalty (PRI_P) repayment sorting group ranked third.

Group of premature repayment (PREMATURE_REPAYMENT) items. Setting cash withdrawal interest (CASH_INT) repayment sorting group ranked fourth.

Group of premature repayment (PREMATURE_REPAYMENT) items. Setting purchase interest (PUR_INT) repayment sorting group ranked fifth.

Group of one time (ONE-TIME) repayment items. Setting principle (PRI) repayment sorting group ranked first.

Group of one time (ONE-TIME) repayment items. Setting opening fee (OPENING_FEE) repayment sorting group ranked second.

Group of one time (ONE-TIME) repayment items. Setting principle penalty (PRI_P) repayment sorting group ranked third.

Group of one time (ONE-TIME) repayment items. Setting cash withdrawal interest (CASH_INT) repayment sorting group ranked fourth.

Group of one time (ONE-TIME) repayment items. Setting purchase interest (PUR_INT) repayment sorting group ranked fifth.

Sample API call

To create the credit product, use the following endpoint:

Sample request

The sample request body is as follows:

{
    "accountTypeCode": "CREDIT1",
    "amountRange": {
        "startValue": 100,
        "endValue": 10000
    },
    "aprMethodCode": "EFFECT",
    "blockingDays": 30,
    "currencyCode": "EUR",
    "countryCode": "EE",
    "creditTypeCode": "CREDIT_PRODUCT",
    "defaultAmount": 1000,
    "defaultDays": 90,
    "description": "Revolving credit with monthly payment",
    "feeRepaymentRuleCode": "TRANSACTION",
    "firstInvoiceLag": 14,
    "invoiceDay": 1,
    "invoiceDueDay": 20,
    "penaltyFeeEnabled": true,
    "prematureRepaymentAllowed": true,
    "transactionLevelInterest": true,
    "minInvoiceAmount": 100,
    "minRepaymentAmount": null,
    "minRepaymentRate": 10,
    "minWithdrawalAmount": 100,
    "minWithdrawalRate": null,
    "minWithdrawalTypeCode": "FIXED",
    "offerValidDays": 15,
    "penaltyGraceDays": 3,
    "penaltyGraceAmount": 50,
    "productScheme": "MASTERCARD",
    "serviceAccountRule": "CURRENT_ACCOUNT",
    "referenceNumberRule": "NONE",
    "repaymentRuleCode": "PERCENTAGE",
    "statusCode": "ACTIVE",
    "tenantCode": "TUUM",
    "defaultPriceListCode": "CREDIT_CARD",
    "pricing": {
        "defaultPriceListCode": "CREDIT_CARD",
        "allowedPriceListCodes": [
            "CREDIT_CARD"
        ]
    },
    "interests": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "interestTypeCode": "PUR_INT",
            "rateRange": {
                "startValue": 1,
                "endValue": 31
            },
            "defaultRate": 19,
            "daysRuleCode": "ACTUAL/ACTUAL",
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "interestTypeCode": "CASH_INT",
            "rateRange": {
                "startValue": 1,
                "endValue": 31
            },
            "defaultRate": 19,
            "daysRuleCode": "ACTUAL/ACTUAL",
            "tenantCode": "TUUM"
        }
    ],
    "transactions": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "transactionTypeCode": "CARD_PUR",
            "graceTypeCode": "PERIOD",
            "interestTypeCode": "PUR_INT",
            "graceDays": 0,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "transactionTypeCode": "CARD_TOPUP",
            "graceTypeCode": "PERIOD",
            "interestTypeCode": "CASH_INT",
            "graceDays": 0,
            "tenantCode": "TUUM"
        }
    ],
    "penalties": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "penaltyTypeCode": "PRI_P",
            "daysRuleCode": "ACTUAL/ACTUAL",
            "defaultRate": 10,
            "tenantCode": "TUUM"
        }
    ],
    "receivableFormationRules": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.ACCOUNT",
            "sourceItemTypeCode": "PRI",
            "itemTypeCode": "PRI",
            "formationSortOrder": 1,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_PENALTY",
            "sourceItemTypeCode": "PRI_P",
            "itemTypeCode": "PRI_P",
            "formationSortOrder": 2,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "CASH_INT",
            "itemTypeCode": "CASH_INT",
            "formationSortOrder": 3,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "PUR_INT",
            "itemTypeCode": "PUR_INT",
            "formationSortOrder": 4,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.FEE_BOOKING",
            "sourceItemTypeCode": "OPENING_FEE",
            "itemTypeCode": "OPENING_FEE",
            "formationSortOrder": 5,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.ACCOUNT",
            "sourceItemTypeCode": "PRI",
            "itemTypeCode": "PRI",
            "formationSortOrder": 1,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_PENALTY",
            "sourceItemTypeCode": "PRI_P",
            "itemTypeCode": "PRI_P",
            "formationSortOrder": 2,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "CASH_INT",
            "itemTypeCode": "CASH_INT",
            "formationSortOrder":3,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.FEE_BOOKING",
            "sourceItemTypeCode": "OPENING_FEE",
            "itemTypeCode": "OPENING_FEE",
            "formationSortOrder":4,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "PUR_INT",
            "itemTypeCode": "PUR_INT",
            "formationSortOrder": 5,
            "tenantCode": "TUUM"
        }
    ],
    "receivableLineRules": [
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        }
    ]
}
curl --location 'https://card-api.sandbox.tuumplatform.com/api/v1/credit-types' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMTEtMTZUMTE6NTY6MzYiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE3MDAxMzU3OTZ9.tLOuUKRZlpduO45W_dE9KwGDzmKwhhtaolWLLFXRLyc' \
--header 'x-channel-code: SYSTEM' \
--header 'Content-Type: application/json' \
--data '{
    "accountTypeCode": "CREDIT1",
    "amountRange": {
        "startValue": 100,
        "endValue": 10000
    },
    "aprMethodCode": "EFFECT",
    "blockingDays": 30,
    "currencyCode": "EUR",
    "countryCode": "EE",
    "creditTypeCode": "CREDIT_PRODUCT",
    "defaultAmount": 1000,
    "defaultDays": 90,
    "description": "Revolving credit with monthly payment",
    "feeRepaymentRuleCode": "TRANSACTION",
    "firstInvoiceLag": 14,
    "invoiceDay": 1,
    "invoiceDueDay": 20,
    "penaltyFeeEnabled": true,
    "prematureRepaymentAllowed": true,
    "transactionLevelInterest": true,
    "minInvoiceAmount": 100,
    "minRepaymentAmount": 100,
    "minRepaymentRate": 10,
    "minWithdrawalAmount": 100,
    "minWithdrawalRate": 10,
    "minWithdrawalTypeCode": "FIXED",
    "offerValidDays": 15,
    "penaltyGraceDays": 3,
    "penaltyGraceAmount": 50,
    "productScheme": "MASTERCARD",
    "serviceAccountRule": "CURRENT_ACCOUNT",
    "referenceNumberRule": "NONE",
    "repaymentRuleCode": "PERCENTAGE",
    "statusCode": "ACTIVE",
    "tenantCode": "TUUM",
    "defaultPriceListCode": "CREDIT_CARD",
    "pricing": {
        "defaultPriceListCode": "CREDIT_CARD",
        "allowedPriceListCodes": [
            "CREDIT_CARD"
        ]
    },
    "interests": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "interestTypeCode": "PUR_INT",
            "rateRange": {
                "startValue": 1,
                "endValue": 31
            },
            "defaultRate": 19,
            "daysRuleCode": "ACTUAL/ACTUAL",
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "interestTypeCode": "CASH_INT",
            "rateRange": {
                "startValue": 1,
                "endValue": 31
            },
            "defaultRate": 19,
            "daysRuleCode": "ACTUAL/ACTUAL",
            "tenantCode": "TUUM"
        }
    ],
    "transactions": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "transactionTypeCode": "CARD_PUR",
            "graceTypeCode": "PERIOD",
            "interestTypeCode": "PUR_INT",
            "graceDays": 0,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "transactionTypeCode": "CARD_TOPUP",
            "graceTypeCode": "PERIOD",
            "interestTypeCode": "CASH_INT",
            "graceDays": 0,
            "tenantCode": "TUUM"
        }
    ],
    "penalties": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "penaltyTypeCode": "PRI_P",
            "daysRuleCode": "ACTUAL/ACTUAL",
            "defaultRate": 10,
            "tenantCode": "TUUM"
        }
    ],
    "receivableFormationRules": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.ACCOUNT",
            "sourceItemTypeCode": "PRI",
            "itemTypeCode": "PRI",
            "formationSortOrder": 1,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_PENALTY",
            "sourceItemTypeCode": "PRI_P",
            "itemTypeCode": "PRI_P",
            "formationSortOrder": 2,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "CASH_INT",
            "itemTypeCode": "CASH_INT",
            "formationSortOrder": 3,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "PUR_INT",
            "itemTypeCode": "PUR_INT",
            "formationSortOrder": 4,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.FEE_BOOKING",
            "sourceItemTypeCode": "OPENING_FEE",
            "itemTypeCode": "OPENING_FEE",
            "formationSortOrder": 5,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.ACCOUNT",
            "sourceItemTypeCode": "PRI",
            "itemTypeCode": "PRI",
            "formationSortOrder": 1,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_PENALTY",
            "sourceItemTypeCode": "PRI_P",
            "itemTypeCode": "PRI_P",
            "formationSortOrder": 2,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "CASH_INT",
            "itemTypeCode": "CASH_INT",
            "formationSortOrder":3,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.FEE_BOOKING",
            "sourceItemTypeCode": "OPENING_FEE",
            "itemTypeCode": "OPENING_FEE",
            "formationSortOrder":4,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "PUR_INT",
            "itemTypeCode": "PUR_INT",
            "formationSortOrder": 5,
            "tenantCode": "TUUM"
        }
    ],
    "receivableLineRules": [
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        }
    ]
}'

Sample response

Below you will find the response to the sample request:

Response
{
    "errors": null,
    "validationErrors": null,
    "data": null
}

Result

The credit product has been created with settings for interest, penalty, and transactions, as well as rules for generating invoices and repayment.

This credit product can now be linked with credit or other card products to establish credit conditions.

PreviousCreate debit card applicationNextCreate credit card offer

Last updated 1 year ago

Was this helpful?

https://card-api.sandbox.tuumplatform.com/api/v1/credit-types

See more information about the endpoint in the Tuum developer portal.

"creditTypeCode": "CREDIT_PRODUCT",
"currencyCode": "EUR",
"countryCode": "EE",
"statusCode": "ACTIVE",
"accountTypeCode": "CREDIT1",
"amountRange": {
    "startValue": 100,
    "endValue": 10000
},
"defaultAmount": 1000,
"offerValidDays": 15,
"aprMethodCode": "EFFECT"
"productScheme": "MASTERCARD"
"serviceAccountRule": "CURRENT_ACCOUNT",
"referenceNumberRule": "NONE",
"prematureRepaymentAllowed": true,
"transactionLevelInterest": true,
"repaymentRuleCode": "PERCENTAGE"
"minInvoiceAmount": 100,
"minRepaymentAmount": null,
"minRepaymentRate": 10,
"feeRepaymentRuleCode": "TRANSACTION",
"firstInvoiceLag": 14,
"invoiceDay": 1,
"invoiceDueDay": 20,
"minWithdrawalAmount": 100,
"minWithdrawalRate": null,
"minWithdrawalTypeCode": "FIXED"
"penaltyFeeEnabled": true,
"penaltyGraceDays": 3,
"penaltyGraceAmount": 50,
"blockingDays": 30,
"defaultDays": 90,
"defaultPriceListCode": "CREDIT_CARD"
 "pricing": {
        "defaultPriceListCode": "CREDIT_CARD",
        "allowedPriceListCodes": [
            "CREDIT_CARD" ] },
  "interests": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "interestTypeCode": "PUR_INT",
            "rateRange": {
                "startValue": 1,
                "endValue": 31
            },
            "defaultRate": 19,
            "daysRuleCode": "ACTUAL/ACTUAL",
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "interestTypeCode": "CASH_INT",
            "rateRange": {
                "startValue": 1,
                "endValue": 31
            },
            "defaultRate": 19,
            "daysRuleCode": "ACTUAL/ACTUAL",
            "tenantCode": "TUUM"
        },
    ],
 "transactions": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "transactionTypeCode": "CARD_PUR",
            "graceTypeCode": "PERIOD",
            "interestTypeCode": "PUR_INT",
            "graceDays": 0,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "transactionTypeCode": "CARD_TOPUP",
            "graceTypeCode": "PERIOD",
            "interestTypeCode": "CASH_INT",
            "graceDays": 0,
            "tenantCode": "TUUM"
        }
    ],
"penalties": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "penaltyTypeCode": "PRI_P",
            "daysRuleCode": "ACTUAL/ACTUAL",
            "defaultRate": 10,
            "tenantCode": "TUUM"
        }
"receivableFormationRules": [
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.ACCOUNT",
            "sourceItemTypeCode": "PRI",
            "itemTypeCode": "PRI",
            "formationSortOrder": 1,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_PENALTY",
            "sourceItemTypeCode": "PRI_P",
            "itemTypeCode": "PRI_P",
            "formationSortOrder": 2,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "CASH_INT",
            "itemTypeCode": "CASH_INT",
            "formationSortOrder": 3,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "PUR_INT",
            "itemTypeCode": "PUR_INT",
            "formationSortOrder": 4,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PERIODIC",
            "sourceName": "CARD.FEE_BOOKING",
            "sourceItemTypeCode": "OPENING_FEE",
            "itemTypeCode": "OPENING_FEE",
            "formationSortOrder": 5,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.ACCOUNT",
            "sourceItemTypeCode": "PRI",
            "itemTypeCode": "PRI",
            "formationSortOrder": 1,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_PENALTY",
            "sourceItemTypeCode": "PRI_P",
            "itemTypeCode": "PRI_P",
            "formationSortOrder":2,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "CASH_INT",
            "itemTypeCode": "CASH_INT",
            "formationSortOrder": 3,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.FEE_BOOKING",
            "sourceItemTypeCode": "OPENING_FEE",
            "itemTypeCode": "OPENING_FEE",
            "formationSortOrder": 4,
            "tenantCode": "TUUM"
        },
        {
            "creditTypeCode": "CREDIT_PRODUCT",
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "sourceName": "CARD.CONTRACT_INTEREST",
            "sourceItemTypeCode": "PUR_INT",
            "itemTypeCode": "PUR_INT",
            "formationSortOrder": 5,
            "tenantCode": "TUUM"
        }
    ],
"receivableLineRules": [
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PERIODIC",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "PREMATURE_REPAYMENT",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PRI",
            "paymentSortGroup": 1,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "OPENING_FEE",
            "paymentSortGroup": 2,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PRI_P",
            "paymentSortGroup": 3,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "CASH_INT",
            "paymentSortGroup": 4,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        },
        {
            "receivableTypeCode": "ONE_TIME",
            "itemTypeCode": "PUR_INT",
            "paymentSortGroup": 5,
            "paymentSortOrder": 10,
            "debtTransferable": false,
            "tenantCode": "TUUM"
        }
    ]
}
create credit product