These endpoints are other (previous) versions of the existing Flexiti POS API, that are still active and supported, but no longer recommended for new implementations.
| Table of Contents |
|---|
...
POST /client-id/{client_id}/accounts/{account_number}/
...
close
| Code Block | ||
|---|---|---|
| ||
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/{client_id}/accounts/12345/calculate-interest |
Deprecated as of Release R21.10.0, September 22nd, 2021.
This endpoint retrieves the plan and term configured for the merchant that can be offered to a customer.
Request Parameters:
...
Type
...
Parameter
...
Required
...
Details
...
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 Primary 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
Example Request:
| Code Block |
|---|
{
"amount": 234.45
} |
Response Parameters:
...
Type
...
Parameter
...
Details
...
BODY
...
account_number
...
number (14)
The Account Number of the Primary Account Holder
This is not the VCC (Flexiti Card)
...
BODY
...
account_type
...
ASCII string (100)
This is the type of account: 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.verify
...
boolean
Indicate if a customer can use regular_purchase_bypass as a format on the POST /client-id/{client_id}/account/{account_number}/verify endpoint for a regular revolve purchase.
This value will be true if:
the account_number being passed has made ≤ 3 regular purchases in the past 24HS; and,
the amount on the request is ≤ $200
...
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
Success Response - ROC Customer:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"account_number": 11223344,
"account_type:" "consumer",
"amount": 250,
"customer": {
"air": 0.289,
"available_credit": 8000,
"first_name": "John",
"last_name": "Smith",
"category_type": "preferred"
},
"regular_purchase": {
"term_amount": 250,
"air": 0.289,
"fees": []
},
"promotional_purchase": [
{
"plan_id": 4,
"terms": [
{
"term": 3,
"term_amount": 20.33,
"apr": 0.0999,
"fees": [
{
"description": "Administrative fees:",
"amount": 49.99,
"type": "admin_total",
"message": "Although your administrative fee may be represented as a monthly or annual amount, the fee is due in full if the account is paid off early. See terms and conditions for full details."
}
]
}
]
},
{
"plan_id": 5,
"terms": [
{
"term": 6,
"term_amount": 4.67,
"apr": 0,
"fees": [
{
"description": "Administrative fees:",
"amount": 3,
"type": "admin_monthly",
"message": "Although your administrative fee may be represented as a monthly or annual amount, the fee is due in full if the account is paid off early. See terms and conditions for full details."
}
]
},
{
"term": 12,
"term_amount": 3.83,
"apr": 0,
"fees": [
{
"description": "Administrative fees:",
"amount": 3,
"type": "admin_monthly",
"message": "Although your administrative fee may be represented as a monthly or annual amount, the fee is due in full if the account is paid off early. See terms and conditions for full details."
}
]
}
]
}
]
} |
Success Response - Quebec Customer
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"account_number": 11223344,
"amount": 250,
"customer": {
"air": 0.3124,
"available_credit": 1700,
"first_name": "Jacques",
"last_name": "Smith",
"category_type": "premium"
},
"regular_purchase": {
"term_amount": 250,
"air": 0.3124,
"fees": []
},
"promotional_purchase": [
{
"plan_id": 5,
"terms": [
{
"term": 6,
"term_amount": 41.67,
"apr": 0,
"fees": []
},
{
"term": 12,
"term_amount": 20.83,
"apr": 0,
"fees": []
}
]
},
{
"plan_id": 9,
"terms": [
{
"term": 6,
"term_amount": 250,
"apr": 0.35,
"fees": []
},
{
"term": 12,
"term_amount": 250,
"apr": 0.35,
"fees": []
}
]
}
]
} |
POST /client-id/{client-id}/authorization
| Code Block |
|---|
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/{client_id}/authorization |
Deprecated as of Release R21.10.0, September 22nd, 2021.
This endpoint to creates a credit authorization for a customer from a specific Merchant.
Credit authorizations could be for:
promotional purchases
regular purchase
close |
This endpoint allows the closure of a QC account.
Request Parameters:
BODY
Type | Parameter | Required | Details |
|---|---|---|---|
HEADER | authorization | Yes |
|
HEADER | x-reference-id | Yes |
|
PATH | client_id | Yes |
|
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
PATH | account_number | Yes |
|
This is not the FlexitiCard number (VCC) or the Customer ID
BODY
vcc_number
ASCII string(16)
|
This is the FlexitiCard number (VCC)
|
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
number (3)
Only applicable to Promotional Purchases
Term
BODY
amount
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.
|
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
|
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.
BODY
external_location_id
Yes for In-store channel
ASCII string (100)
|
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
Example Request - Auto Capture with SKU items:
| Code Block | ||
|---|---|---|
| ||
{
"vcc_number": "1234567890123456",
"account_number": 1234567,
"reference": "orderid-12345",
"widget_session_id": "12345678901234567890", //if Online channel
"request_id": "12345678901234567890", //if in-store channel
"external_location_id" : "00-12345", //if in-store channel
"external_employee_id" :"12345-SMITH" //if in-store channel
"financing_option": {
"transaction_type": "promotional_purchase",
"plan_id": 5,
"term": 6
},
"amount": 5000.12,
"auto_capture": true,
"verification_code": 9999,
"billing_information": {
"first_name": "John",
"last_name": "Smith",
"address_1": "1234 Main Street",
"address_2": "",
"city": "Toronto",
"postal_code": "M1M1M1",
"country": "CA",
"province": "ON"
},
"shipping_information": {
"first_name": "John",
"last_name": "Smith",
"address_1": "1234 Main Street",
"address_2": "",
"city": "Toronto",
"postal_code": "M1M1M1",
"country": "CA",
"province": "ON"
},
"sku_data":{
{
"purchase_order": "100001234",
"register_id": "1A45",
"transaction_discount_total": -125.08,
"transaction_subtotal": 821.17,
"transaction_total": 1026.47,
"gst_hst": 133.45,
"pst": 71.85,
"products":[
{
"sku_id": "100xx4567",
"category": "electronics",
"description": "Apple Macbook 16-inch",
"quantity": 1,
"unit_price": 1000,
"extended_price": 984.35
},
{
"sku_id": "20bb3457",
"category": "office supplies",
"description": "24lb Multiuse Paper, White",
"quantity": 1,
"unit_price": 33.99,
"extended_price": 42.12
}
]
} |
Response Parameters:
Type
Parameter
Details
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
apr
number (5,4)
It will be a coefficient
This applies when the credit authorization is for a promotional purchase.
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)
|
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
|
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
|
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
Success Response - ROC Consumer Account:
...
| language | json |
|---|
...
|
...
Success Response
...
| Code Block | ||
|---|---|---|
| ||
{
"authorization_id": 12345768,
"reference": "orderid-12345",
"date": "2019-07-20T00:39:57Z",
"expiration_date": "2019-07-20T00:39:57Z",
"ending_date": null,
"status": "closed",
"auto_capture": true,
"amount": 123.12,
"apr": 0.1999,
"message": "lorem ipsum",
"username": "jjones",
"financing_option": {
"transaction_type": "promotional_purchase",
"plan_id": 5,
"term": 6
},
"fees": [],
"merchant_information": {
"corporation_id": 1234,
"corporation_name": "ACME Corporation",
"merchant_id": 10028,
"merchant_name": "ACME Jewellers",
"location_id": 1328,
"location_name": "ACME Jewellers 123"
},
"customer": {
"air": 0.3724,
"available_credit": 2000.12,
"first_name": "Jaques",
"last_name": "Smith",
"category_type": "preferred"
},
"capture": {
"capture_id": 1234112,
"reference": "orderid-12345",
"date": "2019-07-20T00:39:57Z",
"status": "pending",
"term_amount": 123,
"amount": 123.12
},
"billing_information": {
"first_name": "Jaques",
"last_name": "Smith",
"address_1": "1234 Main Street",
"address_2": "",
"city": "Montreal",
"postal_code": "H1H1A1",
"province": "QC"
},
"shipping_information": {
"first_name": "Jaques",
"last_name": "Doe",
"address_1": "800 Main Ave",
"address_2": "",
"city": "Toronto",
"postal_code": "H1H1A1",
"province": "QC"
},
"account_avs": {
"shipping_information": {
"first_name": 1,
"last_name": 0,
"address_1": 0.54,
"address_2": 0,
"city": 0,
"postal_code": 1,
"province": 1
},
"billing_information": {
"first_name": 1,
"last_name": 1,
"address_1": 1,
"address_2": 0,
"city": 1,
"postal_code": 1,
"province": 1
}
}
} |
Success - ROC Business Account
...
:
200 - Success
| Code Block |
|---|
{
} |