There are several ways to explore and test the Partner API - directly in this documentation or in your own API client. Before you start, get your API key and environment URLs - see Authentication.Try It in the Documentation#
Every endpoint page includes a Try it console. It is the fastest way to send a real request and inspect the response, without installing anything.Best for: quick checks of request and response structures, and testing single endpoints.
How to use it: open an endpoint page, click Try it, select the environment, enter your API key and send the request. The response and the actual request sent are displayed on the page.
Requests sent from the console are real API calls. Use the staging environment and your staging API key, unless you intend to operate on real funds.
OpenAPI Specification#
The full Partner API specification is available below in OpenAPI 3.0 format. Use it to import all endpoints into your API client or to generate client code in your programming language.Best for: testing multi-step flows, automated tests and sharing requests across your team.
What's included#
All Partner API endpoints, grouped like in this documentation (Balances & History, Crypto Deposits, Crypto Withdrawals, SEPA Deposits, SEPA Withdrawals, Currency Exchange).
Request and response schemas with field descriptions.
Request and response examples.
API key authentication (x-api-key header).
Import into your API client#
Expand the specification at the bottom of this page and copy it with the copy button in the top right corner of the code block. Depending on your client, paste it directly or save it as openapi.json and import the file.| Client | How to import |
|---|
| Postman | Click Import and paste the copied specification into the input field, or drop the openapi.json file into the window. |
| Insomnia | In your workspace, click Import, choose Clipboard (or File), click Scan and then Import. To create requests from the specification, click Generate and select Requests. |
| Bruno | Click + in the top left corner, select Import Collection and choose the openapi.json file. |
| Swagger Editor | Open editor.swagger.io and paste the specification into the editor, or use File → Import File. |
Other API clients that support OpenAPI 3.0 can import the specification as well. Menus may differ between versions - if a step does not match your client, see its documentation for importing OpenAPI files.After importing, set the base URL for your environment (see Authentication) and add your API key in the x-api-key header.Generate client code#
You can generate a client library from the specification, e.g. with OpenAPI Generator:Replace typescript-fetch with the generator for your language, e.g. python, java or go. The full list is available in the OpenAPI Generator documentation.All amounts in the API are strings. Do not convert them to floating-point numbers in your code - use a decimal type to avoid precision issues.
Keeping it up to date#
The specification corresponds to the current version of the documentation. When the API changes, copy it again. Changes are listed in the Changelog.Recommended Approach#
1.
Explore - send your first requests with Try it, starting with Get Balances to verify your API key.
2.
Build flows - import the OpenAPI specification into your API client and test complete flows on staging. See Business Use Cases for examples. 3.
Track statuses - configure Webhooks early. Deposits, withdrawals and exchanges are processed asynchronously. 4.
Go live - after successful testing on staging, contact support@fintegence.com to whitelist your production IP addresses and switch to production. Withdrawals and exchanges are validated immediately, but processed asynchronously - after a 201 response, their status changes until they reach a final status. Deposits appear when incoming funds are detected. Use webhooks for status updates and the details endpoints (e.g. Get Crypto Withdrawal Details) as a fallback for reconciliation. See Transaction Processing. Specification#
