Page Comparison

...

These are all of the Endpoints required to identify Customers.

GET /client-id/{client_id}/customers/

...

search

Code Block
https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/customers/lookup?vcc_number=1234123412341234

or

Code Block
https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/customers/lookup?account_number=123456789

or

Code Block
https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/customers/lookup?customer_id=123456789

This service allows the Merchant to gather the Customer information by providing any of the following:

a VCC number
an Account Number
a Customer ID

If you lookup via the VCC, the response will return the account the VCC belongs to.

Request Parameters:

...

Type

...

Parameter

...

Required

...

Details

...

HEADER

...

bearer token

...

Yes

...

search?first_name=John&last_name=Smith&dob=1900-01-01

This Endpoint returns a list of accounts for the customer being searched for.

Request Parameters:

Type	Parameter	Required	Details
HEADER	bearer token	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}
PATH	client_id	Yes	ASCII string (100) This is the Client ID given in the Developer User Account section
QUERY	first_name	langYes	vcc_number ASCII string (5) Customer Preferred language Available values: (en=English) or (fr=French) Default value: en	QUERY	80) The customer’s First Name on file
QUERY	last_name	Yes	ASCII string (130) The customer’s Last Name on file
QUERY	dob	Yes	ASCII string (1610) The Flexiti Card Number of the Customer This is the VCC (Flexiti Card)	QUERY	account_number	number (14) The Account Number of the Customer This is not the VCC (Flexiti Card)	QUERY	customer_id	number (12) The Customer ID of the account This is not the Account Number

Response Parameters:

