Skip to content
coinkun docs
Coinkun home Dashboard

API REFERENCE v1

Settings

Account callback settings are available. Wallet preferences, forwarding and account profiles remain planned.

On this page

#Account settings

Available

Update the selected-network LTC account callback. Only the fields below are accepted; changing settings does not contact the callback URL.

PATCH/accounts/{account}

Request

  • HTTP MethodPATCH
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/accounts/{account}
  • Authorization
    transfer-key in the JSON body. JWT remains planned.
ParameterTypeDescriptionRequired
accountstringAccount identifier in the URL.Yes
currencystringMust be ltc on the selected network.Yes
transfer-keystringTransfer Key of this account. JWT is not implemented.Yes
callbackobject or nullNotification method, destination URL and optional merchant metadata.Yes
curl --request PATCH "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}" \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "ltc",
  "transfer-key": "YOUR_TRANSFER_KEY",
  "callback": {
    "url": "https://merchant.example/notify",
    "method": "POST",
    "data": {}
  }
}'

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Wallet settings

Planned

Planned wallet preferences use a wallet identifier rather than an internal account identifier. The currency belongs to the wallet itself.

PATCH/wallets/{wallet}

Request

  • HTTP MethodPATCH
  • Content Typeapplication/json
  • URLhttps://coinkun.com/api/v1/wallets/{wallet}
  • Authorization
    Bearer YOUR_ACCESS_TOKEN Planned
ParameterTypeDescriptionRequired
walletstringPublic wallet identifier.Yes
transfer-keystringRequired unless a supported access token is used.No
processing-fee-policystringIntended fixed or percentage fee policy.No
callbackobjectNotification configuration.No
destinationsarrayPercentage-based forwarding destinations.No
destination_rulesarrayReserved for automatic transfer rules.No
curl --request PATCH "https://coinkun.com/api/v1/wallets/${WALLET_ID}" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "transfer-key": "YOUR_WALLET_TRANSFER_KEY",
  "processing-fee-policy": "fixed"
}'

Illustrative example · Replace YOUR_* and ${VARIABLES} with your own values · Never paste real keys into shared documentation.

#Account profile

Planned

Proposed profile fields are grouped under profile rather than exposed as a separate endpoint. They are not inputs to the currently implemented Create Account endpoint.

FieldTypeMeaning
first_namestringGiven name
last_namestringFamily name
emailstringContact email address
send_updatesbooleanPreference for product updates
countrystringISO 3166-1 alpha-3 country code
org_typestringOrganization category

#Automatic transfer rules

Planned

Automatic transfers may eventually support balance thresholds and schedules. A complete destination_rules request schema is not published in the reference documentation, so this page does not invent one.

Coinkun API v1 · Reviewed against this checkout
Contract reference: Apirone documentation. Adapted for Coinkun; implementation status is shown above.

Type to search the documentation

↑ ↓ navigate openesc closeLocal search · No data sent