1. Getting Started
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Balances & History
      • Get Balances
      • Get Balance History
    • Crypto Deposits
      • Get Crypto Deposit Details
      • Add Travel Rule
    • Crypto Withdrawals
      • Get Whitelisted Wallets
      • Add Whitelisted Wallet
      • Delete Whitelisted Wallet
      • Create Crypto Withdrawal
      • Get Crypto Withdrawal Details
    • SEPA Deposits
      • Get SEPA Payment Details
      • Get SEPA Deposit Details
    • SEPA Withdrawals
      • Create SEPA Withdrawal
      • Get SEPA Withdrawal Details
    • Currency Exchange
      • Get Rates
      • Create Lock
      • Create Exchange
      • Get Exchange Details
  • Integration
    • Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • Crypto Deposit Webhook
      • Crypto Withdrawal Webhook
      • SEPA Deposit Webhook
      • SEPA Withdrawal Webhook
      • Exchange Webhook
  • Reference
    • Supported Currencies
    • Fees
    • FAQ
    • Changelog
    • Support
  1. Getting Started

Authentication

The Partner API uses an API key to authenticate requests. Your API key is issued during onboarding by Fintegence Support.

Environments#

EnvironmentBase URLPurpose
Staginghttps://<STAGING_URL>Integration and testing. Blockchain operations use test networks.
Productionhttps://api.fintegence.ioLive operations with real funds.
Staging and production use separate API keys. A staging key does not work in production and vice versa.

API key#

Include the API key in the x-api-key header of every request:

Request format#

All requests must be sent over HTTPS.
Request and response bodies use JSON. Send Content-Type: application/json with every request that has a body.
All amounts are sent and returned as strings (e.g. "10.5") to avoid floating-point precision issues.
The API version is part of the path (/v1/...).
Endpoints under /v1/partner/... return or manage data of the Partner's account - balances, balance history, whitelisted wallets, Travel Rule registrations and SEPA payment details. Transaction endpoints (withdrawals, exchanges, rates and transaction details) have no /partner segment.

Test your connection#

The simplest way to verify your API key is to call Get Balances:
A successful response returns HTTP 200 with the list of your balances. If you receive HTTP 401 or 403, see Troubleshooting below.

IP whitelisting#

In production, requests are accepted only from IP addresses registered for your account. Before going live, send the list of your production server IP addresses to support@fintegence.com. Requests from other IP addresses are rejected with HTTP 403 (P4003), even with a valid API key.
If your server IP addresses change (e.g. after migrating your infrastructure), update the list with Support in advance to avoid interruptions.

Troubleshooting#

ProblemPossible cause
401 P4001 on every requestThe x-api-key header is missing or misspelled.
401 P4002The API key is invalid - check for extra spaces or a key from the other environment. Staging and production keys are separate.
The Partner API uses an API key to authenticate requests. Your API key is issued during onboarding by Fintegence Support.

Environments#

EnvironmentBase URLPurpose
Staginghttps://<STAGING_URL>Integration and testing.
Productionhttps://api.fintegence.ioLive operations with real funds.
Staging and production use separate API keys. A staging key does not work in production and vice versa.
Blockchain networks on staging
Some currencies on staging may operate on main blockchain networks, not test networks. Before sending any funds to a staging deposit address, confirm with Support which networks are used for your account. Send only small amounts needed for testing.

API key#

Include the API key in the x-api-key header of every request:

Request format#

All requests must be sent over HTTPS.
Request and response bodies use JSON. Send Content-Type: application/json with every request that has a body.
All amounts are sent and returned as strings (e.g. "10.5") to avoid floating-point precision issues.
The API version is part of the path (/v1/...).
Endpoints under /v1/partner/... return or manage data of the Partner's account - balances, balance history, whitelisted wallets, Travel Rule registrations and SEPA payment details. Transaction endpoints (withdrawals, exchanges, rates and transaction details) have no /partner segment.

Test your connection#

The simplest way to verify your API key is to call Get Balances:
A successful response returns HTTP 200 with the list of your balances. If you receive HTTP 401 or 403, see Troubleshooting below.

IP whitelisting#

In production, requests are accepted only from IP addresses registered for your account. Before going live, send the list of your production server IP addresses to support@fintegence.com. Requests from other IP addresses are rejected with HTTP 403 (P4003), even with a valid API key.
If your server IP addresses change (e.g. after migrating your infrastructure), update the list with Support in advance to avoid interruptions.

Troubleshooting#

ProblemPossible cause
401 P4001 on every requestThe x-api-key header is missing or misspelled.
401 P4002The API key is invalid - check for extra spaces or a key from the other environment. Staging and production keys are separate.
403 P4003 in production onlyThe request comes from an IP address that is not whitelisted.

Keeping your API key secure#

Use the API key only in server-side code. Never expose it in frontend applications, mobile apps or public repositories.
Store the key in a secrets manager or environment variables, not in source code.
Restrict access to the key to the people and systems that need it.
If you suspect that your key has been compromised, contact support@fintegence.com immediately to revoke it and issue a new one.

Keeping your API key secure#

Use the API key only in server-side code. Never expose it in frontend applications, mobile apps or public repositories.
Store the key in a secrets manager or environment variables, not in source code.
Restrict access to the key to the people and systems that need it.
If you suspect that your key has been compromised, contact support@fintegence.com immediately to revoke it and issue a new one.
Previous
Introduction
Next
Business Use Cases
Built with