Partner Details

GET

/api/v1/partner/{zynkPartnerId}

Retrieves detailed information about a partner including their configuration, wallet addresses, credit limits, fee rates, transaction statistics, and current token balances. The endpoint can be accessed by the partner themselves (using their authenticated context).

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/partner/zp_123456' \
--header 'x-api-token: <api-key>'

Response Example

200 - Success

{
    "success": true,
    "message": "Partner details retrieved successfully.",
    "data": {
        "type": "not defined",
        "zynkPartnerId": "partner_1234567890abcdef",
        "partnerName": "Example Partner Inc.",
        "transferMode": "IMMEDIATE",
        "chainId": "101",
        "networkName": "Solana Mainnet",
        "tokenAddress": "So11111111111111111111111111111111111111112",
        "tokenName": "SOL",
        "cryptoTokenId": "token_1234567890abcdef",
        "partnerDepositWallet": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
        "partnerOperationalWallet": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
        "secretsKey": "partner_1234567890abcdef_SOLANA_MAINNET_PK_REPLENISH_SIGNER",
        "webhookUrl": "https://partner.example.com/webhooks",
        "isKycThroughUrl": true,
        "feeRates": {
            "ratePerUnitTime": 0.01,
            "customerReliabilityScoreRate": 0.005,
            "affiliateFeeRate": 0.02,
            "fixedBaseRate": 0.001,
            "counterPartyRiskPremiumRate": 0.003
        },
        "limits": {
            "creditLimit": 100000,
            "dailyLimit": 50000,
            "txnLimit": 10000,
            "remainingCredit": 75000,
            "dailyUsage": 25000,
            "transactionsOpen": 5,
            "partialReplenished": 1000,
            "borrowedAmount": 50000,
            "totalRepaymentDue": 52000,
            "totalTransactions": 25
        },
        "url": "https://solscan.io/address/7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
        "tokenBalance": 12345.6789,
        "nativeCurrencyBalance": 10.5,
        "nativeCurrency": "SOL"
    }
}

Modified at 2025-11-11 17:29:02

Transaction Details by ID

Initiate Transaction