PaymentMethod

The PaymentMethod object is a object that represents a payment method. It contains common properties that all payment methods share, such as the transfer method and the title. We can use different details to represent different payment methods, currently supporting Crypto, Bank, and Internal. Refer to the following definitions for the specific structure.

Field	Type	Description
title	string	The title or name of the payment method. This is typically a user-friendly name that helps identify the payment method.
transfer_method	string	The method of transfer for the payment. This could be via CRYPTO, BANK, or INTERNAL methods. See Supported Transfer Methods.
detail	object	The detail of the payment method. This could be a crypto address, bank account, or internal customer.

BankPaymentMethodDetail

The BankPaymentMethodDetail class is used to represent the details of a bank payment method. Depending on the network that the bank operates on, different fields within this class are utilized.

For the SEPA (Single Euro Payments Area) network, the iban and bic fields are used. The iban field represents the International Bank Account Number, a standard numbering system developed to identify overseas bank accounts. The bic field represents the Bank Identifier Code (also known as SWIFT code), which is used to identify banks worldwide.
For the Fedwire network, which is a real-time gross settlement funds transfer system operated by the United States Federal Reserve Banks, the account_number and routing_number fields are used. The account_number is the unique identifier of the individual account at the bank, and the routing_number is a nine-digit code used to identify the financial institution in a transaction.
For the Swift network, for numeric accounts, the account_number and bic fields are used, for IBAN accounts, the iban and bic fields are used.

This object provides a flexible way to handle different bank payment methods by using different combinations of fields based on the specific requirements of the bank network.

Field	Type	Description
network	string	The network on which the bank operates. This could be BANK_SEPA, BANK_SWIFT, etc. See Supported Bank Networks.
asset_type	string	The type of currency for the bank payment. This could be USD, EUR, GBP, etc. See Supported Currencies.
account_number	string	The account number of the bank account.
iban	string	The International Bank Account Number (IBAN) of the bank account.
bic	string	The Bank Identifier Code (BIC) or SWIFT code of the bank.
routing_number	string	The routing number of the bank.
bank_identifier	string	The bank_identifier is a universal banking code used to store various regional bank identifiers. For example, it can be used to store the UK sort code or the Australian BSB code.
reference	string	The reference for the bank payment.
bank_name	string	The name of the bank.
bank_address	string	The address of the bank.
bank_country	string	The country code of the bank.
intermediary_bank_name	string	The name of the intermediary bank, if any.
intermediary_account_number	string	The account number of the intermediary bank, if any.
intermediary_bic	string	The BIC or SWIFT code of the intermediary bank, if any.

EUR-SEPA

USD-Fedwire

USD-Swifit

CryptoPaymentMethodDetail

The CryptoPaymentMethodDetail object is used to handle cryptocurrency payment methods by providing necessary details such as the network, asset type, and the wallet address.

Field	Type	Description
network	string	Represents the network on which the cryptocurrency operates. This could be `NETWORK_BTC`, `NETWORK_ETH`, etc. See Supported Crypto Networks.
asset_type	string	Represents the type of cryptocurrency asset. This could be `BTC`, `ETH`, `USDT`, `USDC`, etc. See Supported Currencies .
address	string	Represents the address of the cryptocurrency wallet. This is where the funds will be sent.

InternalPaymentMethodDetail

The InternalPaymentMethodDetail class is used to handle internal payment methods by providing necessary details such as the asset type and the UID.

Field	Type	Description
asset_type	string	Represents the type of asset. See Supported Currencies .
uid	string	UID is the numerical identifier of the customer.