API REFERENCE v1

Receiving Callbacks

Receipt callbacks on the selected Litecoin network, durable retries and protected attempt logs. Workers require separate activation; network support does not establish live mainnet acceptance. Wallet, invoice and forwarding events remain deferred.

On this page

#Accounts, Wallets and Addresses

Available

New receiving-address observations create a durable notification. Integer value, address, txid, confirmations, account, currency and merchant data are delivered by POST JSON or GET query (data as JSON). The other optional product fields below remain deferred.

Parameter	Type	Description	Required
`value`	integer	Observed amount in atomic units.	Yes
`input_address`	string	Address that received the payment.	Yes
`confirmations`	integer	Confirmation count at observation time.	Yes
`input_transaction_hash`	string	Incoming blockchain transaction hash.	Yes
`currency`	string	Payment currency identifier.	Yes
`data`	object	Merchant metadata supplied with the callback configuration.	No
`account`	string	Public account identifier for account-scoped events.	No
`wallet`	string	Public wallet identifier for wallet-scoped events.	No
`transaction_hash`	string	Outgoing transaction hash after forwarding.	No
`payment`	string	Outgoing payment identifier after forwarding.	No
`destinations`	array	Forwarded recipients and amounts.	No

{
  "account": "ACCOUNT_ID",
  "currency": "ltc",
  "value": 250000,
  "input_address": "LTC_ADDRESS",
  "confirmations": 1,
  "input_transaction_hash": "TRANSACTION_HASH",
  "data": {
    "order_id": "ORDER_ID"
  }
}

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

#Acknowledgement and Retries

Available

The reference protocol acknowledges an event with HTTP 200, Content-Type text/plain and the exact body *ok*, including both asterisks.

Response part	Required value
Status	200
Content-Type	text/plain
Body	ok

#Invoices

Planned

Invoice state changes use a JSON notification sent to the configured merchant URL with POST.

Parameter	Type	Description	Required
`account`	string	Public account identifier.	Yes
`invoice`	string	Invoice identifier.	Yes
`status`	string	Lifecycle state: created, partpaid, paid, overpaid, completed or expired.	Yes

{
  "account": "ACCOUNT_ID",
  "invoice": "INVOICE_ID",
  "status": "paid"
}

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

#Simple Forwarding

Planned

The legacy forwarding contract sends notification fields as query parameters on a GET request to the merchant callback URL.

Parameter	Type	Description	Required
`value`	integer	Original incoming amount in atomic units.	Yes
`input_address`	string	Generated deposit address.	Yes
`confirmations`	integer	Incoming transaction confirmation count.	Yes
`input_transaction_hash`	string	Incoming transaction hash.	Yes
`transaction_hash`	string	Forwarded transaction hash.	No
`destination_address`	string	Merchant destination address.	No
`value_forwarded`	integer	Amount forwarded after fees.	No

{
  "value": 250000,
  "input_address": "LTC_ADDRESS",
  "confirmations": 1,
  "input_transaction_hash": "INCOMING_TRANSACTION_HASH",
  "transaction_hash": "OUTGOING_TRANSACTION_HASH",
  "destination_address": "LTC_DESTINATION_ADDRESS",
  "value_forwarded": 249000
}

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

#Verify Events Before Fulfillment

Available

Treat callbacks as potentially repeated observations. Unconfirmed transactions can disappear or be replaced; receiving a notification is not proof of final settlement.

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