Invoices | Coinkun API

#Create Invoice

Planned

POST/accounts/{account}/invoices

Request

HTTP MethodPOST
Content Typeapplication/json
URLhttps://coinkun.com/api/v1/accounts/{account}/invoices

Parameter	Type	Description	Required
`account`	string	Public account identifier.	Yes
`amount`	integer	Requested payment in atomic units.	Yes
`currency`	string	Payment currency identifier.	Yes
`lifetime`	integer	Expiration interval in seconds.	No
`expire`	string	ISO-8601 expiration timestamp; takes precedence over lifetime.	No
`callback-url`	string	Merchant endpoint for invoice status notifications.	No
`user-data`	object	Display metadata including title, merchant, url, price, sub-price, items and extras.	No
`linkback`	string	Merchant return URL.	No

curl --request POST "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/invoices" \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 250000,
  "currency": "ltc",
  "lifetime": 3600,
  "callback-url": "https://merchant.example/webhooks/coinkun",
  "user-data": {
    "title": "Order ORDER_ID",
    "merchant": "Example Store",
    "url": "https://merchant.example",
    "items": [
      {
        "name": "Example item",
        "qty": 1
      }
    ]
  },
  "linkback": "https://merchant.example/orders/ORDER_ID"
}'

{
  "amount": 250000,
  "currency": "ltc",
  "lifetime": 3600,
  "callback-url": "https://merchant.example/webhooks/coinkun",
  "user-data": {
    "title": "Order ORDER_ID",
    "merchant": "Example Store",
    "url": "https://merchant.example",
    "items": [
      {
        "name": "Example item",
        "qty": 1
      }
    ]
  },
  "linkback": "https://merchant.example/orders/ORDER_ID"
}

{
  "invoice": "INVOICE_ID",
  "account": "ACCOUNT_ID",
  "created": "2026-09-05T10:00:00Z",
  "currency": "ltc",
  "amount": 250000,
  "expire": "2026-09-05T11:00:00Z",
  "address": "LTC_ADDRESS",
  "callback-url": "https://merchant.example/webhooks/coinkun",
  "user-data": {
    "title": "Order ORDER_ID",
    "merchant": "Example Store"
  },
  "history": [
    {
      "date": "2026-09-05T10:00:00Z",
      "status": "created"
    }
  ],
  "linkback": "https://merchant.example/orders/ORDER_ID",
  "status": "created",
  "invoice-url": "https://coinkun.com/invoice?id=INVOICE_ID"
}

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

#Public Invoice Info

Planned

GET/invoices/{invoice}

Request

HTTP MethodGET
Content Typeapplication/json
URLhttps://coinkun.com/api/v1/invoices/{invoice}

Parameter	Type	Description	Required
`invoice`	string	Public invoice identifier.	Yes

curl --request GET "https://coinkun.com/api/v1/invoices/${INVOICE_ID}"

{
  "invoice": "INVOICE_ID",
  "created": "2026-09-05T10:00:00Z",
  "currency": "ltc",
  "amount": 250000,
  "expire": "2026-09-05T11:00:00Z",
  "address": "LTC_ADDRESS",
  "user-data": {
    "title": "Order ORDER_ID",
    "merchant": "Example Store"
  },
  "status": "created",
  "history": [
    {
      "date": "2026-09-05T10:00:00Z",
      "status": "created"
    }
  ],
  "linkback": "https://merchant.example/orders/ORDER_ID",
  "invoice-url": "https://coinkun.com/invoice?id=INVOICE_ID"
}

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

#Private Invoice Info

Planned

GET/accounts/{account}/invoices/{invoice}

Request

HTTP MethodGET
Content Typeapplication/json
URLhttps://coinkun.com/api/v1/accounts/{account}/invoices/{invoice}
Authorization
Bearer YOUR_ACCESS_TOKEN Planned

Parameter	Type	Description	Required
`account`	string	Public account identifier.	Yes
`invoice`	string	Invoice belonging to this account.	Yes
`transfer-key`	string	Required without an access token.	No

curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/invoices/${INVOICE_ID}" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}"

{
  "account": "ACCOUNT_ID",
  "invoice": "INVOICE_ID",
  "created": "2026-09-05T10:00:00Z",
  "currency": "ltc",
  "amount": 250000,
  "expire": "2026-09-05T11:00:00Z",
  "address": "LTC_ADDRESS",
  "user-data": {
    "title": "Order ORDER_ID"
  },
  "status": "created",
  "history": [
    {
      "date": "2026-09-05T10:00:00Z",
      "status": "created"
    }
  ],
  "callback-url": "https://merchant.example/webhooks/coinkun",
  "linkback": "https://merchant.example/orders/ORDER_ID",
  "invoice-url": "https://coinkun.com/invoice?id=INVOICE_ID"
}

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

#Invoices List

Planned

GET/accounts/{account}/invoices

Request

HTTP MethodGET
Content Typeapplication/json
URLhttps://coinkun.com/api/v1/accounts/{account}/invoices
Authorization
Bearer YOUR_ACCESS_TOKEN Planned

Parameter	Type	Description	Required
`account`	string	Public account identifier.	Yes
`transfer-key`	string	Required without an access token.	No
`q`	string	Comma-separated filters: status, date_from and date_to.	No
`limit`	integer	Page size; reference default is 10.	No
`offset`	integer	Zero-based offset.	No

curl --request GET "https://coinkun.com/api/v1/accounts/${ACCOUNT_ID}/invoices" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --get \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

{
  "account": "ACCOUNT_ID",
  "date_from": "2026-09-01T00:00:00Z",
  "date_to": "2026-09-05T23:59:59Z",
  "items": [
    {
      "invoice": "INVOICE_ID",
      "created": "2026-09-05T10:00:00Z",
      "currency": "ltc",
      "amount": 250000,
      "status": "created"
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 0,
    "limit": 10
  }
}

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

#Invoice Status

Planned

These states describe the target lifecycle. The current application does not observe invoice payments or perform these transitions.

Status	Meaning
created	Awaiting a payment.
partpaid	Observed payment is below the requested amount.
paid	Observed payment matches the requested amount.
overpaid	Observed payment exceeds the requested amount.
completed	The payment has met the confirmation policy.
expired	The payment window has ended.