Learn how to set up your development environment to make authenticated requests to the Finix API. After setup, you can send test API requests from your Sandbox environment.
This guide walks you through the credentials and configuration you need to call the Finix API, including HTTP Basic Authentication, environment base URLs, and how to find your Merchant ID.
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
MerchantID.
The Finix API is resource oriented and relies on common REST principles. The Finix API uses JSON-encoded requests and responses.
Finix provides separate Sandbox and Live accounts, along with the corresponding API credentials to access the Finix API.
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 the Finix API with the Sandbox credentials below.
| Parameter | Value |
|---|---|
| Sandbox Username | USsRhsHYZGBPnQw8CByJyEQW |
| Sandbox Password | 8a14c2f9-d94b-4c72-8f5c-a62908e5b30e |
curl "https://finix.sandbox-payments-api.com/" \
-H "Content-Type: application/json" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30eFinix 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 |
To get access to the Live environment, reach out to your Finix point of contact.
Finix supports entities in the following countries:
- United States
- Canada
To create an API key from the dashboard, log in and click Developer → Create API Key. Save the username and password that get returned. You cannot access the credentials again after closing the window.
As you use the credentials in your Finix API requests, that activity shows up in the Finix Dashboard.
Click Developer 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 help finding your Merchant ID, reach out to the Finix support team at support@finix.com.