Set Up Development Environment

Learn how to set up your development environment to use Finix's API.

Before You Begin

Get started by creating a sandbox account with Finix.

Before you can process payments using the Finix API, you need:

An API Key
Your business's Merchant ID.

Finix API Overview

The Finix API is resource oriented, relying heavily on common REST principles. Our API uses JSON encoded requests and responses.

You will receive separate Sandbox and Live accounts, as well as corresponding API credentials to access the Finix API.

Authentication

To communicate with the Finix API, you must authenticate your requests via HTTP Basic Authentication with a username:password combination, which you can get from your Finix Dashboard. If you do not have a Dashboard yet, you can test our APIs with the Sandbox credentials below.

Parameter	Value
Sandbox Username	`USsRhsHYZGBPnQw8CByJyEQW`
Sandbox Password	`8a14c2f9-d94b-4c72-8f5c-a62908e5b30e`

Request Format

curl "https://finix.sandbox-payments-api.com/" \
    -H "Content-Type: application/json" \
    -H "Finix-Version: 2022-02-01" \
    -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Environments

Finix provides two environments with distinct base URLs to make API requests.

A Sandbox environment for developing and testing your integration.
A Live environment for processing payments.

These environments are entirely separate and do not share API Credentials.

Environment	Endpoint URL
Sandbox	`https://finix.sandbox-payments-api.com`
Live	`https://finix.live-payments-api.com`

Live Access

To get access to the Live environment, please reach out to your Finix point-of-contact.

Supported Countries

Finix supports entities in the following countries:

United States
Canada

Creating an API Key

To create an API key with the dashboard, log in and click Developer > Create API Key. Make sure you save the username and password that gets returned. You won't be able to access the credentials again after closing the window.

As you use the credentials in your Finix API requests, you'll see that activity show up in the Finix Dashboard.

Finding Merchant ID

Click Developers to find your business's Merchant ID under Finix Processing Details. Use the Application and Merchant IDs along with the API Key to process payments in your integration.

If you need additional assistance finding your merchant id, reach out to our support team at support@finix.com.