Type	Parameter	Required	Details
BODY	available_credit	number (18,2) Customer’s open to buy	BODY	account_number	number (14) The Account Number of the Customer This is not the VCC (Flexiti Card)	BODY	customer_id	number (12) ID of the customer This is not the customer’s Account Number	BODY	security_qid.id	ASCII string Customer’s Security Question ID provided by the Customer Lookup service	BODY	security_qid.text	ASCII string Customer’s Security Question	BODY	email	ASCII string (100) Customer Email	BODY	phone_number	ASCII string (10) Customer Mobile Phone Number	BODY	address_1	ASCII string (250) Customer Address Line 1	BODY	address_2	ASCII string (100) Customer Address Line 2	BODY	city	ASCII string (100) Customer City	BODY	postal_code	ASCII string (10) Customer Postal Code	BODY	province	ASCII string (2) Customer Province (2 character syntax, ex. ON for Ontario) Available values: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.	BODY	payment_protection	boolean Whether the customer has insurance on the account	BODY	risk_rating	ASCII string (4) Risk rating of the Customer Possible values: L, M, H, XH, XXH, XXXH L - Low M - Medium H - High XH - X-High XXH - XX-High XXXH - XXX-High	BODY	offer_types.plan_name	ASCII string Name of the promotional plan available to the customer	BODY	offer_types.plan_id	number (3) ID of the promotional plan available to the customer	BODY	offer_types.offer_category	ASCII string Category of the promotional plans available to the customer Available values: equal_billing, deferred_payment	BODY	offer_types.term_options	number (3) terms of the promotional plan available to the customer	BODY	preferred_language	ASCII string (Format: YYYY-MM-DD The customer’s Date of Birth on file

Response Parameters:

Type	Parameter	Details
BODY	customer_id	number (12) The Customer ID of the account This is not the Account Number
BODY	account_status	ASCII string (1) “N” - Normal (only status that allows Customers to make Purchases/Authorizations) “A” - Auth Prohibited (Authorizations/Purchases are prohibited due to lack of payment, this status can be reverted automatically by the system) “F” - Frozen (Frozen accounts can NOT make Authorizations/Purchases, this status can only be reverted manually by Operations) “Z” - Charged Off (When accounts do not pay for 6 or more months, the account is written off the Portfolio) “C” - Closed (no longer in use, this represents accounts that are closed and can NOT be brought back to life, there are some old accounts with this status)
BODY	account_status_reason_code	ASCII string (4) Possible values: AAUT, FAGN, FBNK, FCCS, FCLC, FCLG, FCQC, FCND, FCOP, FDEC, FDVO, FFRD, FHRD, FIND, FINP, FLCK, FOPD, FPAC, FRMA, FRME, FRVK, FSKP, FSLM, NNOR, ZBNK, ZCCO, ZCCS, ZCOP, ZDEC, ZDVO, ZFRD, ZMCO, ZOPD, ZSLM, ZSRO
BODY	tos_agreement	boolean True means the customer accepted the Terms and Conditions False means they have not accepted the Terms and Conditions
BODY	risk_rating	ASCII string (4) Risk rating of the Customer Possible values: L, M, H, XH, XXH, XXXH L - Low M - Medium H - High XH - X-High XXH - XX-High XXXH - XXX-High
BODY	account_number	number (14) The Account Number of the Customer This is not the VCC (Flexiti Card)
BODY	credit_limit	number (18,2) Credit limit associated with the Customer’s account
BODY	available_credit	number (18,2) Customer’s open to buy
BODY	originating_merchant_id	number (10) ID of the Merchant where the customer’s application originated
BODY	originating_merchant_name	ASCII string (130) Name of the Merchant where the customer’s application originated
BODY	creation_date	ASCII string (10) Date the customer’s account was created
BODY	first_name	ASCII string (80) Customer’s First Name
BODY	last_name	ASCII string (130) Customer’s Last Name
BODY	card_ending_in	number (4) Last 4 digits of the customer’s VCC Number
BODY	preferred_language	ASCII string (5) Preferred Language (Locale) Available values: en-CA, fr-CA Default value: en-CA

Success Response:

Code Block

language	json

[
    {
        "availablecustomer_creditid": 5000"829825",
      "  "account_numberstatus": 20035156"N",
    "customer_id    "account_status_reason_code": 43353"NNOR",
        "securitytos_qidagreement"": [true,
        {
"risk_rating": "H",
           "id"account_number": "4116574819",

           "text"credit_limit": "What1000.00",
is the name of your favourite  childhood friend?"
 "available_credit": "659.51",
       },
  "originating_merchant_id": "11503",
      {  "originating_merchant_name": "Paris Jewellers",
        "idcreation_date": "52019-05-15",
   
        "textfirst_name": "David"What,
 is the country of your ultimate dream vacation?"last_name": "Morley",
       }
 "card_ending_in": "5941",
   ],     "addresspreferred_1language": "123 Anystreet Ave",fr-CA"
    },
    {
 "address_2": "Suite 100",     "citycustomer_id": "Toronto829875",
        "postalaccount_codestatus": "M5M1M1F",
    "province    "account_status_reason_code": "ONFLCK",
    "payment_protection    "tos": 0true,
        "risk_rating": "LY",
        "offeraccount_typesnumber": ["116574860",
        {
"credit_limit": "1000.00",
           "planavailable_namecredit": "90 Days Grace, Equal Payments Regular Interest847.00",
            "plan"originating_merchant_id": "111503",
            "offer_category"originating_merchant_name": "equal_billingParis Jewellers",
            "termcreation_optionsdate": ["2019-05-15",
               "first_name": "12David",
                "18"last_name": "Morley",
                "24",
                "36"
            ]
        }"card_ending_in": "6457",
    ],     "preferred_language": "EN_en-CA"
    }
]

...

GET /client-id/{client_id}/

...

breakoutMode	wide

customers/lookup

Code Block
https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/customers/lookup?vcc_number=1234123412341234

or

Code Block
https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/customers/lookup?account/12345678/verify

This endpoint allows you to verify a Customer using one of the four available verification methods, depending on the "format" specified in the body.

Request Parameters:

...

Type

...

Parameter

...

Required

_number=123456789

or

Code Block
https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/customers/lookup?customer_id=123456789

This service allows the Merchant to gather the Customer information by providing any of the following:

a VCC number
an Account Number
a Customer ID

If you lookup via the VCC, the response will return the account the VCC belongs to.

Request Parameters:

Type	Parameter	Required	Details
HEADER	bearer token	Yes	ASCII string (100040) 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}
PATH	client_id	Yes	ASCII string (100) This is the Client ID given in the Developer User Account section
PATHQUERY	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 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

Example Request:

Code Block

language	json

{
  "format": "security_question",
  "security_qid": "6",
  "security_answer": "Tool"
}

Success Responses:

200 - Success - Override

Code Block
{ "verification_code": 2485 }

200 - Success - SMS

Code Block
{ "verification_code": "verification_sent_to_sms" }

200 - Success - Email

Code Block
{ "verification_code": "verification_sent_to_email" }

GET /client-id/{client_id}/customers/search

Code Block
https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/customers/search?first_name=John&last_name=Smith&dob=1900-01-01

This Endpoint returns a list of accounts for the customer being searched for.

