Skip to main content

​
Protocols

The Flinks API is a RESTful service that adheres to HTTP methodologies as defined by RFC 2616. It enables secure, structured communication between your application and Flinks services.

​
Protocols & Security

  • Protocol : REST over HTTPS
  • Security : Only TLS v1.2+ is supported. Connections using older versions of TLS will be rejected.
  • Content-Type : All requests must include the header application/json
  • Request Body : Must be valid JSON when applicable.

​
Environment & URL Structure

Note on the API call URL

In this guide, the sandbox instance is used. Therefore, you will need to adjust the API call URL for your needs.
When integrating with Flinks, ensure you use the correct environment (e.g., sandbox or production). The API URL structure includes your instance name and customerId, which are provided during onboarding.
http
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices/Authorize
Example: If your instance is yourcompany and your customerId is 334a74ab-6592-4431-a6a0-3f5585d8019d, the URL would be:
http
https://yourcompany-api.private.fin.ag/v3/334a74ab-6592-4431-a6a0-3f5585d8019d/BankingServices/Authorize

​
Testing the API

You can test API calls directly from the documentation interface. To do so, you’ll need a valid loginId from your production instance.
  • Always specify your environment (sandbox or production) in API calls.
  • Ensure your customerId and instance are correctly configured.
  • Use HTTPS and TLS v1.2+ for all communications.
  • Validate your JSON payloads before sending requests.