Skip to main content
GET
/
v1
/
public
/
invoices
/
{token}
/
status
Poll invoice payment status
curl --request GET \
  --url https://api.example.com/v1/public/invoices/{token}/status \
  --header 'X-Api-Id: <api-key>' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Signature: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "paymentStatus": "<string>",
  "receivedAmount": "<string>",
  "confirmations": 123,
  "requiredConfirmations": 123,
  "txhash": "<string>",
  "explorerTxUrl": "<string>",
  "paidAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Id
string
header
required

Публичный идентификатор API-ключа

​
X-Api-Key
string
header
required

Публичный API-ключ

​
X-Signature
string
header
required

HMAC-SHA256-Hex(timestamp + "." + raw_body, api_secret)

​
X-Timestamp
string
header
required

Unix-секунды, ±300с

Path Parameters

​
token
string
required

Публичный токен из ссылки счёта.

Response

200 - application/json
​
state
enum<string>
required
Available options:
pending,
detected,
paid,
overpaid,
underpaid,
expired
​
paymentStatus
string
required
​
receivedAmount
string | null
required
​
confirmations
number | null
required
​
requiredConfirmations
number
required
​
txhash
string | null
required
​
explorerTxUrl
string | null
required
​
paidAt
string<date-time> | null
required
​
expiresAt
string<date-time>
required