Types

List of available API types.

Table of contents:

Name	Type	Description	Required
id	`int`	id of the payment	yes
hash_id	`string`	hash id of the payment	yes
created_at	`int`	payment creation time (unix)	yes
expires_at	`int`	payment expiration time (unix)	yes
paid_at	`int`	payment time (unix)	no
test	`bool`	testnet payment	yes
title	`string`	title of the payment	yes
description	`string`	description of the payment (empty if not provided)	yes
currency	`string`	currency of the payment (USD, TON etc)	yes
amount	`string`	amount of the payment as an integer in nanos	yes
status	`string`	status of the payment (pending, successful, failed)	yes
fail_reason	`string`	reason of failure (empty if not failed)	yes
payload	`string`	payload of the payment (empty if not provided)	yes
comment	`string`	comment of the payment	yes
to_pay_currency	`string`	selected payment currency	no
to_pay_amount	`string`	selected payment currency amount (in nanos)	no
to_pay_date	`int`	selected payment time (unix)	no
exchange_rate	`string`	payment exchange rate (in nanos)	no
sender_address	`string`	sender wallet address	no
receiver_address	`string`	receiver wallet address	no
redirect_url	`string`	url to redirect after payment (successful or failed)	no
url	`string`	checkout url	yes
blockchain_transactions	`string`	payment transactions (separated by coma)	no
methods	`array of PaymentMethodResult`	payment methods	yes

# Types