Request Parameters:

...

Type

...

Parameter

...

Required

...

Details

...

HEADER

...

bearer token

...

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}

...

PATH

...

client_id

...

Yes

...

ASCII string (100)
This is the Client ID given in the Developer User Account section

...

QUERY

...

first_name

...

Yes

...

ASCII string (80)
The customer’s First Name on file

...

QUERY

...

last_name

...

Yes

...

ASCII string (130)
The customer’s Last Name on file

...

QUERY

...

dob

...

Yes

...

ASCII string (10)
Format: YYYY-MM-DD
The customer’s Date of Birth on file

Response Parameters:

...

Type

...

Parameter

...

Required

...

Details

...

BODY

...

customer_id

...

number (12)
The Customer ID of the account
This is not the Account Number

...

BODY

...

account_status

...

ASCII string (1)
“N” - Normal (only status that allows Customers to make Purchases/Authorizations)
“A” - Auth Prohibited (Authorizations/Purchases are prohibited due to lack of payment, this status can be reverted automatically by the system)
“F” - Frozen (Frozen accounts can NOT make Authorizations/Purchases, this status can only be reverted manually by Operations)
“Z” - Charged Off (When accounts do not pay for 6 or more months, the account is written off the Portfolio)
“C” - Closed (no longer in use, this represents accounts that are closed and can NOT be brought back to life, there are some old accounts with this status)

...

BODY

...

account_status_reason_code

...

ASCII string (4)
Possible values: AAUT, FAGN, FBNK, FCCS, FCLC, FCLG, FCQC, FCND, FCOP, FDEC, FDVO, FFRD, FHRD, FIND, FINP, FLCK, FOPD, FPAC, FRMA, FRME, FRVK, FSKP, FSLM, NNOR, ZBNK, ZCCO, ZCCS, ZCOP, ZDEC, ZDVO, ZFRD, ZMCO, ZOPD, ZSLM, ZSRO

...

BODY

...

tos_agreement

...

boolean
True means the customer accepted the Terms and Conditions
False means they have not accepted the Terms and Conditions

...

BODY

...

risk_rating

...

ASCII string (4)
Risk rating of the Customer
Possible values: L, M, H, XH, XXH, XXXH
- L - Low
- M - Medium
- H - High
- XH - X-High
- XXH - XX-High
- XXXH - XXX-High

...

BODY

...

account_number

...

number (14)
The Account Number of the Customer
This is not the VCC (Flexiti Card)

...

BODY

...

credit_limit

...

number (18,2)
Credit limit associated with the Customer’s account

...

BODY

...

available_credit

...

number (18,2)
Customer’s open to buy

...

BODY

...

originating_merchant_id

...

number (10)
ID of the Merchant where the customer’s application originated

...

BODY

...

originating_merchant_name

...

ASCII string (130)
Name of the Merchant where the customer’s application originated

...

BODY

...

creation_date

...

ASCII string (10)
Date the customer’s account was created

...

BODY

...

first_name

...

ASCII string (80)
Customer’s First Name

...

BODY

...

last_name

...

ASCII string (130)
Customer’s Last Name

...

BODY

...

card_ending_in

...

number (4)
Last 4 digits of the customer’s VCC Number

...

BODY

...

preferred_language

...

ASCII string (5)
Preferred Language (Locale)
Available values: en-CA, fr-CA
Default value: en-CA

Success Response:

...

language	json

...

lang		ASCII string (5) Customer Preferred language Available values: (en=English) or (fr=French) Default value: en
QUERY	vcc_number		ASCII string (16) The Flexiti Card Number of the Customer This is the VCC (Flexiti Card)
QUERY	account_number		number (14) The Account Number of the Customer This is not the VCC (Flexiti Card)
QUERY	customer_id		number (12) The Customer ID of the account This is not the Account Number

Response Parameters:

