Versions Compared

Key

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

...

Type

Parameter

Required

Details

BODY

account_number

  • number (14)

  • The Account Number of the Customer

  • This is not the VCC (Flexiti Card)

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 (80)

  • Customer’s First Name

BODY

customer.last_name

  • ASCII string (130)

  • Customer’s Last Name

BODY

customer.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.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)

  • Possible valuesvalue: Admin, Annualadmin

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

    • This will not include annual fees

  • Merchant is obligated to display this to the customer

BODY

promotional_purchase.terms.apr

  • number (5,4)

  • It will be a coefficient

  • Merchant is obligated to display this to the customer

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)

  • Possible valuesvalue: Admin, Annualadmin

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
languagejson
{
    "account_number": 11223344,
    "amount": 250,
    "customer": {
        "air": 0.289,
        "available_credit": 8000,
        "first_name": "John",
        "last_name": "Hammond",
        "category_type": "preferred"
    },
    "regular_purchase": {
        "term_amount": 250,
        "air": 0.289,
        "fees": []
    },
    "promotional_purchase": [
        {
            "plan_id": 5,
            "terms": [
                {
                    "term": 6,
                    "term_amount": 44.67,
                    "apr": 0,
                    "fees": [
                        {
                            "description": "Administrative fees:",
                            "amount": 3,
                            "type": "admin",
                            "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."
                        }
                    ]
                },
                {
                    "term": 12,
                    "term_amount": 23.83,
                    "apr": 0,
                    "fees": [
                        {
                            "description": "Administrative fees:",
                            "amount": 3,
                            "type": "admin",
                            "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."
                        }
                    ]
                }
            ]
        }
    ]
}

Success Response - Quebec Customer

Code Block
breakoutModewide
languagejson
{
    "account_number": 11223344,
    "amount": 250,
    "customer": {
        "air": 0.3124,
        "available_credit": 1700,
        "first_name": "Jacques",
        "last_name": "Hugo",
        "category_type": "premium"
    },
    "regular_purchase": {
        "term_amount": 250,
        "air": 0.3124,
        "fees": []
    },
    "promotional_purchase": [
 

...

       {
            "

...

plan_id": 

...

5,
            "terms": [
  

...

              {
  

...

 

...

                 "

...

term": 

...

6,

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 "term_amount": 41.67,
                    "apr": 0,
  

...

         

...

     

...

    

...

"

...

fees": []
        

...

        

...

},
                {
                    "term": 

...

12,
                    "term_amount": 

...

20.

...

83,
                    "apr": 0,
                    "fees": []
                }
       

...

     ]
        },
        {
     

...

 

...

 

...

     "plan_id": 9,
            "terms": [
       

...

 

...

        {
                    "

...

term": 

...

6,
                    "term_amount": 250,
      

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

"apr": 0.35,

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

  

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

"fees"

...

: []
                },
                {
                    "term": 12,
                    "term_amount": 

...

250,
                    "apr": 0.35,
                    "fees": [

...

]
                }
            ]
        }
    ]
}