Skip to main content

DepositStatusUpdateRequest

Object containing status update request for Deposit.

    status PaymentStatus (string)required

    Possible values: [PENDING, PROCESSING]

    paymentProperties

    object[]

    List of payment option specific properties required for processing of the payment.

  • Array [

  • key PaymentPropertyKey (string)

    Possible values: [CARD_CVV, CARD_SAVE_INSTRUMENT]

    Payment property key. Defines available payment property key and their meaning.

    Card payment properties:

    • CARD_CVV - Card CVV is required to confirm the card payment during deposit.
      • Valid value: 123
    • CARD_SAVE_INSTRUMENT - The user agrees to save the card for further payments.
      • Valid value: true
    value string
  • ]

  • paymentInstrument

    object

    Represents Payment Instrument, used for Deposit or Withdrawal. Here are the valid instrumentType values:

    id string

    The instrument id

    customerId string

    Customer to which this instrument belongs.

    instrumentType

    string

    required

    Possible values: [CARD, SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT]

    Instrument type.

    ValueDescription
    SEPA_BANK_ACCOUNTSEPA Bank account
    UK_BANK_ACCOUNTUK Bank account
    US_BANK_ACCOUNTUS Bank account
    CCI_BANK_ACCOUNTCCI Bank account
    CARDCard
    pan stringrequired

    Card Number

    cardHolderName string

    Possible values: <= 160 characters

    Card holder name.

    bankName string

    Bank name.

    expiryDate

    object

    required

    Card expiry date.

    year integerrequired
    month integerrequired
    cardScheme CardScheme (string)

    Possible values: [VISA, MC]

    Card scheme information.

    • VISA - VISA
    • MC - Mastercard The scheme is derived from the card PAN.
    description string

    Possible values: <= 20 characters

    Name to be associated with the card.

    externallyVerified booleandeprecated

    Is the instrument externally verified. The property is not returned by the API anymore.

    status string

    Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

    Instrument status.

    creationTime date-time

    Represents RFC 3339, section 5.6 date-time.