The Payment object is the core entity for handling various external payment transactions within the system. It standardizes payment processes, whether they involve blockchain transfers, bank transactions, or internal account movements. By using a unified destination structure, the Payment object ensures consistent management of diverse payment methods. This flexibility supports current and future transfer types, streamlining integration and operational efficiency for developers.

For detailed information on the Payment object fields and their descriptions, refer to the sections below.

Field	Type	Description
id	string	The unique identifier for the payment.
customer_id	string	The unique identifier for the customer associated with the payment.
transfer_method	string	The method used for the transfer. See Supported Transfer Methods.
network	string	The network code specifying the blockchain network or bank transfer network. See Supported Blockchain Networks or Bank Networks.
asset_type	string	The type of asset used in the payment (e.g., BTC, ETH, USDT, USD, EUR). See Supported Currencies.
from_account_id	string	The account ID from which the payment is made.
destination	object	The structured payment destination object, which can include a blockchain address, bank account, or internal account. This field is designed to support multiple transfer methods and can be extended to include more methods in the future.
amount	float	The amount of the payment.
fee	float	The fee associated with the payment.
total_amount	float	The total amount of the payment, including fees.
reference	string	The reference for the payment, typically used for bank transfer identification.
reason	string	The reason for the payment, indicating the purpose or context of the transaction. See Payment Reasons.
note	string	Additional notes or remarks related to the payment.
status	string	The current status of the payment (e.g., Pending, Canceled, Confirmed, Approved, Rejected, Success, Fail). See Payment Status.
create_time	datetime	The timestamp indicating when the payment was created.
update_time	datetime	The timestamp indicating when the payment was last updated.

BlockchainAddress Destination

Field	Type	Description
address	string	The blockchain address to which the payment will be sent.
network	string	The network code specifying the blockchain network. Supported Blockchain Networks

Example

{
	"network": "NETWORK_TRX",
	"address": "TR5wKGkCk9inZhZx6qRegfxFynaZLT4Rfu"
}

BankAccount Destination

Field	Type	Description
network	string	The network code specifying the banking network (e.g., BANK_SWIFT).See Supported Bank Networks .
beneficiary_name	string	The name of the beneficiary receiving the payment.
beneficiary_address	string	The address of the beneficiary.
beneficiary_city	string	The city where the beneficiary is located.
beneficiary_state	string	The state or province where the beneficiary is located.
beneficiary_country	string	The country where the beneficiary is located.
beneficiary_zipcode	string	The postal code of the beneficiary's address.
iban	string	The International Bank Account Number (IBAN) of the beneficiary.
bic	string	The Bank Identifier Code (BIC) or SWIFT code of the beneficiary's bank.
account_number	string	The account number of the beneficiary (if applicable).
routing_number	string	The routing number of the beneficiary's bank (if applicable).
reference	string	A reference for the payment, typically used for identification purposes.
bank_name	string	The name of the beneficiary's bank.
bank_address	string	The address of the beneficiary's bank.
bank_country	string	The country where the beneficiary's bank is located.
intermediary_bank_name	string	The name of the intermediary bank (if applicable).
intermediary_account_number	string	The account number of the intermediary bank (if applicable).
intermediary_bic	string	The BIC or SWIFT code of the intermediary bank (if applicable).

Example

{
	"network": "BANK_SWIFT",
	"beneficiary_name": "TEST COMPAMY PTE. LTED.",
	"beneficiary_address": "TEST ADDRESS",
	"beneficiary_city": "City",
	"beneficiary_state": "State",
	"beneficiary_country": "LT",
	"beneficiary_zipcode": "999999",
	"iban": "LT20TCCL04140460000000",
	"bic": "MRMDUS33",
	"account_number": null,
	"routing_number": null,
	"reference": null,
	"bank_name": "TEST BANK LTD",
	"bank_address": "Address, Bank Street",
	"bank_country": "LT",
	"intermediary_bank_name": null,
	"intermediary_account_number": null,
	"intermediary_bic": null
}

InternalAccount Destination

Field	Type	Description
id	string	The unique identifier for the internal account payment destination.
owner_id	string	The unique identifier of the account owner.
asset_type	string	The type of asset for the account (e.g., BTC, EUR, USD). See Supported Currencies .
account_number	string	The account number within the internal system.
friendly_name	string	A user-friendly name for the account, often combining asset type and account number for easy identification.

Example

{
	"id": "1556b664-218d-4bba-982c-8bdcc7785ec3",
	"owner_id": "d53d9702-163b-4c59-bbdc-7f9ab8208752",
	"asset_type": "EUR",
	"account_number": "2001003",
	"friendly_name": "EUR-2001003"
}