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.

FieldTypeDescription
idstringThe unique identifier for the payment.
customer_idstringThe unique identifier for the customer associated with the payment.
transfer_methodstringThe method used for the transfer. See Supported Transfer Methods.
networkstringThe network code specifying the blockchain network or bank transfer network. See Supported Blockchain Networks or Bank Networks.
asset_typestringThe type of asset used in the payment (e.g., BTC, ETH, USDT, USD, EUR). See Supported Currencies.
from_account_idstringThe account ID from which the payment is made.
destinationobjectThe 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.
amountfloatThe amount of the payment.
feefloatThe fee associated with the payment.
total_amountfloatThe total amount of the payment, including fees.
referencestringThe reference for the payment, typically used for bank transfer identification.
reasonstringThe reason for the payment, indicating the purpose or context of the transaction. See Payment Reasons.
notestringAdditional notes or remarks related to the payment.
statusstringThe current status of the payment (e.g., Pending, Canceled, Confirmed, Approved, Rejected, Success, Fail). See Payment Status.
create_timedatetimeThe timestamp indicating when the payment was created.
update_timedatetimeThe timestamp indicating when the payment was last updated.

BlockchainAddress Destination

FieldTypeDescription
addressstringThe blockchain address to which the payment will be sent.
networkstringThe network code specifying the blockchain network. Supported Blockchain Networks

Example

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

BankAccount Destination

FieldTypeDescription
networkstringThe network code specifying the banking network (e.g., BANK_SWIFT).See Supported Bank Networks .
beneficiary_namestringThe name of the beneficiary receiving the payment.
beneficiary_addressstringThe address of the beneficiary.
beneficiary_citystringThe city where the beneficiary is located.
beneficiary_statestringThe state or province where the beneficiary is located.
beneficiary_countrystringThe country where the beneficiary is located.
beneficiary_zipcodestringThe postal code of the beneficiary's address.
ibanstringThe International Bank Account Number (IBAN) of the beneficiary.
bicstringThe Bank Identifier Code (BIC) or SWIFT code of the beneficiary's bank.
account_numberstringThe account number of the beneficiary (if applicable).
routing_numberstringThe routing number of the beneficiary's bank (if applicable).
referencestringA reference for the payment, typically used for identification purposes.
bank_namestringThe name of the beneficiary's bank.
bank_addressstringThe address of the beneficiary's bank.
bank_countrystringThe country where the beneficiary's bank is located.
intermediary_bank_namestringThe name of the intermediary bank (if applicable).
intermediary_account_numberstringThe account number of the intermediary bank (if applicable).
intermediary_bicstringThe 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

FieldTypeDescription
idstringThe unique identifier for the internal account payment destination.
owner_idstringThe unique identifier of the account owner.
asset_typestringThe type of asset for the account (e.g., BTC, EUR, USD). See Supported Currencies .
account_numberstringThe account number within the internal system.
friendly_namestringA 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"
}