Partner API
  1. API References
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Get Balances
      • Get Transaction History
      • Retrieve Exchange Rate and Create a Lock
      • Create and Finalize an Exchange
      • Create Crypto Withdrawal
      • Create a SEPA Transfer
      • Get SEPA Transfer Details
    • User Accounts with KYC
      • Create User Account and Generate Balances
      • Add KYC File
      • Add POA File
      • Add User Verification
      • Update Existing User
      • Delete User
      • Suspend User
      • Unsuspend User
      • Get User Balances
      • Get User Transaction History
    • User Accounts without KYC
      • Create User Account and Generate Balances Without KYC
      • Update Existing User
      • Delete User
      • Suspend User
      • Unsuspend User
      • Get User Balances
      • Get User Transaction History
    • KYC by P100
      • Creating KYC Verification
      • Redirect to Verification
      • Get KYC Status
    • Currency Exchange
      • Retrieve Exchange Rate
      • Retrieve Exchange Rate and Create a Lock
      • Create and Finalize an Exchange
      • Retrieve Detailed Exchange Infromation
    • Crypto Deposits
      • Update Travel Rule
    • Crypto Withdrawals
      • Get Network Fee
      • Create Crypto Withdrawal
      • Get Crypto Withdrawal Details
    • 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
    • Custom Fiat Operations
      • SEPA Deposit & Withdrawal
  • Integration
    • SDKs & Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • User & KYC Webhooks
        • User Balance Generation
        • KYC File Added
        • POA Verification Status
        • KYC Verification Status
      • Transfers & Payments Webhooks
        • P2P Transfer Webhook
        • SEPA Transfer
        • SEPA Deposit
        • Crypto Withdrawal
        • Crypto Deposit
        • Exchange
        • Card Transaction
      • Card Webhooks
        • Card 3DS Code
        • Card Activation Code
  • 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 retrieving balances, transaction history, performing exchanges, SEPA transfers, crypto withdrawals, and internal transfers between the partner account and a user. These requests operate on the partner's account as a whole, in contrast to user-specific endpoints, and therefore do not require an external user ID — except for internal transfers, where the sourceExternalUserId or destinationExternalUserId must be provided to identify the user involved.
The Partner API is designed for business-level operations, such as treasury management, settlements, payouts, and controlled fund movements between the partner and their users.

Core endpoints#

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 Exchange Lock
Get a live exchange rate and lock it for a future transaction.
Finalize Exchange
Execute a currency exchange using a previously created rate lock.
Create Crypto Withdrawal
Initiate a cryptocurrency withdrawal to a specified external wallet.
Create SEPA Transfer
Send funds from your fiat balance to an external bank account via SEPA.
Get SEPA Transfer Details
Check the status and details of a specific SEPA transfer.

Typical Workflows#

Workflow: Currency Exchange
1.
Retrieve exchange rates and create a rate lock for the partner account using Retrieve Exchange Rate and Create a Lock.
2.
Finalize the exchange using the lockId from the previous step with Create and Finalize an Exchange.
3.
(Optional) Check the exchange details using Get Exchange Details (in the Currency Exchange module) with the exchangeId received in the response.
Workflow: Crypto Withdrawal
1.
(Recommended) Check the network fee for the selected currency using Get Network Fee (described in the Crypto Withdrawals ).
2.
Create a crypto withdrawal from the partner balance using Create Crypto Withdrawal.
3.
Track the transaction status using Get Crypto Withdrawal Details (in the Crypto Withdrawals module) with the withdrawalId received in the response.
Workflow: SEPA Transfer
1.
Create a SEPA transfer from the partner balance using Create a SEPA Transfer.
2.
Track the transaction status using Get SEPA Transfer Details with the transferId received in the response.
Workflow: Internal Transfer (Partner ↔ User)
1.
Initiate an internal transfer between the partner balance and a user account using Transfer Between Partner and User.
If destinationExternalUserId is provided → funds move from the partner to the user.
If sourceExternalUserId is provided → funds move from the user to the partner.
Direct user-to-user transfers are not supported.
2.
The request returns a transferId. Use Get Transfer Details to track final status and handle possible errors.
3.
See full request/response schema in the Internal Transfers.
Previous
API References
Next
Get Balances
Built with