Transactions Endpoints - POS API

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

QUERY

lang

• ASCII string (5)

• Customer Preferred language

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

• Default value: en

BODY

transaction_type

Yes

• ASCII string

• This is the Transaction Type:

  • for Deposits, use "deposit”;

  • for In-Store Payments, use "instore_payment”;

  • for Trade-In, please use "tradein".

BODY

amount

• number (18,2)

• the Transaction Amount

• this applies for all transaction types

BODY

vcc_number

• number (16)

• The Flexiti Card Number provided by the Customer

• This is the FlexitiCard number (VCC)

BODY

account_number

• number (14)

• Flexiti Account Number retrieved from the /client-id/{client_id}/customers/lookup or the /client-id/{client_id}/customers/search endpoints

• This is not the FlexitiCard number (VCC) or the Customer ID

BODY

customer_id

• string (12)

• Flexiti Customer ID

• This is not the FlexitiCard number (VCC) or the Customer ID

BODY

verification_code

Yes

• number (4)

• Verification number provided in the Customer Verification service from the /account/{account_number}/verify endpoint

BODY

request_id

Yes for in-store channel

• ASCII string (150)

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

BODY

external_location_id

Yes for in-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own location reference

BODY

external_employee_id

Yes for in-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own employee reference

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

QUERY

lang

• ASCII string (5)

• Language the message and description parameters on the response will be displayed in

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

• Default value: en

BODY

account_number

Yes

• number (14)

• Flexiti Account Number retrieved from the /client-id/{client_id}/customers/lookup or the /client-id/{client_id}/customers/search endpoints

• This is not the FlexitiCard number (VCC) or the Customer ID

BODY

vcc_number

No

• ASCII string(16)

• The Flexiti Card Number provided by the Customer

• This is the FlexitiCard number (VCC)

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

BODY

reference

No

• ASCII String (40)

• Merchant Order ID to be saved within the credit authorization

BODY

financing_option.transaction_type

Yes

• ASCII String (20)

• Type of transaction

• Available values: promotional_purchase, regular_purchase

BODY

financing_option.plan_id

Yes for transaction_type = promotional_purchase

• number (3)

• Only applicable to Promotional Purchases

• Plan ID

BODY

financing_option.term

Yes for transaction_type = promotional_purchase

• number (3)

• Only applicable to Promotional Purchases

• Term

BODY

amount

Yes

• number (18,2)

• the Transaction Amount

• this applies for all transaction types

BODY

auto_capture

Yes

• boolean

• This determines if an actual authorization occurs or a purchase (autorization and capture at the same time)

BODY

verification_code

Yes for in-store POS integrations.

Not to be passed for Online implementations using the Widget

• number (4)

• Verification number provided in the Customer Verification service from the /account/{account_number}/verify endpoint

BODY

sku_data.purchase_order

No

• ASCII string (10)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Purchase Number For the Merchant

BODY

sku_data.shipping_total

No

• number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• the Shipping total amount to be displayed, if applicable

BODY

sku_data.register_id

No

• ASCII string (50)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The cashier machine where the transaction was placed

BODY

sku_data.transaction_discount_total

No

