Interface Transfer

The transfer object.

interface Transfer {
    createdAt: string;
    fees: Fee[];
    id: string;
    source: PaymentMethodRequest;
    sourceAmount: string;
    sourceCurrency: string;
    sourceType: "payment_method";
    status: TransferStatus;
    target: CryptoRailAddress;
    targetAmount: string;
    targetCurrency: string;
    targetType: "crypto_rail";
    transactionHash?: string;
    updatedAt: string;
    userAmount: string;
    userCurrency: string;
}

Properties

createdAt fees id source sourceAmount sourceCurrency sourceType status target targetAmount targetCurrency targetType transactionHash? updatedAt userAmount userCurrency

Properties

createdAt

createdAt: string

The UTC date and time in ISO 8601 format the transfer was created.

fees

fees: Fee[]

The fees for the transfer.

id

id: string

The ID of the transfer.

Pattern

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

source

source: PaymentMethodRequest

The source of the transfer.

sourceAmount

sourceAmount: string

The amount the source will transfer.

sourceCurrency

sourceCurrency: string

The currency the source will transfer.

sourceType

sourceType: "payment_method"

The type of the source of the transfer.

status

status: TransferStatus

The status of the transfer.

target

target: CryptoRailAddress

The target of the transfer.

targetAmount

targetAmount: string

The amount the target will receive.

targetCurrency

targetCurrency: string

The currency the target will receive.

targetType

targetType: "crypto_rail"

The type of the target of the transfer.

OptionaltransactionHash

transactionHash?: string

The transaction hash or transaction signature of the transfer.

updatedAt

updatedAt: string

The UTC date and time in ISO 8601 format the transfer was updated.

userAmount

userAmount: string

The amount the customer put in to transfer.

userCurrency

userCurrency: string

The currency the customer put in to transfer.

Settings

Member Visibility

On This Page

Properties