Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
breakoutModewide
https://{posapi_url}/flexiti/pos-api/v2.5.1/client-id/{client_id}/accounts/12345/calculate-interest

...

Type

Parameter

Details

BODY

account_number

  • number (14)

  • The Account Number of the Primary Account Holder

  • This is not the VCC (Flexiti Card)

BODY

account_type

  • ASCII string (100)

  • This is the type of account: consumer or business

BODY

amount

  • number (18,2)

  • Authorization amount

BODY

customer.available_credit

  • number (18,2)

  • Customer’s open to buy

BODY

customer.air

  • number (5,4)

  • air for the customer

BODY

customer.first_name

  • ASCII string (35)

  • Customer’s First Name

BODY

customer.last_name

  • ASCII string (50)

  • Customer’s Last Name

BODY

customer.category_type

  • ASCII string (30)

  • Category related to the customer’s risk rating

  • Possible values: preferred, premium, standard

BODY

regular_purchase.term_amount

  • number (18,2)

  • Value to explain the amount to be paid by month (or a deferred payment)

BODY

regular_purchase.air

  • number (5,4)

  • air for the purchase

BODY

regular_purchase.verify

  • boolean

  • Indicate if a customer can use regular_purchase_bypass as a format on the POST /client-id/{client_id}/account/{account_number}/verify endpoint for a regular revolve purchase.

  • This value will be true if:

    • the account_number being passed has made ≤ 3 regular purchases in the past 24HS; and,

    • the amount on the request is ≤ $200

BODY

regular_purchase.fees.description

  • ASCII string (50)

  • Customer facing label of this fee

BODY

regular_purchase.fees.amount

  • number (18,2)

  • Amount of the fees

BODY

regular_purchase.fees.type

  • ASCII String (20)

  • Denotes if the administrative fee amount is a monthly or total amount

  • Possible values:

    • admin_total

    • admin_monthly

BODY

regular_purchase.fees.message

  • ASCII string (1000)

  • Used to convey information necessary to notify the customer

  • Merchant is obligated to display this to the customer

BODY

promotional_purchase.plan_id

  • number (3)

  • ID of the promotional plan

BODY

promotional_purchase.terms.term

  • number (3)

  • Term of the promotional plan

  • Merchant is obligated to display this to the customer

BODY

promotional_purchase.terms.term_amount

  • number (18,2)

  • Value to explain the amount to be paid by month (or a deferred payment)

    • This will include admin fees

  • Merchant is obligated to display this to the customer

BODY

BODY

promotional_purchase.terms.apr

  • number (5,4)

  • It will be a coefficient

  • Merchant is obligated to display this to the customer

promotional_purchase.terms.fees.annual_rates.description

  • ASCII string (50)

  • Customer facing long-form label of this feeinterest rate

  • Merchant is obligated can choose to display either this field or the short-form label to the customer

BODY

promotional_purchase.terms.feesannual_rates.amountrate

  • number (18,2)Amount of the fees

  • Applicable interest rate presented in decimal form

  • Merchant is obligated to display this rate to the customer

BODY

promotional_purchase.terms.feesannual_rates.type

  • ASCII String (20)Whether the fees displayed are per month or in totalstring

  • Customer facing short-form label of the interest rate

  • Merchant can choose to display either this field or the long-form label to the customer

  • Possible values: admin_total, admin_monthly“APR”, “AIR” depending on the plan type / plan_id

BODY

promotional_purchase.terms.feesannual_rates.message

  • ASCII string (1000)

  • Used to convey information legal disclaimer necessary to notify the customer about their promotional plan

  • Merchant is obligated to display this to the customer

Success Response - ROC Customer:

...

breakoutModewide
languagejson

...

  • within 1-click away from the plan selection

BODY

promotional_purchase.terms.fees.description

  • ASCII string (50)

  • Customer facing label of this fee

  • Merchant is obligated to display this to the customer

BODY

promotional_purchase.terms.fees.amount

  • number (18,2)

  • Amount of the fees

  • Merchant is obligated to display this to the customer

BODY

promotional_purchase.terms.fees.type

  • ASCII String (20)

  • Whether the fees displayed are per month or in total

  • Possible values: admin_total, admin_monthly

BODY

promotional_purchase.terms.fees.message

  • ASCII string (1000)

  • Used to convey information necessary to notify the customer

  • Merchant is obligated to display this to the customer

Success Response - ROC Customer:

