Finrax API
HomeChangelogIntegration GuideResources
HomeChangelogIntegration GuideResources
  1. Authorization
  • Getting Started
    • Introduction
    • Environments
    • Errors
    • Authorization
      • API Key Management
      • Signature
      • Code Snippets
  • Payments and Withdrawals
    • Crypto Payments
      • Fetch payment by ID
      • 🔒Fetch payments
      • Submit crypto payment
      • Request crypto payment
    • Fetch withdrawals
      GET
    • Fetch withdrawal metadata
      GET
    • Request crypto withdrawal
      POST
    • Fetch whitelisted addresses
      GET
    • Whitelist an address
      POST
    • Fetch crypto withdrawal approval by ID
      GET
    • Fetch business by ID
      GET
    • Fetch business balance
      GET
    • Unwhitelist an address
      DELETE
  • Callbacks
    • Deposit received notification
    • Withdrawal broadcast notification
    • Withdrawal approved/rejected notification
  • Address validation
    • Validate address
      GET
    • Validate address and destination tag
      GET
  • Rates and metadata
    • Fetch market rates
      GET
    • Fetch fiat rates
      GET
    • Fetch deposit rates
      GET
    • Fetch all currencies
      GET
  1. Authorization

API Key Management

API credentials can be managed directly from the Finrax Dashboard by users with the Manager or Admin or custom roles with the relevant permission. To create API credentials go to "Settings -> API keys" and click on the “New Key” button. Here you can provide a name (alias) for the key/secret pair and select the permissions that are relevant to your use-case. Your 2FA code will also be required as a step of the key creation process.
Due to security concerns, we also require IPs to be whitelisted. If we receive a request from an IP that was not listed for the API pair, we will reject it returning a 403 (Forbidden) HTTP status code.
bandicam2024-07-0913-06-23-850-ezgif.com-video-to-gif-converter.gif
Upon successful API credentials creation, you will be provided with the values for the API key and API secret. At this stage, you must store the API secret securely, e.g. by writing it down or copying it in a trusted store as this is the only time the API secret will be displayed.
Once created the API key and secret are immutable, however, the IP white-list and permissions can be edited at any time.
WARNING
If you lose your API secret or it becomes compromised you must delete the API credentials pair immediately and generate a new one. If you find out that the access to the dashboard has been compromised, please contact us immediately.
Modified at 2024-07-09 11:12:39
Previous
Authorization
Next
Signature
Built with