• Integer (12,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Sum of all discounts on the order

BODY

sku_data.transaction_subtotal

No

• Integer (12,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Sum of all totals for all items

BODY

sku_data.gst_hst

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Goods and Services Tax (GST) and the Harmonized Sales Tax (HST)

BODY

sku_data.pst

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Provincial Sales Tax applied to the order

BODY

sku_data.transaction_total

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• transaction_total = transaction_subtotal + gst_hst + pst

BODY

sku_data.products.sku_id

No

• ASCII string (150)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Unique Identifier of the product SKU (Stock Keeping Unit)

BODY

sku_data.products.category

No

• ASCII string (30)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Category for the product

BODY

sku_data.products.description

No

• ASCII string (150)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Business-friendly description of the product

BODY

sku_data.products.quantity

No

• Number (5)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The quantity of the items for the SKU array

  • Positive integer for sales

  • Negative - integer for a return

BODY

sku_data.products.unit_price

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The price for a single SKU item

BODY

sku_data.products.extended_price

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• extended_price = [(unit_price x quantity) - discount_price] for this particular SKU array

BODY

billing_information.first_name

Yes if Online Channel

• ASCII string (80)

• Information used to match/verify the Account details on file

• Billing Address Customer’s First Name

BODY

billing_information.last_name

Yes if Online Channel

• ASCII string (130)

• Information used to match/verify the Account details on file

• Billing Address Customer’s Last Name

BODY

billing_information.address_1

Yes if Online Channel

• ASCII string (250)

• Information used to match/verify the Account details on file

• Billing Address Line 1

BODY

billing_information.address_2

Yes if Online Channel

• ASCII string (100)

• Information used to match/verify the Account details on file

• Billing Address Line 2

BODY

billing_information.city

Yes if Online Channel

• ASCII string (100)

• Information used to match/verify the Account details on file

• Billing address city

BODY

billing_information.province

Yes if Online Channel

• ASCII string (2)

• Information used to match/verify the Account details on file

• Billing Address Province (2 character syntax, ex. ON for Ontario)

• Available values: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.

BODY

billing_information.postal_code

Yes if Online Channel

• ASCII string (10)

• Information used to match/verify the Account details on file

• Billing Address Postal Code

BODY

shipping_information.first_name

Yes if Online Channel

• ASCII string (80)

• Information used to match/verify the Account details on file

• Shipping Address Customer’s First Name

BODY

shipping_information.last_name

Yes if Online Channel

• ASCII string (130)

• Information used to match/verify the Account details on file

• Shipping Address Customer’s Last Name

BODY

shipping_information.address_1

Yes if Online Channel

• ASCII string (250)

• Information used to match/verify the Account details on file

• Shipping Address Line 1

BODY

shipping_information.address_2

Yes if Online Channel

• ASCII string (100)

• Information used to match/verify the Account details on file

• Shipping Address Line 1

BODY

shipping_information.city

Yes if Online Channel

• ASCII string (100)

• Information used to match/verify the Account details on file

• Shipping Address City

BODY

shipping_information.province

Yes if Online Channel

• ASCII string (2)

• Information used to match/verify the Account details on file

• Shipping Address Province (2 character syntax, ex. ON for Ontario)

• Available values: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.

BODY

shipping_information.postal_code

Yes if Online Channel

• ASCII string (10)

• Information used to match/verify the Account details on file

• Shipping Address Postal Code

BODY

widget_session_id

Yes if Online Channel

• string (24)

• Used in the Online channel

• This widget unique session ID is inserted as part of the redirect_url of the POST /client-id/{clientId}/widget/init response.

• It will be included on the events that are being triggered by the Widget.

BODY

request_id

Yes for in-store channel

• ASCII string (150)

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

• Ideally, this field’s value can uniquely identify each transaction

BODY

external_location_id

Yes for In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own location reference

BODY

external_employee_id

Yes for In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own employee reference

BODY

authorization_id

• number (16)

• ID of the credit authorization created

BODY

reference

• ASCII string (40)

• Merchant Order ID to be saved within the credit authorization

BODY

date

• UTC - ISO_8601 (20)

• Auto-calculated date-time of creation

BODY

expiration_date

• UTC - ISO_8601 (20)

• Calculation based on the creation date and the expiration time configured for the Merchant

BODY

ending_date

• UTC - ISO_8601 (20)

• The date when the authorization reached the "closed" status

BODY

status

• ASCII string (20)

• Possible Values: opened, unauthorized, onhold, closed

  • opened - initial status when the customer is present or has authorized the pre-auth (we can perform as many captures as we want)

  • unauthorized - initial status when the customer is not present and has not authorized the pre-auth yet

  • onhold - will denote authorizations where capture is currently prohibited because the customer account has a status other than Normal (reason NNOR)

  • closed - final status. It is no longer a valid pre-auth

BODY

auto_capture

• boolean

• This determines if it was an actual pre-auth or a purchase (pre-auth and capture at the same time)

BODY

amount

• number (18,2)

• Authorization amount

BODY

annual_rates.description

• ASCII string

• Customer facing long-form label of this interest rate

• Merchant can choose to display either this field or the short-form label to the customer

BODY

annual_rates.rate

• number (20,7)

• Applicable interest rate presented in decimal form

• Merchant is obligated to display this rate to the customer

BODY

annual_rates.type

• ASCII string

• Customer facing short-form label of the interest rate

• Merchant can choose to display either this field or the long-form label to the customer

• Possible values: “APR”, “AIR” depending on the plan type / plan_id

BODY

annual_rates.message

• ASCII string (1000)

• Used to convey legal disclaimer necessary to notify the customer about their promotional plan

• Merchant is obligated to display this to the customer within 1-click away from the plan selection

BODY

message

• ASCII string (1000)

• Used to convey information necessary to notify the customer

BODY

username

• ASCII string (30)

• username of the creator of the auth

BODY

financing_option.transaction_type

• ASCII String (20)

• Type of transaction

• Possible values: promotional_purchase, regular_purchase

BODY

financing_option.plan_id

• number (3)

• Only applicable to Promotional Purchases

• ID of the promotional plan

BODY

financing_option.term

• number (3)

• Only applicable to Promotional Purchases

• Term of the promotional plan

BODY

fees.type

• ASCII String (20)

• Denotes if the administrative fee amount is a monthly or total amount

• Possible values:

  • admin_total

  • admin_monthly

BODY

fees.description

• ASCII string (100)

• Name, label or brief description of this fee

BODY

fees.amount

• number (18,2)

• Amount of the fees

BODY

fees.message

• ASCII string (50)

• Customer facing label of this fee

BODY

merchant_information.corporation_id

• number (10)

• Corporation ID of the creator of the authorization

BODY

merchant_information.corporation_name

• ASCII string (255)

• Corporation name of the creator of the authorization

BODY

merchant_information.merchant_id

• number (10)

• Merchant ID of the creator of the authorization

BODY

merchant_information.merchant_name

• ASCII string (130)

• Merchant name of the creator of the authorization

BODY

merchant_information.location_id

• number (10)

• Location ID of the creator of the authorization

BODY

merchant_information.location_name

• ASCII string (130)

• Location name of the creator of the authorization

BODY

customer.air

• number (5,4)

• air for the customer

BODY

customer.available_credit

• number (18,2)

• The customer’s available credit

• Calculated based on current available credit minus the authorization’s original amount plus fees plus interest according to the financing option

BODY

customer.first_name

• ASCII string (80)

• First name of the customer

BODY

customer.last_name

• ASCII string (130)

• Last name of the customer

BODY

customer.category_type

• ASCII string (30)

• Category related to the customer’s risk rating

• Possible values: preferred, premium, standard

BODY

capture.capture_id

• number (9)

• Returned if auto_capture was “true” on the request

• ID of the capture created

BODY

capture.reference

• ASCII string (40)

• Returned if auto_capture was “true” on the request

• Merchant Order ID to be saved within the capture

BODY

capture.date

• UTC - ISO_8601 Date (20)

• Returned if auto_capture was “true” on the request

• Auto-calculated Date-time of capture

BODY

capture.status

• ASCII string (20)

• Returned if auto_capture was “true” on the request

• Possible values: active, canceled, defaulted, inactive

BODY

capture.term_amount

• number (18,2)

• Returned if auto_capture was “true” on the request

• Value to explain the amount to be paid by month (or a deferred payment)

BODY

capture.amount

• number (18,2)

• Returned if auto_capture was “true” on the request

• capture amount

BODY

billing_information.first_name

• ASCII string (80)

• Billing Address Customer’s First Name passed by the Merchant on the order

BODY

billing_information.last_name

• ASCII string (130)

• Billing Address Customer’s Last Name passed by the Merchant on the order

BODY

billing_information.address_1

• ASCII string (250)

• Billing Address Line 1 passed by the Merchant on the order

BODY

billing_information.address_2

• ASCII string (100)

• Billing Address Line 2 passed by the Merchant on the order

BODY

billing_information.city

• ASCII string (100)

• Billing address city passed by the Merchant on the order

BODY

billing_information.province

• ASCII string (2)

• Billing Address Province passed by the Merchant on the order (2 character syntax, ex. ON for Ontario)

• Available values: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.

BODY

billing_information.postal_code

• ASCII string (10)

• Billing Address Postal Code passed by the Merchant on the order

BODY

shipping_information.first_name

• ASCII string (80)

• Shipping Address Customer’s First Name passed by the Merchant on the order

BODY

shipping_information.last_name

• ASCII string (130)

• Shipping Address Customer’s Last Name passed by the Merchant on the order

BODY

shipping_information.address_1

• ASCII string (250)

• Shipping Address Line 1 passed by the Merchant on the order

BODY

shipping_information.address_2

• ASCII string (100)

• Shipping Address Line 1 passed by the Merchant on the order

BODY

shipping_information.city

• ASCII string (100)

• Shipping Address City passed by the Merchant on the order

BODY

shipping_information.province

• ASCII string (2)

• Shipping Address Province passed by the Merchant on the order (2 character syntax, ex. ON for Ontario)

• Available values: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.

BODY

shipping_information.postal_code

• ASCII string (10)

• Shipping Address Postal Code passed by the Merchant on the order

BODY

account_avs.billing_information.first_name

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.billing_information.last_name

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.billing_information.address_1

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.billing_information.address_2

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.billing_information.city

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.billing_information.province

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.billing_information.postal_code

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.shipping_information.first_name

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.shipping_information.last_name

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.shipping_information.address_1

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.shipping_information.address_2

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.shipping_information.city

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.shipping_information.province

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.shipping_information.postal_code

• number (3,2)

• Matching score against the customer information Flexiti has on file

BODY

account_avs.business_billing_information.first_name

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_billing_information.last_name

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_billing_information.address_1

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_billing_information.address_2

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_billing_information.city

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_billing_information.province

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_billing_information.postal_code

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_shipping_information.first_name

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_shipping_information.last_name

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_shipping_information.address_1

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_shipping_information.address_2

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_shipping_information.city

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_shipping_information.province

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

BODY

account_avs.business_shipping_information.postal_code

• Number (3,2)

• Matching score against the business information Flexiti has on file for a Business account

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

QUERY

lang

• ASCII string (5)

• Language the message parameter on the response will be displayed in

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

• Default value: en

PATH

authorization_id

Yes

• number (16)

• This is the authorization ID to be released

BODY

reference

• ASCII String (40)

• Merchant Order ID to be saved within the release

BODY

full_release

• boolean

• If set to “true” a full release of the credit authorization will occur

• If set to “false” the amount of the release will need to be defined

• Default: false

BODY

amount

Yes if full_release is “false”

• number (18,2)

• This is the amount to be released

BODY

external_location_id

Yes if In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own location reference

BODY

external_employee_id

Yes if In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own employee reference

BODY

release_id

• number (16)

• ID of the release created

BODY

reference

• ASCII string (40)

• Merchant Order ID saved within the release

BODY

authorization_id

• number (16)

• ID of the credit authorization created

BODY

date

• UTC - ISO_8601 (20)

• Auto-calculated Date-time of release

BODY

amount

• number (18,2)

• Released amount

BODY

full_release

• boolean

• If “true” a full release of the credit authorization occured

• If “false” the amount of the release will be defined

BODY

remaining_authorization_amount

• number (18,2)

• Remaining amount of the credit authorization

BODY

username

• ASCII string (30)

• username of the employee that performed the release

BODY

message

• ASCII string (1000)

• Used to convey information to notify the customer

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

QUERY

lang

• ASCII string (5)

• Language for the message parameter on the response.

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

• Default value: en

PATH

authorization_id

Yes

• number (16)

• This is the authorization ID to be released

BODY

reference

• ASCII String (40)

• Merchant Order ID to be saved within the capture

BODY

amount

Yes

• number (18,2)

• This is the amount to be captured

BODY

sku_data.purchase_order

No

• ASCII string (10)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Purchase Number For the Merchant

BODY

sku_data.shipping_total

No

• number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• the Shipping total amount to be displayed, if applicable

BODY

sku_data.register_id

No

• ASCII string (50)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The cashier machine where the transaction was placed

BODY

sku_data.transaction_discount_total

No

• Integer (12,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Sum of all discounts on the order

BODY

sku_data.transaction_subtotal

No

• Integer (12,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Sum of all totals for all items

BODY

sku_data.gst_hst

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Goods and Services Tax (GST) and the Harmonized Sales Tax (HST)

BODY

sku_data.pst

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Provincial Sales Tax applied to the order

BODY

sku_data.transaction_total

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• transaction_total = transaction_subtotal + gst_hst + pst

BODY

sku_data.products.sku_id

No

• ASCII string (150)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Unique Identifier of the product SKU (Stock Keeping Unit)

BODY

sku_data.products.category

No

• ASCII string (30)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Category for the product

BODY

sku_data.products.description

No

• ASCII string (150)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Business-friendly description of the product

BODY

sku_data.products.quantity

No

• Number (5)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The quantity of the items for the SKU array

  • Positive integer for sales

  • Negative - integer for a return

BODY

sku_data.products.unit_price

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The price for a single SKU item

BODY

sku_data.products.extended_price

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• extended_price = [(unit_price x quantity) - discount_price] for this particular SKU array

BODY

external_location_id

Yes if In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own location reference

BODY

external_employee_id

Yes if In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own employee reference

BODY

capture_id

• number (9)

• ID of the capture created

BODY

reference

• ASCII string (40)

• Merchant Order ID saved within the capture

BODY

authorization_id

• number (16)

• ID of the credit authorization created

BODY

date

• UTC - ISO_8601 (20)

• Auto-calculated Date-time of capture

BODY

amount

• number (18,2)

• Captured amount

BODY

remaining_authorization_amount

• number (18,2)

• Remaining amount of the credit authorization after the capture

BODY

term_amount

• number (18,2)

• Value to explain the amount to be paid by month (or a deferred payment)

BODY

username

• ASCII string (30)

• username of the employee that performed the capture

BODY

status

• ASCII string (20)

• Status of the capture

• Possible values: pending, active, inactive, cancelled

  • pending - in circumstances where the capture requires accreditation

  • active - capture complete

  • inactive - when the capture has been fully returned/refunded

  • cancelled - when the capture has been rejected at accreditation time

BODY

message

• ASCII string (1000)

• Used to convey information to notify the customer

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

QUERY

lang

• ASCII string (5)

• Customer Preferred language

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

• Default value: en

PATH

authorization_id

Yes

• number (16)

• This is the authorization ID to be returned

PATH

capture_id

Yes

• number (9)

• This is the capture ID to be returned

BODY

vcc_number

No

• ASCII string(16)

• The FlexitiCard number (VCC) provided by the Customer

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

BODY

reference

• ASCII String (40)

• Merchant Order ID to be saved within the release

BODY

full_return

• boolean

• If set to “true” a full return of the credit authorization will occur

• If set to “false” the amount of the return will need to be defined

• default: false

BODY

amount

Yes if full_return is false

• number (20,2)

• This is the amount to be returned

BODY

sku_data.purchase_order

No

• ASCII string (10)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Purchase Number For the Merchant

BODY

sku_data.register_id

No

• ASCII string (50)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The cashier machine where the transaction was placed

BODY

sku_data.transaction_discount_total

No

• Integer (12,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Sum of all discounts on the order

BODY

sku_data.transaction_subtotal

No

• Integer (12,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Sum of all totals for all items

BODY

sku_data.gst_hst

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Goods and Services Tax (GST) and the Harmonized Sales Tax (HST)

BODY

sku_data.pst

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Provincial Sales Tax applied to the order

BODY

sku_data.transaction_total

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• transaction_total = transaction_subtotal + gst_hst + pst

BODY

sku_data.products.sku_id

No

• ASCII string (150)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Unique Identifier of the product SKU (Stock Keeping Unit)

BODY

sku_data.products.category

No

• ASCII string (30)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Category for the product

BODY

sku_data.products.description

No

• ASCII string (150)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Business-friendly description of the product

BODY

sku_data.products.quantity

No

• Number (5)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The quantity of the items for the SKU array

  • Positive integer for sales

  • Negative - integer for a return

BODY

sku_data.products.unit_price

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The price for a single SKU item

BODY

sku_data.products.extended_price

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• extended_price = [(unit_price x quantity) - discount_price] for this particular SKU array

BODY

external_location_id

Yes if In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own location reference

BODY

external_employee_id

Yes if In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own employee reference

BODY

return_id

• number (16)

• ID of the return created

BODY

reference

• ASCII string (40)

• Merchant Order ID saved within the capture

BODY

capture_id

• number (9)

• ID of the capture returned

BODY

date

• UTC - ISO_8601 (20)

• Auto-calculated Date-time of capture

BODY

amount

• number (18,2)

• Returned amount

BODY

remaining_capture_amount

• number (18,2)

• Remaining capture amount after the return

BODY

remaining_authorization_amount

• number (18,2)

• Remaining amount of the credit authorization

BODY

username

• ASCII string (30)

• username of the employee that performed the release

BODY

message

• ASCII string (1000)

• Used to convey information to notify the customer

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)

• Flexiti Account Number retrieved from the /client-id/{client_id}/customers/lookup or the /client-id/{client_id}/customers/search endpoints

• This is NOT the VCC (Flexiti Card) or the Customer ID

BODY

capture_id

No

• Number (9)

• Capture ID for the capture that is being refunded

• This is necessary to associate SKU data to the refund

BODY

vcc_number

No

• ASCII string(16)

• The FlexitiCard number (VCC) provided by the Customer

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

BODY

amount

Yes

• number (20,2)

• This is the amount to be refunded

BODY

reference

• ASCII string (40)

• Merchant Order ID to be saved within the refund

BODY

sku_data.purchase_order

No

• ASCII string (10)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Purchase Number For the Merchant

BODY

sku_data.register_id

No

• ASCII string (50)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The cashier machine where the transaction was placed

BODY

sku_data.transaction_discount_total

No

• Integer (12,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Sum of all discounts on the order

BODY

sku_data.transaction_subtotal

No

• Integer (12,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Sum of all totals for all items

BODY

sku_data.gst_hst

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Goods and Services Tax (GST) and the Harmonized Sales Tax (HST)

BODY

sku_data.pst

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Provincial Sales Tax applied to the order

BODY

sku_data.transaction_total

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• transaction_total = transaction_subtotal + gst_hst + pst

BODY

sku_data.products.sku_id

No

• ASCII string (150)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Unique Identifier of the product SKU (Stock Keeping Unit)

BODY

sku_data.products.category

No

• ASCII string (30)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Category for the product

BODY

sku_data.products.description

No

• ASCII string (150)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• Business-friendly description of the product

BODY

sku_data.products.quantity

No

• Number (5)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The quantity of the items for the SKU array

  • Positive integer for sales

  • Negative - integer for a return

BODY

sku_data.products.unit_price

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• The price for a single SKU item

BODY

sku_data.products.extended_price

No

• Number (18,2)

• This data is provided by a Merchant. If passed as part of the request, it will be displayed on the customer’s statement. We do not validate this data and assume you are passing an accurate representation of the transactions details.

• extended_price = [(unit_price x quantity) - discount_price] for this particular SKU array

BODY

external_location_id

Yes if In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own location reference

BODY

external_employee_id

Yes if In-store channel

• ASCII string (100)

• Used in the In-store channel

• This is the merchant’s own employee reference

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

QUERY

lang

• ASCII string (5)

• Customer Preferred language

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

• Default value: en

QUERY

account_number

• number (14)

• Flexiti Account Number retrieved from the /client-id/{client_id}/customers/lookup or the /client-id/{client_id}/customers/search endpoints

• This is not the FlexitiCard number (VCC) or the Customer ID

QUERY

transaction_type

• ASCII String (20)

• Type of transaction

• Available values: promotional_purchase, regular_purchase

• default: all authorizations will be retrieved

• Supports multiple authorization statuses separated by comma

QUERY

authorization_status

• ASCII String (20)

• Supports multiple authorization statuses separated by comma

• default: all authorizations will be retrieved

• Possible Values: opened, unauthorized, onhold, closed

  • opened - initial status when the customer is present or has authorized the pre-auth (we can perform as many captures as we want)

  • unauthorized - initial status when the customer is not present and has not authorized the pre-auth yet

  • onhold - will denote authorizations where capture is currently prohibited because the customer account has a status other than Normal (reason NNOR)

  • closed - final status. It is no longer a valid pre-auth

QUERY

creation_date_from

• UTC - ISO_8601 (20)

• Available formats:

  • 2018-12-23 (If used, we will add UTC time 00:00:00).

  • 2018-09-09T01:01:01Z (Full UTC format)

• From value for date range query

• default: today - 1 month

QUERY

creation_date_to

• UTC - ISO_8601 (20)

• Available formats:

  • 2018-12-23 (If used, we will add UTC time 00:00:00).

  • 2018-09-09T01:01:01Z (Full UTC format)

• To value for date range query

• default: today

QUERY

page_number

Yes

• numeric

• number of the page to be returned

QUERY

page_size

• numeric

• number of results to be returned on each page

• Default: 10

BODY

count

• number (20)

• The total number of pages that the full response will take

BODY

page_number

• number (20)

• number of the page returned

BODY

page_size

• number (20)

• number of results returned on each page

BODY

next_page_url

• ASCII string (200)

• URL for next page of results

BODY

previous_page_url

• ASCII string (200)

• URL for previous page of results

BODY

authorizations.authorization_id

• number (16)

• ID of the credit authorization created

BODY

authorizations.reference

• ASCII string (40)

• Merchant Order ID to be saved within the credit authorization

BODY

authorizations.date

• UTC - ISO_8601 (20)

• Auto-calculated date-time of creation

BODY

authorizations.expiration_date

• UTC - ISO_8601 (20)

• Calculation based on the creation date and the expiration time configured for the Merchant

BODY

authorizations.ending_date

• UTC - ISO_8601 (20)

• The date when the authorization reached the "closed" status

BODY

authorizations.status

• ASCII string (20)

• Possible Values: opened, unauthorized, onhold, closed

  • opened - initial status when the customer is present or has authorized the pre-auth (we can perform as many captures as we want)

  • unauthorized - initial status when the customer is not present and has not authorized the pre-auth yet

  • onhold - will denote authorizations where capture is currently prohibited because the customer account has a status other than Normal (reason NNOR)

  • closed - final status. It is no longer a valid pre-auth

BODY

authorizations.auto_capture

• boolean

• This determines if it was an actual pre-auth or a purchase (pre-auth and capture at the same time)

BODY

authorizations.amount

• number (18,2)

• Authorization amount

BODY

authorizations.annual_rates.description

• ASCII string

• Customer facing long-form label of this interest rate

• Merchant can choose to display either this field or the short-form label to the customer

BODY

authorizations.annual_rates.rate

• number (5, 4)

• Applicable interest rate presented in decimal form

• Merchant is obligated to display this rate to the customer

BODY

authorizations.annual_rates.type

• ASCII string

• Customer facing short-form label of the interest rate

• Merchant can choose to display either this field or the long-form label to the customer

• Possible values: “APR”, “AIR” depending on the plan type / plan_id

BODY

authorizations.annual_rates.message

• ASCII string (1000)

• Used to convey legal disclaimer necessary to notify the customer about their promotional plan

• Merchant is obligated to display this to the customer within 1-click away from the plan selection

BODY

authorizations.remaining_amount

• number (18,2)

• Calculated as original_amount + captured_amount - returned_amount - released_amount

BODY

authorizations.returned_amount

• number (18,2)

• Sum of returned amounts

BODY

authorizations.captured_amount

• number (18,2)

• Sum of captured amounts

BODY

authorizations.released_amount

• number (18,2)

• Sum of released amounts

BODY

authorizations.username

• ASCII string (30)

• username of the creator of the auth

BODY

authorizations.financing_option.transaction_type

• ASCII String (20)

• Type of transaction

• Possible values: promotional_purchase, regular_purchase

BODY

authorizations.financing_option.plan_id

• number (3)

• Only applicable to Promotional Purchases

• ID of the promotional plan

BODY

authorizations.financing_option.term

• number (3)

• Only applicable to Promotional Purchases

• Term of the promotional plan

BODY

authorizations.fees.type

• ASCII String (20)

• Denotes if the administrative fee amount is a monthly or total amount

• Possible values:

  • admin_total

  • admin_monthly

BODY

authorizations.fees.description

• ASCII string (100)

• Name, label or brief description of this fee

BODY

authorizations.fees.amount

• number (10,2)

• Amount of the fees

BODY

authorizations.merchant_information.corporation_id

• number (10)

• Corporation ID of the creator of the authorization

BODY

authorizations.merchant_information.corporation_name

• ASCII string (255)

• Corporation name of the creator of the authorization

BODY

authorizations.merchant_information.merchant_id

• number (10)

• Merchant ID of the creator of the authorization

BODY

authorizations.merchant_information.merchant_name

• ASCII string (130)

• Merchant name of the creator of the authorization

BODY

authorizations.merchant_information.location_id

• number (10)

• Location ID of the creator of the authorization

BODY

authorizations.merchant_information.location_name

• ASCII string (130)

• Location name of the creator of the authorization

BODY

authorizations.customer.air

• number (5,4)

• air for the customer

BODY

authorizations.customer.first_name

• ASCII string (80)

• First name of the customer

BODY

authorizations.customer.last_name

• ASCII string (130)

• Last name of the customer

BODY

authorizations.customer.category_type

• ASCII string (30)

• Category related to the customer’s risk rating

• Possible values: preferred, premium, standard

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

authorization_id

Yes

• number (16)

• This is the authorization ID to be retrieved

QUERY

lang

Yes

• ASCII string (5)

• Customer Preferred language

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

• Default value: en

BODY

authorization_id

• number (16)

• ID of the credit authorization created

BODY

reference

• ASCII string (40)

• Merchant Order ID to be saved within the credit authorization

BODY

date

• UTC - ISO_8601 (20)

• Auto-calculated date-time of creation

BODY

expiration_date

• UTC - ISO_8601 (20)

• Calculation based on the creation date and the expiration time configured for the Merchant

BODY

ending_date

• UTC - ISO_8601 (20)

• The date when the authorization reached the "closed" status

BODY

status

• ASCII string (20)

• Possible Values: opened, unauthorized, onhold, closed

  • opened - initial status when the customer is present or has authorized the pre-auth (we can perform as many captures as we want)

  • unauthorized - initial status when the customer is not present and has not authorized the pre-auth yet

  • onhold - will denote authorizations where capture is currently prohibited because the customer account has a status other than Normal (reason NNOR)

  • closed - final status. It is no longer a valid pre-auth

BODY

auto_capture

• boolean

• This determines if it was an actual pre-auth or a purchase (pre-auth and capture at the same time)

BODY

amount

• number (18,2)

• Authorization amount

BODY

annual_rates.description

• ASCII string

• Customer facing long-form label of this interest rate

• Merchant can choose to display either this field or the short-form label to the customer

BODY

annual_rates.rate

• number (5, 4)

• Applicable interest rate presented in decimal form

• Merchant is obligated to display this rate to the customer

BODY

annual_rates.type

• ASCII string

• Customer facing short-form label of the interest rate

• Merchant can choose to display either this field or the long-form label to the customer

• Possible values: “APR”, “AIR” depending on the plan type / plan_id

BODY

annual_rates.message

• ASCII string (1000)

• Used to convey legal disclaimer necessary to notify the customer about their promotional plan

• Merchant is obligated to display this to the customer within 1-click away from the plan selection

BODY

remaining_amount

• number (18,2)

• Calculated as original_amount + captured_amount - returned_amount - released_amount

BODY

returned_amount

• number (18,2)

• Sum of returned amounts

BODY

captured_amount

• number (18,2)

• Sum of captured amounts

BODY

released_amount

• number (18,2)

• Sum of released amounts

BODY

username

• ASCII string (30)

• username of the creator of the auth

BODY

financing_option.transaction_type

• ASCII String (20)

• Type of transaction

• Possible values: promotional_purchase, regular_purchase

BODY

financing_option.plan_id

• number (3)

• Only applicable to Promotional Purchases

• ID of the promotional plan

BODY

financing_option.term

• number (3)

• Only applicable to Promotional Purchases

• Term of the promotional plan

BODY

fees.type

• ASCII String (20)

• Denotes if the administrative fee amount is a monthly or total amount

• Possible values:

  • admin_total

  • admin_monthly

BODY

fees.description

• ASCII string (100)

• Name, label or brief description of this fee

BODY

fees.amount

• number (20,2)

• Amount of the fees

BODY

merchant_information.corporation_id

• number (10)

• Corporation ID of the creator of the authorization

BODY

merchant_information.corporation_name

• ASCII string (255)

• Corporation name of the creator of the authorization

BODY

merchant_information.merchant_id

• number (10)

• Merchant ID of the creator of the authorization

BODY

merchant_information.merchant_name

• ASCII string (130)

• Merchant name of the creator of the authorization

BODY

merchant_information.location_id

• number (10)

• Location ID of the creator of the authorization

BODY

merchant_information.location_name

• ASCII string (130)

• Location name of the creator of the authorization

BODY

customer.air

• number (5,4)

• air for the customer

BODY

customer.available_credit

• number (18,2)

• The customer’s available credit

• Calculated based on current available credit minus the authorization’s original amount plus fees plus interest according to the financing option

BODY

customer.first_name

• ASCII string (80)

• First name of the customer

BODY

customer.last_name

• ASCII string (130)

• Last name of the customer

BODY

customer.category_type

• ASCII string (30)

• Category related to the customer’s risk rating

• Possible values: preferred, premium, standard

BODY

captures.capture_id

• number (9)

• ID of the capture created

BODY

captures.reference

• ASCII string (40)

• Merchant Order ID saved with the capture

BODY

captures.date

• UTC - ISO_8601 (20)

• The date of the capture

BODY

captures.status

• ASCII string (20)

• Status of the capture

• Possible values: active, canceled, defaulted, inactive

BODY

captures.username

• ASCII string (30)

• username of the employee that performed the capture

BODY

captures.term_amount

• number (18,2)

• Value to explain the amount to be paid by month (or a deferred payment)

BODY

captures.amount

• number (18,2)

• Amount of the capture

BODY

returns.return_id

• number (16)

• ID of the return created

BODY

returns.reference

• ASCII string (40)

• Merchant Order ID saved with the return

BODY

returns.date

• UTC - ISO_8601 (20)

• The date of the return

BODY

returns.username

• ASCII string (30)

• username of the employee that performed the return

BODY

returns.amount

• number (18,2)

• Amount of the return

BODY

releases.release_id

• number (16)

• ID of the release created

BODY

releases.reference

• ASCII string (40)

• Merchant Order ID saved with the release

BODY

releases.date

• UTC - ISO_8601 (20)

• The date of the release

BODY

releases.username

• ASCII string (30)

• username of the employee that performed the release

BODY

releases.amount

• number (18,2)

• Amount of the release

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

QUERY

lang

• ASCII string (5)

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

• Default value: en

QUERY

account_number

• number (14)

• Flexiti Account Number retrieved from the /client-id/{client_id}/customers/lookup or the /client-id/{client_id}/customers/search endpoints

• This is not the FlexitiCard number (VCC) or the Customer ID

QUERY

transaction_type

• ASCII String (20)

• Type of transaction

• Available values: promotional_purchase, regular_purchase

• Default: all authorizations will be retrieved.

• Supports multiple authorization statuses separated by comma.

QUERY

capture_status

• ASCII String (20)

• Available values: active, canceled, defaulted, inactive

• Default: all authorizations will be retrieved.

• Supports multiple authorization statuses separated by comma.

QUERY

creation_date_from

• UTC - ISO_8601 (20)

• Available formats:

  • 2018-12-23 (If used, we will add UTC time 00:00:00).

  • 2018-09-09T01:01:01Z (Full UTC format)

• From value for date range query

• default: today - 1 month

QUERY

creation_date_to

• UTC - ISO_8601 (20)

• Available formats:

  • 2018-12-23 (If used, we will add UTC time 00:00:00).

  • 2018-09-09T01:01:01Z (Full UTC format)

• To value for date range query

• Default: today

QUERY

capture_id

• number (9)

• ID of the capture to be retrieved

QUERY

authorization_corporation_id

• number (10)

• Corporation ID of the creator of the authorization

QUERY

authorization_merchant_id

• number (10)

• Merchant ID of the creator of the authorization

QUERY

authorization_location_id

• number (10)

• Location ID of the creator of the authorization

QUERY

authorization_employee_username

• ASCII string (30)

• Merchant name of the creator of the authorization

QUERY

capture_employee_username

• ASCII string (30)

• Merchant name of the creator of the capture

QUERY

page_number

Yes

• number (3)

• number of page we are returning

QUERY

page_size

• number (3)

• Number of results to be returned on each page

• Default: 10