Page Comparison

Required mechanisms to authenticate a 3rd party session and trigger the integration to the APIThese endpoints support Merchant integrations of Flexiti services.

Table of Contents

...

POST /oauth/token

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/oauth/token

...

The refresh token is used to get a new access token once when the current one has expired.is about to expire. It cannot be refreshed after it is expired

In order to use it add the refresh token (provided in the original /oauth/token call) and change the grant_type to refresh_token. More information available here: How to Implement the Refresh Token

Scope Parameter Usage (IMPORTANT)

For the token endpoint there are two possible scopes: merchant or customer.

...

A token with a customer scope will be allowed in all endpoints required by customer facing UI, other endpoints will considered this token invalid.

...

- When to use: for Online channel implementations during the application and authorization flows (outlined below).
A token with a merchant scope will be allowed for all endpoints
- When to use: for In-store channel implementations, or Online channel back office processes like capturing an authorization, releasing, refunding/returning, etc.

The endpoints that should be called using a customer scope should be:

POST /client-id/{client_id}/merchants/login - depreciatedPOST i18n
GET /client-id/{client_id}widget/initterms-and-conditions
POST /client-id/{client_id}/customers/applydriverslicense
GET POST /client-id/{client_id}widget/terms-and-conditionsinit
POST /client-id/{client_id}/informationapply
POST /client-id/{client_id}/accounts/{account_number}/close
POST /client-id/{client_id}/accounts/{account_number}/calculate-interest
POST /client-id/{client_id}/account/{account_number}/verify
POST /client-id/{client_id}/authorization

Request Parameters:

Type	Parameter	Required	Details
FORMDATA	client_id	Yes	ASCII string (100) This is the Client ID given in the Developer User Account section
FORMDATA	client_secret	Yes	ASCII string (100) This is the Client Secret given in the Developer User Account section
HEADER	x-reference-id	Yes	ASCII string (32) GUID Unique identifier for the flow for traceability purposes
BODY	grant_type		ASCII string This is the client's access type possible values: 'password', 'refresh_token', 'client_credentials' default value: 'client_credentials'
BODY	refresh_token		ASCII string only to be used with the grant_type: refresh_token. It should be the refresh_token attribute in the last response of this method.
BODY	scope		ASCII string Available values: ‘customer', 'merchant’ Default value: merchant

Example Request:

Code Block

language	json

{
    "client_id": "flexitidemo",
    "client_secret": "77xde15a-9d33-4c15-930a-3se4b3as33e9",
    "grant_type": "client_credentials",
    "scope": "merchant"
}

Response Parameters:

Type	Parameter	Details
BODY	access_token	Bearer token to be used in subsequent calls
BODY	expires_in	Time, in seconds, that the token will last
BODY	refresh_token	Token to be used to refresh the access_token

Success Response:

Code Block
{ "token_type": "bearer", "access_token": "2d8f373a3c2b1e61baf5a7769930ff4f0e08cdb0", "expires_in": 1200, "refresh_token": "36e0fc3d7415145f4b1d71512c459fd6eaa13aa8", "scope": "merchant" }

...

GET /client-id/{client_id}/

...

i18n

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/{client-_id}/merchants/login?lang=en

Warning
This endpoint has been depreciated as of our 20.3 Release and is no longer necessary to authenticate the Merchant.

This service will log in the Merchant session and provide back an updated version of the list of parameters based on the language variable provided. This is required within the session to ensure the Merchant has the latest version of all parameters.

Request Parameters:

...

Type

...

Parameter

i18n

Or

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/{client_id}/i18n/{key}

This endpoint will return information for application form values and customer facing messaging like disclaimers
You can retrieve all information or filter for specific messages using a key in the URL

Request Parameters:

Type	Parameter	Required	Details
HEADER	authorization	Yes	ASCII string (

1000

40) 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
QUERY	lang		ASCII string (

2merchant_username

5)
Customer Preferred language
Available values: (en=English) or (fr=French)
Default value: en

BODY

QUERY

{key}

ASCII string

Optional information to log in a specific Sales Representative or Merchant location

BODY

merchant_password

