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

• UTC - ISO_8601 Date

• The customer’s Date of Birth on file (YYYY-MM-DD)

BODY

customer_id

• ASCII string (100)

• ID of the customer

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 the Customer ID retrieved in any of the available endpointsnot 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

• UTC - ISO_8601

• 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

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

BODY

code

Yes

• ASCII string

• PDF417 code with driver licence information

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)

• The account number Account Number of the account Customer to be closed

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)

• The account number of the account to be closedAccount Number of the Customer

• This is not the VCC (Flexiti Card)

QUERY

lang

• ASCII string (5)

• Customer Preferred language

• Available values: (en=English) or (fr=French)

• Default value: en

BODY

amount

• number (18,2)

• Amount of the transaction to calculate interest on