Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Flexiti’s API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes that indicate errors in simple language.

Environments

Developers have access to three different environments: TRAINING, MERCHANT INTEGRATION, and PRODUCTION.

All API requests exist in TRAINING, MERCHANT INTEGRATION, and PRODUCTION environments. All objects - customers, plans, transactions, etc. created in one environment do not exist in the others.

Our TRAINING environment:

  • For most implementations, our Training environment will be all you need to launch your project with Flexiti.

  • This environment is a sandbox for testing that uses the same code base as our current production environment.

  • Transactions and customer accounts generated in this environment are treated as test objects and is test data is scrubbed daily.

  • References: https://posapi-training.flexiti.fi/flexiti/pos-api/

Note

Maintenance windows in our Training environment will be communicated ahead of time.

Our MERCHANT INTEGRATION environment:

Note

Our Merchant Integration environment has a standing maintenance window scheduled Monday and Wednesday mornings. Implementation teams can expect some instability during this time.

Our PRODUCTION environment:

  • This environment is the “Live” production environment.

  • Customer accounts generated in this environment hit the Credit Bureau and any Transactional data generated is real.

  • References: https://posapi.flexiti.fi/flexiti/pos-api/

Note

Maintenance windows in our Production environment will be communicated ahead of time.

Authentication

The Flexiti API uses API keys to authenticate requests. Your keys consist of a Client ID and a Client Secret. You can view and manage your API keys in the Development Portal. If you do not include your keys when making an API request, or use one that is incorrect, Flexiti returns an error.

...

Obtaining your Flexiti API Keys

  • Go to our Developer Portal

  • Create a Developer Portal Account(s) to receive API keys and set up your trust URL (or IP).

    Be sure to keep them secure!

    your API keys:

  • Review the API documentation

  • Use your credentials using Postman or Swagger

  • Implement the TRAINING (test) version on your Staging environment and test thoroughly

  • Implement the PROD (live) version on your Production environment and review

  • If you need keys for the MERCHANT INTEGRATION environment, please request them.

Environments

All API requests exist in MERCHANT INTEGRATION, TRAINING and PRODUCTION environments. All objects - customers, plans, transactions, and so forth created in one environment do not exist in the other.

In our MERCHANT INTEGRATION environment:

  • Transactions and customer accounts generated in this environment are only treated as test objects.

  • This environment is considered an “integration” environment

  • We introduce new code to this environment prior to production Releases to allow Merchants an opportunity to integrate the new code with their current implementations

  • Here is our API Changelog & Release Schedule

  • References: https://posapi-mi.flexiti.fi/flexiti/pos-api/

Note

Our Merchant Integration environment has a standing maintenance window scheduled Monday and Wednesday mornings. Implementation teams can expect some instability during this time.

In our TRAINING environment:

  • Transactions and customer accounts generated in this environment are only treated as test objects.

  • Our training environment is scrubbed from time to time

  • This environment is considered a “test” environment

  • References: https://posapi-training.flexiti.fi/flexiti/pos-api/

Note

Maintenance windows in our Training environment will be communicated ahead of time.

In our PRODUCTION environment:

  • Customer accounts generated in this environment hit the Credit Bureau

  • Transactional data generated in this environment are stored in Flexiti’s production systems

  • This environment is considered a “Live” production environment

  • References: https://posapi.flexiti.fi/flexiti/pos-api/

...

Errors

Flexiti uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a transaction failed, etc.). Codes in the 5xx range indicates an error with Flexiti's servers.

...