ASCII string
Optional information to log in a specific Sales Representative or Merchant location

Example Request:

...

(1000)
Specific values can be used to filter the response
Not passing a value will response with all messages.
Available values:
- salutation
- provinces
- security_id
- govid_type
- govid_issued_by
- occupation
- transaction_type
- plan_id
- qcpa_disclosure
- insurance
- insurance_tc
- annual_fees
- housing_type

Success Response:

Code Block
{ "merchant_usernamesalutations": { "mr": "acmejewellersMr.", "merchant_passwordms": "dice-vanila-purse" }

Response Parameters:

...

Type

...

Parameter

...

Details

...

BODY

...

merchant_name

...

ASCII string (130)
Name of the merchant authenticated

...

BODY

...

merchant_id

...

number (10)
ID of the merchant authenticated

...

BODY

...

form_values

...

ASCII strings
Various values used in the credit application form

Success Response:

Code Block

breakoutMode	wide
language	json

{
    "merchant_name": "ACME Jewellers",
    "merchant_id": "123456"Ms.",
        "mrs": "Mrs.",
        "mss": "Miss."
    },
    "form_valuesprovinces": {
        "salutationAB": {
  "Alberta",
         "optionsBC": {
     "British Columbia",
          "mrMB": "Mr.Manitoba",
        "NB": "New Brunswick",
        "msNL": "Ms.Newfoundland & Labrador",
        "NS": "Nova Scotia",
        "mrsNT": "Mrs.Northwest Territories",
        "NU": "Nunavut",
        "mssON": "Miss.Ontario",
        "PE": "Prince Edward Island",
}         }"QC": "Quebec",
        "provinceSK": {"Saskatchewan",
        "YT": "Yukon Territory"
 "options": {  },
    "security_ids": {
        "AB4": "Alberta",What is the name of your favourite childhood friend?",
        "BC5": "BritishWhat Columbia",is the country of your ultimate dream vacation?",
         "MB6": "Manitoba",What was the first concert you attended?",
          "NB7": "New Brunswick",
       What is the name of the street you grew up on?",
        "NL8": "NewfoundlandWhat &is Labrador",the name of your first grade teacher?",
          "NS9": "Nova Scotia",What is your favourite movie?"
    },
    "govid_types": {
        "NTCADL": "NorthwestDriver's TerritoriesLicence",
        "CAHC": "Health Card",
        "NUCAPID": "NunavutProvincial ID Card",
        "CAP": "Passport",
        "ONCAPRC": "OntarioPermanent Resident Card",
        "CAICBC": "Insurance Corporation of British    "PE": "Prince Edward Island",Columbia",
        "CAAR": "Alberta Registries",
        "QCCASGI": "QuebecSaskatchewan Government Insurance",
    
           "SKCADSNS": "Saskatchewan",Department of Service Nova Scotia and Municipal Relations",
         "YTCADPPEI": "YukonDepartment Territory"of Transportation and Public Works of the Province of Prince Edward Island",
  }      "CASNB": "Service New }Brunswick",
        "security_qidCADGSNF": {
    "Department of Government Services and Lands of the Province of Newfoundland and Labrador",
        "optionsCADTNW": {"Department of Transportation of the Northwest Territories",
          "4CADCTN": "What is the nameDepartment of Community Government and Transportation of yourthe favouriteTerritory childhoodof friend?Nunavut",

               "5"CACSC": "What is the country of your ultimate dream vacation?Correctional Service Canada identification card (with the individual's name and photograph)",
        "CAGCEC": "Government of Canada employee identity card  "6": "What was the first concert you attended?",
  (with the individual's name and photograph)",
             "7CALCB": "WhatLiquor isControl theBoard nameAge of the street you grew up on?",Majority (BYID) card",
        "CACFL": "Canadian Firearms licence",
        "8CACFID": "WhatCanadian isForces the name of your first grade teacher?",
       identification card",
        "CAMPIC": "MPIC card issued by the Manitoba Public Insurance Corporation",
        "9CACAID": "WhatNEXUS isor yourCANPASS favouriteAir movie?"membership card (issued by Canada Border Services  Agency)"
    },
    "govid_issued_bys": {
  },         "govidoption_typedepends": {
            "optionsCADL": {
                "CADLAB": "Driver's LicenceAlberta",
                "CAHCBC": "HealthBritish CardColumbia",
                "CAPIDMB": "Provincial ID CardManitoba",
                "CAPNB": "PassportNew Brunswick",
                "CAPRCNL": "PermanentNewfoundland Resident& CardLabrador",
                "CAICBCNS": "Insurance Corporation of British ColumbiaNova Scotia",
                "CAARNT": "AlbertaNorthwest RegistriesTerritories",
                "CASGINU": "Saskatchewan Government InsuranceNunavut",
                "CADSNSON": "DepartmentOntario",
 of Service Nova Scotia and Municipal Relations",         "PE": "Prince Edward Island",
    "CADPPEI": "Department of Transportation and Public Works of the Province of Prince Edward Island"QC": "Quebec",
                "CASNBSK": "Service New BrunswickSaskatchewan",
                "CADGSNFYT": "DepartmentYukon ofTerritory"
Government Services and Lands of the Province of Newfoundland and Labrador",    },
            "CADTNWCAHC": "Department{
of Transportation of the Northwest Territories",           "BC": "British Columbia",
   "CADCTN": "Department of Community Government and Transportation of the Territory of Nunavut             "NB": "New Brunswick",
                "CACSCNL": "CorrectionalNewfoundland Service Canada identification card (with the individual's name and photograph)& Labrador",
                "CAGCECNT": "Government of Canada employee identity card (with the individual's name and photograph)",Northwest Territories",
                "NU": "Nunavut",
         "CALCB": "Liquor Control Board Age of Majority (BYID) card "QC": "Quebec",
                "CACFLSK": "Canadian Firearms licenceSaskatchewan",
                "CACFIDYT": "CanadianYukon ForcesTerritory"
identification card",           },
     "CAMPIC": "MPIC card issued by the Manitoba Public Insurance Corporation","CAPID": {
                 "CACAIDON": "Ontario"NEXUS
  or CANPASS Air membership card (issued by Canada Border Services Agency)"},
            }"CAP": {
       },         "govid_issued_byCANADA": {"Canada"
            "option_depends": {},
                 "CADLCAPRC": {
                    "AB": "Alberta","CANADA": "Canada"
            },
        "BC": "British Columbia",   "CAICBC": {
                "MBBC": "ManitobaBritish Columbia",
            },
       "NB": "New Brunswick",   "CAAR": {
                "NLAB": "Newfoundland & LabradorAlberta",
            },
       "NS": "Nova Scotia",   "CASGI": {
                "NTSK": "NorthwestSaskatchewan"
Territories",            },
        "NU": "Nunavut",   "CADSNS": {
                "ONNS": "OntarioNova Scotia",
            },
       "PE": "Prince Edward Island",   "CADPPEI": {
                "QCPE": "Quebec",Prince Edward Island"
            },
        "SK": "Saskatchewan",   "CASNB": {
                "YTNB": "YukonNew TerritoryBrunswick"
   
            },

               "CAHCCADGSNF": {
                    "BCNL": "BritishNewfoundland & ColumbiaLabrador",
            },
       "NB": "New Brunswick",   "CADTNW": {
                "NLNT": "NewfoundlandNorthwest & LabradorTerritories",
            },
       "NT": "Northwest Territories",   "CADCTN": {
                "NU": "Nunavut",
            },
       "QC": "Quebec",    "CACSC": {
                "SKCANADA": "Saskatchewan",Canada"
            },
            "YTCAGCEC": "Yukon Territory" {
                "CANADA": "Canada"
        },    },
            "CAPIDCALCB": {
                    "ONAB": "OntarioAlberta",
                "BC": "British }Columbia",
                "CAPMB": {"Manitoba",
                    "CANADA"NB": "CanadaNew Brunswick",
                "NL": "Newfoundland & }Labrador",
                "CAPRCNS": {"Nova Scotia",
                   "CANADANT": "CanadaNorthwest Territories",
                 }"NU": "Nunavut",
                "CAICBCON": {
   "Ontario",
                "BCPE": "BritishPrince Edward ColumbiaIsland",
                },"QC": "Quebec",
                "CAARSK": {"Saskatchewan",
                    "ABYT": "AlbertaYukon Territory"
 
              },
                "CASGICACFL": {
                    "SKCANADA": "SaskatchewanCanada"
  
             },
                "CADSNSCACFID": {
                    "NSCANADA": "Nova ScotiaCanada"
 
              },
                "CADPPEICAMPIC": {
                    "PE": "Prince Edward Island""MB": "Manitoba"
                   },
  
             "CASNBCACAID": {
 
                  "NBCANADA": "New BrunswickCanada"
            }
   },     }
    },
      "CADGSNFoccupation_ids": {
        "options": {
            "NLFE": "Newfoundland & Labrador"Full-time Employment",
            "PE":    }"Part-time Employment",
            "SE": "Self-Employed",
  "CADTNW": {          "RT": "Retired",
            "NTST": "Northwest TerritoriesStudent",
            "HM": "Homemaker",
  },          "DS": "Disability",
     "CADCTN": {      "SW": "Seasonal Worker",
            "NUUE": "Nunavut"Unemployed with income",
              },
 "UW": "Unemployed without income",
              "CACSCOT": {"Other"
        }
    },
      "CANADAtransaction_types": "Canada"{
        "promotional_purchase": "Financed Purchase",
     },   "regular_purchase": "Revolving Purchase"
      },
    "CAGCECplan_ids": {
        "1": "90 Days Grace, Equal Payments Regular      "CANADA": "Canada"Interest",
        "2": "Equal Payments, Low Interest",
    },    "4": "Equal Payments, Regular Interest",
        "CALCB5": {"Equal Payments,           No Interest",
        "AB6": "Alberta"No Interest, No Payments (S.A.C.)",
        "7": "No Interest, No Payments",
        "BC9": "BritishNo Columbia"Interest, Minimum monthly payments"
    },
       "qcpa_disclosure": "...",
    "MBinsurance": "Manitoba...",
    "insurance_tc": "...",
    "annual_fees": "...",
        "NB"housing_type": "New Brunswick",
          {
         "NLRent": "Newfoundland & LabradorRent",
         
          "NSOwned": "Nova ScotiaOwned",
        "Relatives": "Lives with Relatives",
        "NTOther": "Northwest TerritoriesOther",
                    "NU": "Nunavut",
                    "ON": "Ontario",
                    "PE": "Prince Edward Island",
                    "QC": "Quebec",
                    "SK": "Saskatchewan",
                    "YT": "Yukon Territory"
                },
                "CACFL": {
                    "CANADA": "Canada"
                },
                "CACFID": {
                    "CANADA": "Canada"
                },
                "CAMPIC": {
                    "MB": "Manitoba"
                },
                "CACAID": {
                    "CANADA": "Canada"
                }
            }
        }
    },
    "occupation_id": {
        "options": {
            "FE": "Full-time Employment",
            "PE": "Part-time Employment",
            "SE": "Self-Employed",
            "RT": "Retired",
            "ST": "Student",
            "HM": "Homemaker",
            "DS": "Disability",
            "SW": "Seasonal Worker",
            "UE": "Unemployed with income",
            "UW": "Unemployed without income",
            "OT": "Other"
        }
    }
}}
}

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/{client_id}/widget/init

The Flexiti widget is used for the Online channel only, and is for high orchestration scenarios, such as customer verification and multiple account selection. It is a UI component that’s an entry point to the Flexiti purchase flow.

For full Widget documentation start here - Flexiti Widget - POS API Online Channel Purchase Flow

Versions Compared

Old Version 48

New Version Current

Key

POST /oauth/token

Scope Parameter Usage (IMPORTANT)

Request Parameters:

Example Request:

Response Parameters:

Success Response:

GET /client-id/{client_id}/

i18n

Request Parameters:

Request Parameters:

Example Request:

Success Response:

Response Parameters:

Success Response:

POST /client-id/{clientId}/widget/init