Skip to main content

DepositInformation

Deposit common information.

    id stringrequired

    Deposit id generated during creation.

    customerId stringrequired

    Customer id.

    accountId stringrequired

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

    slipId string

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

    fundingTransactionId string

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

    creationTime date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    expirationTime date-time

    Represents RFC 3339, section 5.6 date-time.

    status Payment Status (string)required

    Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, REFUNDED]

    The payment status:

    • PREVIEW - Payment preview.
    • PENDING - Payment transaction is created and further action is required by the customer.
    • PROCESSING - Payment is scheduled for processing by the payment provider.
    • COMPLETED - Payment is completed. Note that some transactions might be completed from Embedded Wallet point of view, but not from customer point of view, since money movement might take some time outside of the Embedded Wallet network.
    • FAILED - Payment has failed. Check STATUS_REASON property for details.
    • CANCELLED - Payment have been cancelled
    • REFUNDED - Valid only for deposits.
    statusReason string

    Possible values: <= 60 characters

    Status reason for FAILED transaction.

    nextStatus Payment Status (string)[]

    Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, REFUNDED]

    Provides the next possible status update the client can request, depending on the chosen payment type and option.

    action Payment Action (string)

    Possible values: [NONE, REDIRECT, SCA]

    Default value: NONE

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

    • NONE – No action is required, you can proceed to the next deposit status.
    • REDIRECT – The user must be redirected in order to complete a payment, for example, when an alternate payment method like Paysafecard is used.
    • SCA - The user must complete a Strong Customer Authentication (SCA) process.

    redirectUrl

    object

    Links used to redirect the payment flow to hosted payment page. The property rel defines the link type semantic.

    rel RedirectLinkType (string)

    Possible values: [REDIRECT_PAYMENT]

    Default value: REDIRECT_PAYMENT

    The link rel defines the redirect link semantic.

    • REDIRECT_PAYMENT - Merchant needs to redirect consumer to this url to complete payment.
    href string

    The url to be used for further actions.

    method HttpRequestMethod (string)

    Possible values: [GET, POST]

    HTTP request method.

    paymentOption PaymentOptionType (string)

    Possible values: [RAPID_TRANSFER, BANK_TRANSFER, OFFLINE_BANK_TRANSFER, CARD, PAYSAFECASH, PAGO_EFECTIVO]

    Enumeration of supported Payment Option Types

    refundable boolean

    Is the deposit refundable.