Partner API
  1. API References
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Balances & Transaction History
        • Get Balances
        • Get Transaction History
        • Create Wallet
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • SEPA Transfers
        • Get SEPA Deposit Info
        • Get SEPA Deposit Contact List
        • Create a SEPA Transfer
        • Get SEPA Transfer Details
      • Crypto Withdrawal
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • Crypto Deposits
        • Update Travel Rule
      • Orders
        • Get Rates
        • Retrieve Order Rate and Create a Lock
        • Create and Finalize an Order
        • Get Order Details
      • Payment link & Checkout Link
        • Generate Payment Link
        • Generate Hosted Checkout
        • Get Payment Link Details
    • User Operations
      • Onboarding & KYC Flow
        • Create User Account
        • Method A: Add KYC File
        • Method B: Creating KYC Verification
        • Method B: Redirect to Verification
        • Method B: Get KYC Status
        • Add User Verification
        • Add POA File
      • Account Management
        • Update Existing User
        • Delete User
        • Suspend User
        • Unsuspend User
      • Balances & Transaction History
        • Get User Balances
        • Get User Transaction History
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • SEPA Transfers
        • Get SEPA Deposit Info
        • GET SEPA Deposit Contact List
        • Create a SEPA Transfer
        • Get SEPA Transfer Details
      • Crypto Withdrawal
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • Crypto Deposits
        • Update Travel Rule
      • Internal Transfers
        • Create a Transfer
        • Get Transfer Details
      • Virtual Cards
        • Create Virtual Card
        • Get All User Cards
        • Get Card Details
        • Update Card PIN
        • Block Card
        • Unblock Card
        • Get Card Limits
        • Update Card Limits
        • Delete Card
  • Integration
    • SDKs & Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • User & KYC Webhooks
        • User Balance Generation Webhook
        • KYC File Added Webhook
        • POA Verification Status Webhook
        • KYC Verification Status Webhook
        • Create Wallet Webhook
      • Transfers & Payments Webhooks
        • P2P Transfer Webhook
        • Partner SEPA Transfer Webhook
        • User SEPA Transfer Webhook
        • SEPA Deposit Webhook
        • Crypto Withdrawal Webhook
        • Crypto Deposit Webhook
        • Exchange Webhook
        • Card Transaction Webhook
        • Order status Webhook
        • Payment Link Webhook
      • Card Webhooks
        • Card 3DS Code Webhook
        • Card Activation Code Webhook
  • Reference
    • Supported Countries
    • Supported Currencies
    • Fees
    • FAQ
    • Changelog
    • Support
  1. API References

Partner Operations

This module contains endpoints for displaying information and managing the partner account, including generating deposit addresses, retrieving balances, transaction history, performing exchanges, SEPA transfers, and crypto withdrawals. These requests operate on the partner's account as a whole and do not require an external user ID.
The Partner API is designed for business-level operations, such as treasury management, settlements, payouts, and controlled fund movements.

Core endpoints#

Balances & Transaction History#

Get Balances
View current balances for all supported currencies in your account.
Get Transaction History
Retrieve a detailed, paginated history of all account transactions.
Create Wallet
Generate a unique deposit address for a specific cryptocurrency.

Currency Exchange#

Retrieve Rate
Get real-time conversion rates for supported pairs.
Create Exchange Lock
Get a live exchange rate and lock it for a future currency swap.
Finalize Exchange
Execute a currency exchange using a previously created rate lock.
Exchange Details
Track detailed information of a specific exchange operation.

SEPA Transfers#

SEPA Deposit Info
Get your dedicated bank details for incoming SEPA transfers.
SEPA Contact List
Manage saved bank accounts for external fiat payouts.
Create SEPA Transfer
Send funds from your fiat balance to an external IBAN.
Get SEPA Details
Check the status and details of a specific SEPA transfer.

Crypto Withdrawal#

Get Network Fee
Check current blockchain gas costs and limits for withdrawals.
Create Withdrawal
Initiate a cryptocurrency withdrawal to an external wallet.
Withdrawal Details
Check the status and blockchain details of a crypto withdrawal.

Crypto Deposits#

Update Travel Rule
Update compliance data for incoming cryptocurrency deposits.

Orders#

Get Rates
View current order-specific exchange rates.
Create Order Lock
Lock a rate specifically for an Order-based transaction.
Finalize Order
Execute an order transaction using a previously created lock.
Get Order Details
Track the status and details of a specific order.

Payment link & Checkout Link#

Generate Payment Link
Create standard payment collection links.
Hosted Checkout
Generate white-label payment sessions with custom branding.
Payment Details
Track Payment Link status and nested blockchain transactions.

Typical Workflows#

Workflow: Receiving Cryptocurrency#

1.
Generate a new wallet for the desired currency using Create Wallet.
2.
After the wallet is created, you will receive a webhook notification confirming the address.
3.
For large deposits, ensure compliance by using Update Travel Rule if required.

Workflow: Currency Exchange#

1.
Retrieve exchange rates and create a rate lock using Create Exchange Lock.
2.
Finalize the exchange using the lockId with Finalize Exchange.
3.
Track the transaction status using Exchange Details or via Webhooks.

Workflow: Crypto Withdrawal#

1.
(Recommended) Check the network fee for the asset using Get Network Fee.
2.
Create a crypto withdrawal using Create Withdrawal.
3.
Track the status using Withdrawal Details.

Workflow: SEPA Transfer#

1.
For incoming funds, retrieve your details via SEPA Deposit Info.
2.
To send funds, use Create SEPA Transfer.
3.
Track the status using Get SEPA Details.

Workflow: Payment Links & Checkout#

1.
Generate a session via Hosted Checkout or Generate Payment Link.
2.
Redirect your user to the provided URL to complete the payment.
3.
Monitor the status via Payment Details.
Onboarding Required
Hosted Checkout (White-label) requires manual configuration. Please contact our support team to set up your logo and business parameters before use.
Previous
API References
Next
Balances & Transaction History
Built with