Type	Parameter	Details
BODY	available_credit	number (18,2) Customer’s open to buy
BODY	account_number	number (14) The Account Number of the Customer This is not the VCC (Flexiti Card)
BODY	customer_id	number (12) ID of the customer This is not the customer’s Account Number
BODY	security_qid.id	ASCII string Customer’s Security Question ID provided by the Customer Lookup service
BODY	security_qid.text	ASCII string Customer’s Security Question
BODY	email	ASCII string (100) Customer Email
BODY	phone_number	ASCII string (10) Customer Mobile Phone Number
BODY	address_1	ASCII string (250) Customer Address Line 1
BODY	address_2	ASCII string (100) Customer Address Line 2
BODY	city	ASCII string (100) Customer City
BODY	postal_code	ASCII string (10) Customer Postal Code
BODY	province	ASCII string (2) Customer Province (2 character syntax, ex. ON for Ontario) Available values: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.
BODY	payment_protection	boolean Whether the customer has insurance on the account
BODY	risk_rating	ASCII string (4) Risk rating of the Customer Possible values: L, M, H, XH, XXH, XXXH L - Low M - Medium H - High XH - X-High XXH - XX-High XXXH - XXX-High
BODY	offer_types.plan_name	ASCII string Name of the promotional plan available to the customer
BODY	offer_types.plan_id	number (3) ID of the promotional plan available to the customer
BODY	offer_types.offer_category	ASCII string Category of the promotional plans available to the customer Available values: equal_billing, deferred_payment
BODY	offer_types.term_options	number (3) terms of the promotional plan available to the customer
BODY	preferred_language	ASCII string (5) Preferred Language (Locale) Available values: en-CA, fr-CA Default value: en-CA

Success Response:

Code Block

language	json

{
    "available_credit": 5000,
    "account_number": 20035156,
    "customer_id": 43353,
    "security_qid": [
        {
            "id": "4",
            "text": "What is the name of your favourite childhood friend?"
        },
        {
            "id": "5",
            "text": "What is the country of your ultimate dream vacation?"
        }
    ],
    "address_1": "123 Anystreet Ave",
    "address_2": "Suite 100",
    "city": "Toronto",
    "postal_code": "M5M1M1",
    "province": "ON",
    "payment_protection": 0,
    "risk_rating": "L",
    "offer_types": [
        {
            "plan_name": "90 Days Grace, Equal Payments Regular Interest",
            "plan_id": "1",
            "offer_category": "equal_billing",
            "term_options": [
                "12",
                "18",
                "24",
                "36"
            ]
        }
    ],
    "preferred_language": "EN_CA"
}

POST /client-id/{client_id}/account/{account_number}/verify

Code Block

breakoutMode	wide

https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/account/12345678/verify

This endpoint allows you to verify a Customer using one of the four available verification methods, depending on the "format" specified in the body.

Request Parameters:

Type	Parameter	Required	Details
HEADER	bearer token	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}
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 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

Example Request:

Code Block

language	json

{
  "format": "security_question",
  "security_qid": "6",
  "security_answer": "Tool"
}

Success Responses:

200 - Success - Override

Code Block
{ "verification_code": 2485 }

200 - Success - SMS

Code Block
{ "verification_code": "verification_sent_to_sms" }

200 - Success - Email

Code Block
{ "verification_code": "verification_sent_to_email" }

POST /client-id/{client_id}/customers/driverslicense

...

Code Block

language	json

{
    "first_name": "John",
    "middle_name": "Grey",
    "last_name": "Doe",
    "dob": "1974-05-15",
    "address_1": "55 UNIVERSITY AVE",
    "city": "TORONTO",
    "province": "ON",
    "postal_code": "M5J 2H7",
    "govid_type": "CADL",
    "govid_issuedby": "ON",
    "govid_number": "D61014070660905",
    "govid_expiry": "2020-05-15"
}

POST /client-id/{client_id}/accounts/{account_number}/close

...

200 - Success

Code Block
{ }

POST

...

/client-id/{client_id}/accounts/{account_number}/calculate-interest

Code Block
https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5/client-id/flexitidemo/accounts/12345/calculate-interest

...

Versions Compared

Old Version 42

New Version 43

Key

GET /client-id/{client_id}/customers/

search

Request Parameters:

Request Parameters:

Response Parameters:

Response Parameters:

Success Response:

GET /client-id/{client_id}/

customers/lookup

Request Parameters:

Request Parameters:

Example Request:

Success Responses:

200 - Success - Override

200 - Success - SMS

200 - Success - Email

GET /client-id/{client_id}/customers/search

Request Parameters:

Response Parameters:

Success Response:

Response Parameters:

Success Response:

POST /client-id/{client_id}/account/{account_number}/verify

Request Parameters:

Example Request:

Success Responses:

200 - Success - Override

200 - Success - SMS

200 - Success - Email

POST /client-id/{client_id}/customers/driverslicense

POST /client-id/{client_id}/accounts/{account_number}/close

200 - Success

POST

/client-id/{client_id}/accounts/{account_number}/calculate-interest