Versions Compared

Old Version 53

changes.mady.by.user PC (Unlicensed)

Saved on

compared with

New Version 54

changes.mady.by.user PC (Unlicensed)

Saved on

Key

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

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/flexitidemo{client_id}/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.

On the response you can be returned the following possible account statuses:

...

Normal “N” - only status that allows Customers to make Purchases/Authorizations

...

Auth Prohibited “A” - Authorizations/Purchases are prohibited due to lack of payment, this status can be reverted automatically by the system

...

Frozen “F” - Frozen accounts can NOT make Authorizations/Purchases, this status can only be reverted manually by Flexiti Operations

...

Charged Off “Z” - When accounts do not pay for 6 or more months, the account is written off the Portfolio.

...

-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

...

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/AuthorizationsAuthorizations/Purchases)

  • “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

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/flexitidemo{client_id}/customers/lookup?vcc_number=1234123412341234

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/flexitidemo{client_id}/customers/lookup?account_number=123456789

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/flexitidemo{client_id}/customers/lookup?customer_id=123456789

...

Code Block
breakoutModewide
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/flexitidemo{client_id}/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.

...

Code Block
languagejson
{
  "format": "security_question",
  "security_qid": "6",
  "security_answer": "ToolRainbow"
}

Success Responses:

200 - Success - Override

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/flexitidemo{client_id}/customers/driverslicense

...

Code Block
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/flexitidemo{client_id}/accounts/12345/close

This endpoint allows the closure of a QC account.

...

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

...