Page Comparison

...

Type	Parameter	Required	Details
HEADER	authorization	Yes	ASCII string (1000) This is the word “Bearer” with a space and then the access_token given in oauth/token API response Default value: Bearer {insert_bearer_token_from_oauth_here/token_api}
HEADER	x-reference-id	Yes	ASCII string (32) GUID Unique identifier for the flow for traceability purposes
PATH	client_id	Yes	ASCII string (100) This is the Client ID given in the Developer User Account section
PATH	account_number	Yes	number (14) This is the Customer ID retrieved in any of the available endpoints
BODY	format	Yes	ASCII string Verification format to be presented to the Customer Available values: sms, email, merchant_override, security_question, regular_purchase_bypass Default value: sms
BODY	security_qid	Required for format: security_question	number (5) Customer’s Security Question ID provided by the Customer Lookup service
BODY	security_answer	Required for format: security_question	ASCII string (50) Customer’s response to the Security Question
BODY	request_id	Yes for in-store channel	ASCII string (150) This is the identifier for a verification to application/transaction/authorization flow.

...

200 - Success - merchant_override

Code Block
{ "verification_code": 2485 }

...

Code Block
{ "verification_code": 2485 }

...

Type	Parameter	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 (35) Customer’s First Name
BODY	customer.last_name	ASCII string (50) 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.verify	boolean Indicate if a customer needs to verify their regular purchase This value will be true if: the account_number being passed has made ≤ 3 regular purchases in the past 24HS 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	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 value: admin
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

...

Code Block

breakoutMode	wide
language	json

{
    "account_number": 11223344,
    "amount": 250,
    "customer": {
        "air": 0.289,
        "available_credit": 8000,
        "first_name": "John",
        "last_name": "Smith",
        "category_type": "preferred"
    },
    "regular_purchase": {
        "term_amount": 250,
        "air": 0.289,
        "fees": [],
    
   "verify": true
    },
     "promotional_purchase": [
        {
            "plan_id": 4,
            "terms": [
                {
                    "term": 3,
                    "term_amount": 20.33,
                    "apr": 0.0999,
                    "fees": [
                        {
                            "description": "Administrative fees:",
                            "amount": 49.99,
                            "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": 5,
            "terms": [
                {
                    "term": 6,
                    "term_amount": 4.67,
                    "apr": 0,
                    "fees": [
                        {
                            "description": "Administrative fees:",
                            "amount": 3,
                            "type": "admin_monthly",
                            "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": 3.83,
                    "apr": 0,
                    "fees": [
                        {
                            "description": "Administrative fees:",
                            "amount": 3,
                            "type": "admin_monthly",
                            "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."
                        }
                    ]
                }
            ]
        }
    ]
}

...

Code Block

breakoutMode	wide
language	json

{
    "account_number": 11223344,
    "amount": 250,
    "customer": {
        "air": 0.3124,
        "available_credit": 1700,
        "first_name": "Jacques",
        "last_name": "Smith",
        "category_type": "premium"
    },
    "regular_purchase": {
        "term_amount": 250,
        "air": 0.3124,
        "fees": [],
        "verify": true
    },
    "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": []
                }
            ]
        }
    ]
}

Versions Compared

Old Version 83

New Version 84

Key

200 - Success - merchant_override