Skip to main content

DepositStatusUpdateRequest

Object containing status update request for Deposit.

statusPaymentStatus (string)required

Possible values: [PENDING, PROCESSING, CANCELLED, SCHEDULED, ACCEPTED]

Example: PENDING
paymentProperties object[]

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

  • Array [
    • keyPaymentPropertyKey (string)

    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
    • PAYMENT_CONFIRMATION - For PCI-DSS level 3 partners card information is collected in Paysafe hosted interface. |Valid values|Description| |---|---| |EMBEDDED|Default The payment is confirmed in the hosted Paysafe interface | |OUTSOURCED| The payment flow is returned to caller after collection of card data|
    • CARRIER - Specifies the carrier(s) for the payment flow, used to define the payment target when the payment instrument cannot uniquely identify it. The user must choose from a predefined list of carriers provided by the payment provider.

    Possible values: [CARD_CVV, CARD_SAVE_INSTRUMENT, SAVE_RECIPIENT, PAYMENT_CONFIRMATION, CARRIER]

    valuestring

    The value of the payment property.

  • ]
    • paymentInstrument object

    Represents a payment instrument, used for Deposit or Withdrawal. Here are the valid instrumentType values:

    idstring

    The instrument id

    customerIdstring

    The customer to which this instrument belongs.

    Example: 5435323362
    instrumentTypeInstrumentType (string)required

    Represents the type of the instrument.

    | Value | Description| |---|---| | SEPA_BANK_ACCOUNT| SEPA Bank account | | UK_BANK_ACCOUNT | UK Bank account | | US_BANK_ACCOUNT | US Bank account | | CCI_BANK_ACCOUNT | CCI Bank account | | CARD | Card |

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

    Example: CARD
    externallyVerifiedboolean

    Is the instrument externally verified.

    Default value: false
    statusstring

    The instrument status.

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

    creationTimedate-time

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
    DepositStatusUpdateRequest
    {
      "status": "PENDING",
      "paymentProperties": [
        {
          "key": "CARD_CVV",
          "value": "string"
        }
      ],
      "paymentInstrument": {
        "id": "string",
        "customerId": "5435323362",
        "instrumentType": "CARD",
        "externallyVerified": false,
        "status": "VERIFIED",
        "creationTime": "2021-07-15T17:54:12Z"
      }
    }