Page Comparison

HEADER

authorization

Yes

• ASCII string (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

• This is the Client ID given in the Developer User Account section

QUERY

lang

• ASCII string (5)

• Customer Preferred language

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

• Default value: en

QUERY

vcc_number

• ASCII string (16)

• The FlexitiCard Number (VCC) of the Customer

QUERY

account_number

• number (14)

• The Account Number of the Customer

• This is not the FlexitiCard number (VCC)

QUERY

customer_id

• number (12)

• The Customer ID of the accountPrimary Account Holder

• This is not the Account Number

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 Account Number of the Primary Account Holder retrieved in any of the available endpoints

BODY

vcc_number

No

• ASCII string(16)

• The FlexitiCard number (VCC) provided by the Customer

• To be used in a Business Card’s authorized Account Authorized User’s purchase, sent with the Master Primary account Holder’s Account number

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

BODY

request_id

Yes for in-store channel

• ASCII string (150)

• This is the identifier for a verification to application/transaction/authorization flow.

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)

• The Account Number of the CustomerPrimary Account Holder

• his is not the FlexitiCard number (VCC)

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

BODY

account_number

• number (14)

• The Account Number of the CustomerPrimary Account Holder

• This is not the VCC (Flexiti Card)

BODY

account_type

• ASCII string (100)

• This is the type of account the customer has: consumer or business

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.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)

• Whether the fees displayed are per month or in total

• Possible values: admin_total, admin_monthly

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