Interface CustomerDeposit

Customer deposit information.

interface CustomerDeposit {
    accountId: string;
    action?: PaymentAction | DepositAction;
    amount: number;
    creationTime: string;
    currencyCode: string;
    customerId: string;
    deviceInfo?: DeviceInfo;
    expirationTime?: string;
    fees?: SimpleFeePayment[];
    fundingTransactionId?: string;
    id: string;
    merchantRefNum?: string;
    nextStatus?: PaymentStatus[];
    paymentInstrumentReference?: PaymentInstrumentReference;
    paymentOption: PaymentOptionType;
    paymentProperties?: PaymentProperty[];
    redirectUrl?: RedirectLink;
    returnUrls?: ReturnLink[];
    slipId?: string;
    status: PaymentStatus;
    statusReason?: string;
}

Properties

accountId action? amount creationTime currencyCode customerId deviceInfo? expirationTime? fees? fundingTransactionId? id merchantRefNum? nextStatus? paymentInstrumentReference? paymentOption paymentProperties? redirectUrl? returnUrls? slipId? status statusReason?

Properties

accountId

accountId: string

The account where the money gets deposited in. It deduced based on the currency.

Optional action

action?: PaymentAction | DepositAction

Specifies action required to complete to be able to continue to the next payment status.

For future compatibility, it's preferable to use PaymentAction enum.

amount

amount: number

Deposit amount in currency minor units.

creationTime

creationTime: string

Creation time.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2024-05-08T14:43:33Z"

currencyCode

currencyCode: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

customerId

customerId: string

Customer id.

Optional deviceInfo

deviceInfo?: DeviceInfo

Device information.

Optional expirationTime

expirationTime?: string

Expiration time.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2024-05-08T14:43:33Z"

Optional fees

fees?: SimpleFeePayment[]

Customer fees attached to the transaction.

Optional fundingTransactionId

fundingTransactionId?: string

Deposit Funding transaction id. Stored by Single API and used for Recon.

id

id: string

Deposit id generated during creation.

Optional merchantRefNum

merchantRefNum?: string

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system to embedded wallet objects.

Optional nextStatus

nextStatus?: PaymentStatus[]

Next possible status.

Optional paymentInstrumentReference

paymentInstrumentReference?: PaymentInstrumentReference

Payment instrument reference.

paymentOption

paymentOption: PaymentOptionType

Payment option type.

Optional paymentProperties

paymentProperties?: PaymentProperty[]

List of payment option specific properties.

Optional redirectUrl

redirectUrl?: RedirectLink

Link used to redirect the payment flow to hosted payment page.

Optional returnUrls

returnUrls?: ReturnLink[]

Links to redirect customer back during transaction flow.

Optional slipId

slipId?: string

Slip identifier. Slip contains list of transactions associated with the deposit operations.

status

status: PaymentStatus

Payment status.

Optional statusReason

statusReason?: string

Status reason for FAILED transaction.

Settings

Member Visibility

Theme

On This Page

accountIdactionamountcreationTimecurrencyCodecustomerIddeviceInfoexpirationTimefeesfundingTransactionIdidmerchantRefNumnextStatuspaymentInstrumentReferencepaymentOptionpaymentPropertiesredirectUrlreturnUrlsslipIdstatusstatusReason