Finrax API
HomeChangelogIntegration GuideResources
HomeChangelogIntegration GuideResources
  1. Getting Started
  • 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. Getting Started

Authorization

When authorizing against the Finrax REST API, one must provide a standard HTTP Authorization header in the following format:
'Authorization: FRX-API api-key=<your_api_key>,
                        signature=<signature>,
                        timestamp=<unix_timestamp>'
API credentials consist of an API key and an API secret, forming a pair together. The key must be passed with each request in the Authorization header’s API-Key component and the API secret is used for the generation of the Signature component.
The Timestamp component must be an integer value representing the current UNIX epoch time in milliseconds.
INFO
All requests that require authorization are labelled with this icon 🔒
Modified at 2024-07-09 11:15:17
Previous
Errors
Next
API Key Management
Built with