Praxis Wiki logo
Praxis Wiki
Version:
latest (API 1.3)
  • 3.3 (API 1.1)
  • 3.4 (API 1.2)
  • latest (API 1.3)

    • Overview

    Intro

    This document contains all the information you need to know when migrating from previous API versions to the current API version. Since the APIs are periodically upgraded, we recommend that you follow a routine schedule when upgrading to the latest API version.

    What is happening now? Praxis has set a deprecation/discontinuation schedule that will gradually stop servicing the following API versions: v1.2, v1.1, v0.24

    Deprecation Schedule:

    • As of today, new integrations will only be allowed with API v1.3;
    • 1st of May 2022 the aforementioned legacy API's will no longer be maintained & supported;
    • Last due date for migration from 0.24, 1.1, 1.2 to 1.3 is 30.06.2022 when the previous version APIs will be blocked and praxis will no longer accept requests with that version.

    Discontinuation date: June, 30th 2022.

    What does it mean

    {danger.fa-exclamation-triangle} The deprecation announcement means we will be putting earlier versions of the API on a deprecation schedule that will end in discontinuation of those older APIs. while on deprecation period, the earlier APIs will be maintained but will no longer receive the new features and performance updates (excluding critical security updates), the online documentation will be moved to archive and will not be maintained further.

    {danger.fa-exclamation-triangle} When the earlier API versions reach the discontinuation date, any CRM that is identified in Praxis by the API version prior to v1.3, will be treated as inactive. An inactive CRM cannot send requests to Praxis Cashier API or receive the notifications back. 

    Steps To Migrate

    All merchants that are currently running an integration with API prior to v1.3 will receive an email notifying about the deprecation schedule. Further, it is needed to plan their migration to the new API, which involves the following high level process:

    1) Merchant/CRM provider reviews the migration manual, namely the 'What's new in API v1.3' document and comparison document relevant for their scenario (1.1 or 1.2), and decides on the preferred routes in order to achieve their targets.

    2) Merchant notifies Praxis regarding the chosen Integration type (Cashier API or Direct API), required flows (Deposit, Withdrawals/Payout), and overall coordinate key objectives for the integration and requests Test API credentials. 

    3) Development Stage: Integration process starts by the Merchant/CRM provider. Any questions are resolved by the already established channels of communication. Once the development is completed, the merchant notifies Praxis Support and coordinates the acceptance process.

    4) Testing/ Acceptance step: Praxis Support Team performs acceptance testing and informs the Merchant regarding the results. In some cases, working with the merchant or CRM provider may be required to complete testing.

    5) At this point, Praxis support and Merchant agree on a date to make the switch which is then carried out according to the plan.


    Preparation for migration to API v1.3

    In order to migrate to API v 1.3, please make sure to review the following:

    {danger.fa-exclamation-triangle} API Version 1.3 contains changes to object structures, signature and API endpoints. in addition, it also includes new functionality that was not available in the earlier versions of the API. Merchants have a choice to migrate only the existing functionality, or to take advantage of the new one. Please read through What's new section to assess which features you want to take advantage of during your migration.

    What's new in API v 1.3: main changes

    It's important that you identify the relevant functionality that needs to be implemented and prepare to map between existing flows and new ones supported by the new API version.

    Main integration options in API v1.3
    1. Cashier API which can be used as Cashier Flow or Terminal Flow.

    2. Direct API which have a few main use cases:

    • card for using your own payment page (Requires PCI compliance);
    • apm to call an APM solution in a S2S flow.

    If you are migrating from API v1.1

    Here you can find the corresponding methods between what is used now and how it is composed in the new API v1.3:

    Cashier Flow

    Terminal Flow

    To help you understand the differences we have prepared a comparison of both versions so that you can identify what needs to be adjusted for the new version:

    Compare: if you are migrating from v1.1 to v1.3

    If you are migrating from API v1.2

    Here you can find the corresponding methods between what is used now and how it is composed in the new API v1.3:

    Cashier Flow

    Terminal Flow

    To help you understand the differences we have prepared a comparison of both versions so that you can identify what needs to be adjusted for the new version:

    Compare: if you are migrating from v1.2 to v1.3

    Direct API 

    {danger.fa-exclamation-triangle} In order to use the Direct API with full credit card details, the merchant has to comply with PCI DSS and confirm their compliance level by providing the up-to-date AOC (Attestation of Compliance) document or SAQ-D with external vulnerability scan report.

    Terminology

    Merchant: a party selling goods or services to customers via an eCommerce website. We provide the best integration solution for a merchant to accept payments.

    Customer: someone who buys goods or services from a merchant. Cardholder: a person who uses a card issued by a bank to pay for goods and services on a merchant’s website.

    Transaction: when a customer pays money to a merchant a transaction is created.

    Environment: two environments are provided from our side: a sandbox in which one will be able to test all possible test scenarios and a live environment that is used for live customers. Note: different API keys are used for both environments. Once the environment is authenticated, please send a request to customer support to get an API key.


    Still have questions? Please contact us via email to [email protected].

    2022 © PRAXIS CASHIER