Skip to main content

CustomerDepositRequest

Structure for initiating customer facing deposit.

    amount int64required

    Deposit amount in currency minor units.

    currencyCode Currency (string)required

    Possible values: >= 3 characters and <= 3 characters

    Currency alphabetic code as specified by ISO 4217

    paymentInstrumentReference

    object

    Represents a reference to Payment Instrument, used for Deposit or Withdrawal.

    id stringrequired

    Instrument identifier.

    instrumentType InstrumentType (string)required

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

    Instrument type.

    | 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 |

    merchantRefNum MerchantReferenceNumber (string)

    Possible values: <= 255 characters

    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.

    returnUrls

    object[]

    Links to redirect customer back during transaction flow.

  • Array [

    • rel ReturnLinkType (string)

    Possible values: [DEFAULT, ON_COMPLETED, ON_FAILED, ON_CANCELLED]

    Default value: DEFAULT

    The link rel defines a semantic of the merchant url to redirect the payment flow.

    DEFAULT - The default return URL that will be used if specific status return URL is not defined or can not be determined. ON_COMPLETED - Paysafe will return to this merchant url post succefull payment authorisation. ON_FAILED - Paysafe will return to this merchant url post if the authorisation failed. ON_CANCELLED - Paysafe will return to this merchant url post if payment is cancelled in PSP.

    href string

    The url to be used for further actions.

    method HttpRequestMethod (string)

    Possible values: [GET, POST]

    HTTP request method.

  • ]

    • paymentProperties

    object[]

    List of payment option specific properties.

  • 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

  • ]

    • paymentOption CustomerPaymentOptionType (string)required

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

    Payment option requested by customer.