Skip to content
coinkun Docs API v1
Coinkun home Dashboard

Settings

Configure account and wallet callbacks, service fee policies, profile metadata and automatic transfers.

Examples use LTC unless stated otherwise. Use IDs and addresses for the selected currency.

On this page

#Account Settings

PATCH /accounts/{account} Available

Update settings for the selected currency. TRX and USDT share callback, service fee policy and Auto Transfer settings. Saving through either currency updates both; BTC/LTC stay independent. Omitted fields and accepted payments retain their settings.

URL
https://coinzaka.com/api/v1/accounts/{account}
Content type
application/json
Authorization
Account transfer-key in the JSON body, or an Authorization: Bearer access token from Login.

Parameters

ParameterTypeDescriptionRequired
accountstringAccount ID returned by Create Account.Required
currencystringAllowed: btc, ltc, trx, usdt@trx, xmr.Required
transfer-keystringRequired unless an Authorization Bearer access token is sent.Optional
callbacknull | object | objectMaximum 4096 canonical JSON bytes and nesting depth 8. HTTP(S) URL without credentials or fragment; method defaults to POST. Omitted or explicit-null data is stored and returned as null; receipt notification payloads use an empty object in that case. Explicit data objects are preserved. A null or omitted address callback inherits the current account or wallet default; an empty callback object disables it.Optional
processing-fee-policystringAllowed: percentage, fixed.Optional
feestringAutomatic network fee; normal only for TRON. Allowed: normal, priority, custom.Optional
fee-rateinteger | stringRequired only for custom. Positive integer atomic/vB; at most 99999 (Core accepts below one coin per 1,000 vbytes).Optional
destinationsnull | arrayInstant transfer recipients (up to 255). BTC/LTC percentages must total 100%; one omitted, null or empty amount receives the remainder (100% for a sole recipient). Ambiguous or zero remainders are rejected. Shares have at most two effective decimal places and responses contain explicit normalized percentages. TRX/USDT require one 100% destination. BTC/LTC settings are independent; TRX and USDT share settings in both Accounts and Wallets. Null disables new automatic transfers. Accepted payments retain their recipients and fees. Requires service activation for the selected currency.Optional
destination_rulesnull | arrayOne threshold or recurring rule with one recipient. Threshold sends the available balance once it reaches the atomic threshold. Recurring sends a fixed amount or percentage on a UTC schedule, at minute 0, using ISO weekdays (Sunday is 7) or month days 1-28 and L for the last day. Fees are deducted for Threshold and scheduled 100% sweeps, otherwise added on top; regular service fees apply. TRON reserves a complete cycle across up to 100 source addresses, with one cycle-wide service fee and aggregate fee limits. Null disables the rule.Optional
profileobject | nullAccount-level merchant metadata, validated as on creation; replaces the stored profile, and {} or null clears it.Optional
curl --request PATCH "https://coinzaka.com/api/v1/accounts/${ACCOUNT_ID:?Set ACCOUNT_ID}" \
  --header 'Content-Type: application/json' \
  --data-binary @- <<JSON
{
  "currency": "ltc",
  "transfer-key": "${TRANSFER_KEY:?Set TRANSFER_KEY}",
  "processing-fee-policy": "percentage",
  "callback": {
    "url": "${CALLBACK_URL:?Set CALLBACK_URL}",
    "method": "POST",
    "data": {}
  }
}
JSON

Bash: set ACCOUNT_ID, TRANSFER_KEY, CALLBACK_URL before running. Replace placeholders in the JSON Request tab. Responses are illustrative. Keep credentials on your server and out of shared code.

#Wallet Settings

PATCH /wallets/{wallet} Available

Update the wallet's settings. Send at least one setting; omitted fields retain their current values. Accepted payments keep their original settings.

URL
https://coinzaka.com/api/v1/wallets/{wallet}
Content type
application/json
Authorization
Wallet transfer-key in the JSON body, or an Authorization: Bearer access token from Login.