Code Block
breakoutModewide
languagejson
{
    "account_number": 116994755,
    "account_type": "consumer",
    "amount": 10.5,
    "customer": {
        "air": 0.3099,
        "available_credit": 14000,
        "first_name": "Flexiti",
        "last_name": "MITester",
        "category_type": "preferred"
    },
    "regular_purchase": {
        "term_amount": 10.5,
        "air": 0.3099,
        "fees": [],
        "verify": true
    },
    "promotional_purchase": [
        {
            "plan_id": 4,
            "terms": [
                {
                    "term": 3,
                    "term_amount": 3.56,
                    "fees": [],
                    "annual_rates": {
                        "description": "Annual Promotional Interest Rate:",
                        "rate": 0.0999,
                        "type": "APR",
                        "message": "Promotional annual interest rate applies during the promotional period and is included in your estimated monthly payments. Account annual interest rate is charged if the promo is cancelled or expires without full payment and applies when promos are not in effect."
                    }
                },
                {
                    "term": 6,
                    "term_amount": 10.38,
                    "fees": [
                        {
                            "description": "Administrative fees:",
                            "amount": 50,
                            "type": "admin_total",
                            "message": "Although your administrative fee may be represented as a monthly or annual amount, the fee is due in full if the account is paid off early. See terms and conditions for full details."
                        }
                    ],
                    "annual_rates": {
                        "description": "Annual Promotional Interest Rate:",
                        "rate": 0.0999,
                        "type": "APR",
                        "message": "Promotional annual interest rate applies during the promotional period and is included in your estimated monthly payments. Account annual interest rate is charged if the promo is cancelled or expires without full payment and applies when promos are not in effect."
                    }
                },
                {
                    "term": 12,
                    "term_amount": 5.32,
                    "fees": [
                        {
                            "description": "Administrative fees:",
                            "airamount": 049.28999,
        "available_credit": 8000,         "first_name": "John",         "last_nametype": "Smithadmin_total",

       "category_type": "preferred"     },     "regular_purchase": {         "term_amountmessage": 250,
        "air": 0.289,
        "fees": []
    },
     "promotional_purchase": [ "Although your administrative fee may be represented as a monthly or annual amount, the fee is due in full if the account is paid off early. See terms and conditions for full details."
           {             "plan_id": 4,}
             "terms": [      ],
          {          "annual_rates": {
         "term": 3,              "description": "Annual Promotional Interest Rate:",
  "term_amount": 20.33,                     "aprrate": 0.0999,
                    "fees": [   "type": "APR",
                    {    "message": "Promotional annual interest rate applies during the promotional period and is included in your estimated monthly payments. Account annual interest rate is charged if "description": "Administrative fees:",
                            "amount": 49.99,the promo is cancelled or expires without full payment and applies when promos are not in effect."
                    }
           "type": "admin_total",    }
            ]
        },
  "message": "Although your administrative fee may be{
represented as a monthly or annual amount, the fee is due in full if the account is paid off early. See terms and conditions for full details."
 "plan_id": 6,
            "terms": [
                {
      }              "term": 3,
     ]                 }"term_amount": 10.5,
            ]         }"fees": [],
        {             "planannual_idrates": 5,{
            "terms": [           "description": "Annual Interest Rate:",
   {                     "termrate": 60.3099,
                     "term_amount   "type": 4.67"AIR",
                        "aprmessage": 0,
                    "fees": [
         "Interest at the annual interest rate accrues (on applicable plans) during the promo period and will be charged if the balance is not paid in full by the promo expiry date or if the promo is cancelled due to payment default on the account."
               {     }
                },
      "description": "Administrative fees:",        {
                    "amountterm": 36,
                    "term_amount": 70.49,
      "type": "admin_monthly",                  "fees": [
          "message": "Although your administrative fee may be represented as a monthly or annual amount, the{
fee is due in full if the account is paid off early. See terms and conditions for full details."          "description": "Administrative fees:",
            }                "amount": 59.99,
   ]                 },        "type": "admin_total",
       {                     "termmessage": 12,
                    "term_amount": 3.83,
    "Although your administrative fee may be represented as a monthly or annual amount, the fee is due in full if the account is paid off early. See terms and conditions for full details."
               "apr": 0,        }
            "fees": [       ],
                 {   "annual_rates": {
                        "description": "AdministrativeAnnual Interest feesRate:",

                           "amountrate": 30.3099,
                            "type": "admin_monthlyAIR",
  
                         "message": "AlthoughInterest yourat administrative fee may be represented as a monthly or annual amount, the fee is due in full if the account is paid off early. See terms and conditions for full details."
                        }the annual interest rate accrues (on applicable plans) during the promo period and will be charged if the balance is not paid in full by the promo expiry date or if the promo is cancelled due to payment default on the account."
                    ]}
                }
            ]
        }
    ]
}

Success Response - Quebec Customer

Code Block
breakoutModewide
languagejson
{
    "account_number": 11223344 116994859,
    "account_type": "consumer",
    "amount": 25010.5,
    "customer": {
        "air": 0.31243099,
        "available_credit": 170013500,
        "first_name": "JacquesFlexiti",
        "last_name": "SmithMITester",
        "category_type": "premiumpreferred"
    },
    "regular_purchase": {
        "term_amount": 25010.5,
        "air": 0.31243099,
        "fees": []],
        "verify": true
    },
    "promotional_purchase": [
        {
            "plan_id": 54,
            "terms": [
                {
                    "term": 63,
                    "term_amount": 413.6756,
                    "aprfees": 0[],
                    "feesannual_rates": []{
                },        "description": "Annual Promotional Interest  Rate:",
   {                     "termrate": 12,0.0999,
                        "term_amounttype": 20.83"APR",
                    "apr": 0,
                    "fees": []
    "message": "Promotional annual interest rate applies during the promotional period and is included in your estimated monthly payments. Account annual interest rate is charged if the promo is cancelled or expires without full payment and applies when promos are not in effect."
               }     }
       ]         },
        {        {
      "plan_id": 9,             "termsterm": [ 6,
                    {"term_amount": 1.8,
                    "termfees": 6[],
                    "termannual_amountrates": 250,{
                        "aprdescription": 0.35"Annual Promotional Interest Rate:",
                    "fees": []   "rate": 0.0999,
            },            "type": "APR",
   {                     "termmessage": 12,"Promotional annual interest rate applies during the promotional period and is included in your estimated monthly payments. Account annual interest  "term_amount": 250,
                    "apr": 0.35,rate is charged if the promo is cancelled or expires without full payment and applies when promos are not in effect."
                     "fees": []}
                }
            ]
        }
    ]
}