Zynk
Getting StartedProduct GuidesAPI ReferenceFAQ'sRecipes
Getting StartedProduct GuidesAPI ReferenceFAQ'sRecipes
  1. Transformer: Utility
  • Transformer - Cross border transfer
    • Transformer: Entity
      • Create Entity
      • Entities
      • Entity By ID
      • Entity By Email
      • KYC Status
      • KYC Requirements
      • Submit KYC/KYB
      • Get KYC Documents
    • Transformer: Accounts
      • External Accounts
        • Generate Plaid Link Token
        • Update Plaid Link Token
        • Get External Account Payload Requirements
        • Add External Account
        • Enable External Account
        • Disable External Account
        • Delete External Account
        • Get External Account by ID
        • Get External Accounts
      • Funding Accounts
        • Create Funding Account
        • Activate Funding Account
        • Deactivate Funding Account
        • Funding Account by ID
        • All Funding Accounts
      • Entity Accounts (Deprecated)
        • Add Entity Account
        • Remove Entity Account
        • Get Entity Account
        • Get Entity Accounts
    • Transformer: Transfers
      • Simulate
      • Transfer
      • All transfers for partner
      • Transfer by execution ID
    • Transformer: Utility
      • Partner Payments Account Balance
        GET
      • Partner Payments Deposit
        POST
      • Get Jurisdictions
        GET
    • Webhooks
      • Get Webhook Events History
      • Registered Webhook URL
      • Register or Update Webhook URL
  • Transporter - Automated Liquidity Manager
    • ALM Market
      • Create Reserve Quote
      • Accept Reserve Frame
      • Get Active Reserves
      • Get All Reserves
    • Transaction Details by ID, Partner Transaction ID, or Transaction Hash
      GET
    • Transaction Details
      GET
    • Transaction Details by ID
      GET
    • Partner Details
      GET
    • Initiate Transaction
      POST
    • Replenish Fee Quote
      POST
    • Quote Fulfilled
      POST
    • Replenish Initiate
      POST
    • Replenish Batch Transaction
      POST
    • Replenish Fee Quote Batch
      POST
  • Teleport - Pay-In Accounts
    • Create Teleport Route
      POST
    • Update Teleport Destination
      POST
    • Toggle Teleport Status
      POST
    • Teleport Details
      GET
    • Teleport Routes by Entity
      GET
  • Continuum - Wallet Infrastructure
    • Authentication
      • Register primary authentication
    • Wallet Management
      • Prepare wallet creation challenge (Step 1)
      • Submit wallet creation activity (Step 2)
    • Account Management
      • Prepare account creation challenge (Step 1)
      • Submit account creation activity (Step 2)
    • Passkey Management
      • Prepare passkey registration (Step 1)
      • Submit passkey registration (Step 2)
      • Get passkey authenticators
      • Prepare passkey deletion (Step 1)
      • Submit passkey deletion (Step 2)
    • Wallet Information
      • Get wallet details
      • Get wallet balances
      • Get transactions for address
    • Sessions
      • Initiate OTP delivery
      • Start authentication session
  • Archive
    • KYC Documents
    • Prepaid KYC Balance
    • Prepaid KYC Deposit
  1. Transformer: Utility

Partner Payments Account Balance

GET
/api/v1/transformer/payments/balance
The Partner Payments Account Balance API allows partners to check their current payment balance and retrieve deposit instructions. This endpoint is useful for partners who want to prefund their account to streamline various payment processes within the platform.
GET /api/v1/transformer/payments/balance

Response#

{
  "success": true,
  "data": {
    "depositInstructions": {
      "chain": "Solana Devnet",
      "chainId": "103",
      "network": "devnet",
      "currency": "USDC",
      "tokenAddress": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
      "toWalletAddress": "BuiHuwd5s7e9HmyU6fqSqedcSKcG17r9TPcuCo6WsCHVB"
    },
    "balance": {
      "balance": 0.4,
      "mintAddress": "14jX8fW3qZRejGTpAs9YDmACWidDrABCPqR3Spjcbljn4"
    },
    "message": "Balance retrieved successfully"
  }
}

Response includes:#

Deposit Instructions#

Information needed to make a deposit to your partner payments account:
chain: The blockchain name (e.g., "Solana Devnet")
chainId: The blockchain network ID (e.g., "103")
network: The specific network to use (e.g., "devnet")
currency: The currency code for the deposit (e.g., "USDC")
tokenAddress: The address of the token contract on the blockchain
toWalletAddress: The wallet address where the deposit should be sent

Balance Information#

Details about your current partner payments balance:
balance: The current balance amount. This will be 0 by default if you have never made a deposit.
mintAddress: The address of the partner payment token in your account. This will be created when you make your first deposit and will be reused for all subsequent deposits.
message: Status message regarding the balance retrieval

Network Information#

Partner payments will be processed on the Solana Network, using USDC tokens. The specific network details depend on the environment:
Sandbox Environment: Solana Devnet (Chain ID: 103)
Production Environment: Solana Mainnet (Chain ID: 101)
Please note that:
The tokenAddress may vary depending on the network
The toWalletAddress may change over time (any changes will be communicated through active communication channels)

Usage Notes#

The balance amount represents the funds available for various payment operations.
Deposit instructions may change over time, so always check the latest instructions before making a deposit.
After depositing funds, your balance can be used for multiple payment operations.

Request

Authorization
Add parameter in header
x-api-token
Example:
x-api-token: ********************

Responses

🟢200OK
application/json
Balance and deposit instructions retrieved successfully
Body

🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/transformer/payments/balance'
Response Response Example
200 - Success
{
    "success": true,
    "data": {
        "depositInstructions": {
            "chain": "Solana Devnet",
            "chainId": "103",
            "network": "devnet",
            "currency": "USDC",
            "tokenAddress": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
            "toWalletAddress": "BuiHuwd5s7e9HmyU6fqSqedcSKcG17r9TPcuCo6WsCHVB"
        },
        "balance": {
            "balance": 0.4,
            "mintAddress": "14jX8fW3qZRejGTpAs9YDmACWidDrABCPqR3Spjcbljn4"
        },
        "message": "Balance retrieved successfully"
    }
}
Modified at 2025-11-11 17:27:26
Previous
Transfer by execution ID
Next
Partner Payments Deposit
Built with