Parameters

ParameterTypeDescriptionRequired
walletstringWallet ID returned by Create Wallet.Required
transfer-keystringRequired unless an Authorization Bearer access token is sent.Optional
callbacknull | object | objectMaximum 4096 canonical JSON bytes and nesting depth 8. HTTP(S) URL without credentials or fragment; method defaults to POST. Omitted or explicit-null data is stored and returned as null; receipt notification payloads use an empty object in that case. Explicit data objects are preserved. A null or omitted address callback inherits the current account or wallet default; an empty callback object disables it.Optional
processing-fee-policystringService fee policy. Allowed: percentage, fixed.Optional
feestringAutomatic network fee; normal only for TRON. Allowed: normal, priority, custom.Optional
fee-rateinteger | stringRequired only for custom. Positive integer atomic/vB; at most 99999 (Core accepts below one coin per 1,000 vbytes).Optional
destinationsnull | arrayInstant transfer recipients (up to 255). BTC/LTC percentages must total 100%; one omitted, null or empty amount receives the remainder (100% for a sole recipient). Ambiguous or zero remainders are rejected. Shares have at most two effective decimal places and responses contain explicit normalized percentages. TRX/USDT require one 100% destination. BTC/LTC settings are independent; TRX and USDT share settings in both Accounts and Wallets. Null disables new automatic transfers. Accepted payments retain their recipients and fees. Requires service activation for the selected currency.Optional
destination_rulesnull | arrayOne threshold or recurring rule with one recipient. Threshold sends the available balance once it reaches the atomic threshold. Recurring sends a fixed amount or percentage on a UTC schedule, at minute 0, using ISO weekdays (Sunday is 7) or month days 1-28 and L for the last day. Fees are deducted for Threshold and scheduled 100% sweeps, otherwise added on top; regular service fees apply. TRON reserves a complete cycle across up to 100 source addresses, with one cycle-wide service fee and aggregate fee limits. Null disables the rule.Optional
curl --request PATCH "https://coinzaka.com/api/v1/wallets/${WALLET_ID:?Set WALLET_ID}" \
  --header 'Content-Type: application/json' \
  --data-binary @- <<JSON
{
  "transfer-key": "${TRANSFER_KEY:?Set TRANSFER_KEY}",
  "processing-fee-policy": "percentage",
  "callback": {
    "url": "${CALLBACK_URL:?Set CALLBACK_URL}",
    "method": "POST",
    "data": {}
  }
}
JSON

Bash: set WALLET_ID, TRANSFER_KEY, CALLBACK_URL before running. Replace placeholders in the JSON Request tab. Responses are illustrative. Keep credentials on your server and out of shared code.

#Account Profile Reference

Include profile when creating an account or updating Account Settings. Updates replace the whole profile; an empty object or null clears it.

FieldTypeDescription
first_namestringGiven name
last_namestringFamily name
emailstringContact email address
send_updatesbooleanPreference for product updates
countrystringUppercase ISO 3166-1 alpha-3 country code
org_typestringOrganization category

#Auto Transfer Modes Reference

Instant, Recurring and Threshold modes are supported where automatic transfers are enabled below. Configure an enabled currency through Account Settings or the Dashboard.

Current service activation

CurrencyActivation
BTCEnabled
LTCEnabled
TRXDisabled
USDT TRC20Disabled

Current configuration for this service. Transfers follow the documented balance, fee and confirmation rules.

ModeTriggerCurrencies
InstantForward each receipt after confirmationBTC, LTC, TRX, USDT TRC20
RecurringSend a fixed amount or balance percentage on a UTC scheduleBTC, LTC, TRX, USDT TRC20
ThresholdSend the available balance when it reaches a set amountBTC, LTC, TRX, USDT TRC20
Coinkun API v1

Turning a preference off removes its saved values from this browser. It does not delete an account, change a payment or lock your current session. Read the storage details.

Type to search the documentation

↑↓ navigate↵ openesc close