Skip to main content

Create deposit

POST 
/v2/customers/:customerId/deposits

Create deposit for the customer passed in the request path.

Deposits are created in PREVIEW state.

The following parameters are required:

  • currency - deposit currency
  • amount - deposit amount in currency minor units
  • paymentOption - deposit payment option must be one of the available payment options provided by GET /v2/customers/{customerId}/deposits/options
  • deviceInfo - should provide valid appType and profiling session id.

Optional parameters:

  • merchantRefNum - should be provided by the partner to match with objects in his backend system.
  • paymentInstrumentReference - provide reference to existing verified payment instrument provided by GET /v1/customers/{customerId}/instruments

Deposits in PREVIEW state do not create actual transaction in Paysafe Wallet system. It allows to check deposit parameters and display the fees.

To move the payment forward you must request status change using POST /v2/customers/{customerId}/deposits/{depositId}/status. This will perform the required validations and move the deposit in PENDING state. This will create a PENDING transaction that can be screened and executed.

{
   "status": "PENDING"
}

To confirm the deposit for execution use POST /v2/deposits/{id}/status:

{
   "status": "PROCESSING"
}

Request​

Path Parameters

    customerId stringrequired

    Id of the customer.

Body

required

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

    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 |

    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.

    deviceInfo

    object

    Provides information about the device that the end-customer uses to access the service.

    appType stringrequired

    Possible values: [WEB_APP, MOBILE_APP, API]

    threatMetrixSessionId string

    Possible values: <= 100 characters

    ThreatMetrics session id.

    customerIp string

    Customer IP Address.

    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 cannot be determined. ON_COMPLETED - Paysafe will return to this merchant url post succeful 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, SAVE_RECIPIENT, PAYMENT_CONFIRMATION]

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

    The value of the payment property.

  • ]

    • paymentOption CustomerPaymentOptionType (string)required

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

    Payment option requested by customer.

    fees

    object[]

    Customer fees attached to the transaction.

  • Array [

    • amount int64required

    Default value: 0

    Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

    currency Currency (string)

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

    Currency alphabetic code as specified by ISO 4217

    paymentReason FeePaymentReason (string)required

    Possible values: [MERCHANT_FEE, ATM_FEE, FX_FEE, PAYSAFE_FEE, OTHER_FEE, SENDER_FEE, RECIPIENT_FEE, DEPOSIT_FEE, WITHDRAWAL_FEE]

    Default value: OTHER_FEE

    Fee payment reason.

    • SENDER_FEE - Fee that will be applied to sender party of transfer collected into partner merchant wallet.
    • RECIPIENT_FEE - Fee that will be applied to recipient client of transfer collected into partner merchant wallet.
    • DEPOSIT_FEE - Fee charged for deposit transactions collected into partner merchant wallet.
    • WITHDRAWAL_FEE - Fee charged for withdrawal transactions collected into partner merchant wallet.
    • MERCHANT_FEE - Fee for the payment service collected into partner merchant wallet.
    • PAYSAFE_FEE - Fee collected by Paysafe for the provided payment service. Usually Paysafe Fee is not directly applied to customer transactions.
    • ATM_FEE - Fee for ATM service, when using prepaid cards.
    • FX_FEE - Fee applied, when payment requires currency exchange.
    • OTHER_FEE - It could be used for any additional, unspecified fees that may be applied to a transaction
    merchantId string

    The target merchant wallet id.

    recipientCurrency Currency (string)

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

    Currency alphabetic code as specified by ISO 4217

    merchantAccountId string

    The target account in which the payment is accepted. If not specified the account is determined by the main transaction currency.

  • ]

Responses​

Created

Schema

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

    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 |

    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 cannot be determined. ON_COMPLETED - Paysafe will return to this merchant url post succeful 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, SAVE_RECIPIENT, PAYMENT_CONFIRMATION]

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

    The value of the payment property.

  • ]

    • id stringrequired

    Deposit id generated during creation.

    customerId stringrequired

    Customer id.

    accountId stringrequired

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

    slipId string

    Slip identifier. Slip contains list of transactions associated with the deposit 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 - Payment has been 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

    The redirect link defines the link 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.

    paymentDetails

    object[]

    List of payment-option-specific details.

  • Array [

    • key PaymentDetailsKey (string)

    Possible values: [PAYSAFECASH_BARCODE_TYPE, PAYSAFECASH_BARCODE_VALUE]

    Defines the available payment details keys and their meaning.

    Paysafecash-specific details:

    • PAYSAFECASH_BARCODE_TYPE - The type of the generated barcode, when using the Paysafecash payment option.
      • Valid value: CODE128
    • PAYSAFECASH_BARCODE_VALUE - The value of the generated barcode, when using the Paysafecash payment option.
      • Valid value: 1000000000000004574
    value string

  • ]

    • fees

    object[]

    Customer fees attached to the transaction.

  • Array [

    • amount int64required

    Default value: 0

    Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

    currency Currency (string)

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

    Currency alphabetic code as specified by ISO 4217

    paymentReason FeePaymentReason (string)required

    Possible values: [MERCHANT_FEE, ATM_FEE, FX_FEE, PAYSAFE_FEE, OTHER_FEE, SENDER_FEE, RECIPIENT_FEE, DEPOSIT_FEE, WITHDRAWAL_FEE]

    Default value: OTHER_FEE

    Fee payment reason.

    • SENDER_FEE - Fee that will be applied to sender party of transfer collected into partner merchant wallet.
    • RECIPIENT_FEE - Fee that will be applied to recipient client of transfer collected into partner merchant wallet.
    • DEPOSIT_FEE - Fee charged for deposit transactions collected into partner merchant wallet.
    • WITHDRAWAL_FEE - Fee charged for withdrawal transactions collected into partner merchant wallet.
    • MERCHANT_FEE - Fee for the payment service collected into partner merchant wallet.
    • PAYSAFE_FEE - Fee collected by Paysafe for the provided payment service. Usually Paysafe Fee is not directly applied to customer transactions.
    • ATM_FEE - Fee for ATM service, when using prepaid cards.
    • FX_FEE - Fee applied, when payment requires currency exchange.
    • OTHER_FEE - It could be used for any additional, unspecified fees that may be applied to a transaction
    merchantId string

    The target merchant wallet id.

    recipientCurrency Currency (string)

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

    Currency alphabetic code as specified by ISO 4217

    merchantAccountId string

    The target account in which the payment is accepted. If not specified the account is determined by the main transaction currency.

    fxAmount

    object

    (In Development)

    Contains the amount in converted currency during currency conversion.

    amount integer

    Converted amount (in minor units).

    rate number

    Currency conversion rate.

    currency Currency (string)

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

    Currency alphabetic code as specified by ISO 4217

  • ]

Loading...