API Changelog & Release Schedule

Owned by PC (Unlicensed)
Last updated: Jan 05, 2023 by Arthur Zhao
19 min read

FUTURE Releases

These target delivery dates are subject to change. Any changes to release dates and deliverables will be updated here.

PRODUCTION RELEASE DATE

CHANGE DETAILS

PRODUCTION RELEASE DATE

CHANGE DETAILS

Release

 Functionality to be available in MERCHANT INTEGRATION environment as of

 

 

Release 22.9.0

 

Production Date: 2022.08.25

Added plan_name field to V2.5.1 /calculate-interest endpoint to make the field accessible through a single API endpoint.

Release 22.4.0

 Functionality to be available in MERCHANT INTEGRATION environment as of 2022.02.16

Production Date: 2021.04.13

Added version V2.5.1 to endpoints:

  • POST /calculate-interest

  • POST /authorization

  • GET /authorization

  • GET /authorizations

  • GET /captures

annual_fee description + messaging are reformatted to provide legal information in a cleaner way.

Release 22.2.0

 Functionality to be available in MERCHANT INTEGRATION environment as of 2022.02.16

Production Date: 2021.02.02

Removed documentations around POS API Application flows. Documentations around the POS API Apply flow for both instore & online channels can be made available upon request.

The recommended Online Application flow is now done using the Flexiti Online API (A separate API from POS API Online), and the documentation/installation instructions can be located here: https://flexiti.atlassian.net/wiki/spaces/FDP/pages/2158231585

Release 21.10.0

 Functionality to be available in MERCHANT INTEGRATION environment as of 2021.09.22

Production Date: 2021.09.22

  • The calculate-interest endpoint and authorization endpoint will have new versions (v2.5.1) published, and the older version (v2.5) will be deprecated.

For calculate-interest endpoint, the promotional_purchase.terms.apr field will be replaced with promotional_purchase.terms.annual_rates, which has 3 sub-levels as shown below:

For authorization endpoint, the apr field will be replaced with annual_rates, which has 3 sub-levels as shown below:

New URI: https://{posapi_url}/flexiti/pos-api/v2.5.1/client-id/{client_id}/authorization

 

Release 21.9.0

 Functionality to be available in MERCHANT INTEGRATION environment as of 2021.08.23

Production Date: 2021.08.18

  • For Successful verification scenarios using the Flexiti Widget in the Purchase Flow, the eventData JSON Object will now contain 2 additional fields, customerId and accountType, see below:

 

Release 21.8.0

 Functionality to be available in MERCHANT INTEGRATION environment as of 2021.07.26

Production Date: 2021.07.21

New Copy Text Changes are published for successful consumer-type account applications to differentiate between a Non-Prime and a Prime (Prime includes Premium and Preferred sub-categories) type customers.

 

ROC Non-Prime Copy Changes:

ROC Prime, Preferred Copy Changes:

ROC Prime, Premium Copy Changes:

QC Prime, Preferred Copy Changes:

QC Prime, Premium Copy Changes:

 

PAST 2021 Releases

Functionality available in TRAINING & PRODUCTION environments

PRODUCTION RELEASE DATE

CHANGE DETAILS

PRODUCTION RELEASE DATE

CHANGE DETAILS

Release 21.4

 Functionality to be available in MERCHANT INTEGRATION environment as of 2021.03.22

Production Date: 2021.03.31

  • Adding regular_purchase_bypass to response of the POST /client-id/{client_id}/accounts/{account_number}/calculate-interest endpoint

    • This will allow you to bypass authenticating the user on a regular revolve purchase if customer’s checkout amount is ≤ $200 and the number of purchases on that account in last 24 hours ≤ 3

    • This is only valid for in-store purchases, online purchases will always require a PIN

  • Adding a regular_purchase_bypass as a format for the POST /client-id/{client_id}/account/{account_number}/verify endpoint

    • This format will generate a pin on the response to be used on a regular revolve purchase if customer’s checkout amount is ≤ $200 and the number of purchases on that account in last 24 hours ≤ 3

    • Eligibility can be determined using the POST /client-id/{client_id}/accounts/{account_number}/calculate-interest endpoint

Example Request:

{ "account_number": 20035156, "vcc_number": "1234567890101213", format": "regular_purchase_bypass", "request_id": "12345678901234567890" }

Example Response:

{ "verification_code": 2485 }

  • Adding SKU level request paramters to the following endpoints:

    • POST /client-id/{client-id}/authorization

    • POST /client-id/{clientId}/authorization/{authorizationId}/capture

    • POST /client-id/{client_id}/accounts/{account_number}/refund

    • POST /client-id/{clientId}/authorization/{authorizationId}/capture/{captureId}/return

Example Request - /authorization

{ "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 } ] }

  • Adding additional Address Verification Values for business accounts on the POST /client-id/{client-id}/authorization response

Sample Response:

  • Adding account_type as a non-mandatory parameter to the POST /client-id/{clientId}/widget/init endpoint

    • This will be used to identify multiple-account scenarios for closed and open loop business cards

    • Default value will be “consumer”

  • Adding capture_id as a non-mandatory request parameter to the POST /client-id/{client_id}/accounts/{account_number}/refund

    • This will be necessary to associate SKU data to the refund

 

Release 21.3

 Functionality to be available in MERCHANT INTEGRATION environment as of 2021.02.22

Production Date: 2021.03.03

  • Adding vcc_number parameter to the request for the following endpoints:

    • POST /client-id/{clientId}/authorization/{authorizationId}/capture/{captureId}/return

    • POST /client-id/{client_id}/accounts/{account_number}/refund

  • This is non-mandatory and is only used for Authorized Users of Business Accounts

  • We will be adding a new error to these endpoints to support this request parameter:

  • Adding vcc_number as a possible request parameter for the POST /client-id/{client_id}/account/{account_number}/verify endpoint

  • This can be used to identify Business account Authorized users

Sample Request:

  • Modification to the GET /client-id/{client_id}/customers/lookup and POST /client-id/{clientId}/widget/init endpoints to return the masked email and phone number for Authorized users of business accounts when the request parameter is a VCC.

Release 21.2

 Functionality to be available in MERCHANT INTEGRATION environment as of 2021.01.25

Production Date: 2021.02.03

  • Adding the account_type parameter to the response on the GET /client-id/{client_id}/customers/search endpoint

Sample Response:

  • Adding the account_type parameter to the response on the GET /client-id/{client_id}/customers/lookup endpoint

Sample Response:

  • Adding the account_type parameter to the response on the POST /client-id/{client_id}/accounts/{account_number}/calculate-interest endpoint

Sample Response

  • Add housing_type parameter to the POST /client-id/{client_id}/i18n endpoint

Sample array - English

Sample array - French

  • Adding vcc_number as a request parameter on the POST /client-id/{client-id}/authorization endpoint

  • This is non-mandatory and is only used for Authorized Users of Business accounts

  • We will be adding a new error to this endpoint to support this request:

Sample Request:

  • Adding vcc_number as a request parameter on the POST /client-id/{client_id}/transactions endpoint

  • This is non-mandatory and is only used for Authorized Users of Business Accounts

Sample Request

Release 21.1

 

Production Date: 2021.01.13

  • The GET /client-id/{client_id}/i18n endpoint will accept “customer” scope tokens

  • Adding a new error to the POST /client-id/{client_id}/apply endpoint to support Business Accounts

  • Adding a validation for the account_type parameter