DepositUpdateObject

eventTypePaymentEventType (string)required

Enumerations holding the supported payment event types. Each specific event relates to specific payment type and a state change of the payment object.

Possible values: [TRANSFER_UPDATE, DEPOSIT_UPDATE, WITHDRAWAL_UPDATE]

Example: TRANSFER_UPDATE

paymentDetails object[]

List of payment-option-specific details.

Array [

keyPaymentDetailsKey (string)

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

Possible values: [PAYSAFECASH_BARCODE_TYPE, PAYSAFECASH_BARCODE_VALUE]

Example: PAYSAFECASH_BARCODE_TYPE

valuestring

]

statusPayment Status (string)required

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.
SCHEDULED - Payment is scheduled funds are blocked, but some action is required. Check action response object property for details
ACCEPTED - Payment has been accepted by the recipient and will be automatically processed.

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

Example: FAILED

nextStatusPayment Status (string)[]

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

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

statusReasonTransactionStatusReason (string)

Provided if the transaction is not successful.

INSUFFICIENT_FUNDS - Customer has insufficient funds for the operation.
RISK_ENGINE_DECLINE - Fraud suspected.
CUSTOMER_RESTRICTED - Customer is restricted.
DW-TRANSFER-NOT-ENOUGH-BALANCE - The sending customer has insufficient balance for the transaction.
DW-TRANSFER-NOT-ALLOWED - Either sender or recipient are restricted for transfers.
DW-SCHEDULED-TRANSFER-DUPLICATION - A scheduled transfer between the customers already exists.
DW-NO-SUCH-CUSTOMER - No customer matching the provided customerId was found.
DW-TRANSFER-LIMIT-EXCEEDED - The sending customer exceeds/has exceeded their transfer limit.
DW-TRANSFER-GENERAL-ERROR - Unexpected error occurred during transfer processing.
DW-TRANSFER-NOT-ENOUGH-BALANCE - The sending customer has insufficient balance for the transaction.
DW-TRANSFER-DUPLICATED-MERCHANT-REF - Duplicate merchant reference provided.
DW-TRANSFER-INVALID-CURRENCY - Transfer requested with invalid currency code.
DW-TRANSFER-BELOW-MIN-LIMIT - The sending customer fails to meet minimum transfer limit.
EXTERNAL_PROCESSING_GATEWAY_SYSTEM_ERROR - The external processing gateway has reported a system error.
ACTION_REQUIRED - Action required on recipient account.
PENDING_KYC - Waiting for customer to complete KYC.
PENDING_REVIEW - Transaction is subject to manual review.
PENDING_SCREENING - Pending transaction screening.
RECIPIENT_ACTION_REQUIRED - Recpient must accept trasnaction before processing it.
PENDING_THIRTY_MINUTES_LAG - Regulatory 30 minutes delay beofre transaction processing.
WAITING_FOR_RECIPIENT_ACCOUNT - Recipient is not registered yet.
DW-DEPOSIT-PROVIDER-ERROR - Payment provider error while processing the transaction.
DW-DEPOSIT-NOT-CONFIRMED - The deposit has not been confirmed.
DW-UNSUPPORTED-BANK - Bank is not supported by the payment provider.
DW-DEPOSIT-BANK-CHANGE-NOT-ALLOWED - Customer tried to change the payment bank.
DW-DEPOSIT-AUTH-FAILED - Customer authentication at provider have failed.
DW-DEPOSIT-BANK-UNAVAILABLE - Payment bank was not available.
DW-DEPOSIT-LIMIT-EXCEEDED - Deposit limits reached.
DW-DEPOSIT-ACCOUNT-MISMATCH - Account mismatch at payment provider.
DW-DEPOSIT-INVALID-USER-INPUT - Customer provided invalid input.
DW-DEPOSIT-ACCOUNT-NOT-FOUND - Payment provider did not found customer account.
DW-BANK-DECLINE - Declined by the processing bank.
DW-DEPOSIT-PENDING-CONFIRMATION - Customer did not confirm the deposit.
DW-DEPOSIT-ATTEMPT-LIMIT-EXCEEDED - Customer achieved deposit attempt limits.
CARD_CANCELLED - Card is cancelled. This status is irreversible. Customer needs to get a new card and try again.
CARD_SUSPENDED - Card needs to be reactivated by Paysafe staff.
CARD_NOT_ACTIVE - Activate the card and try again. Applicable for physical cards only.
CARD_LOST - Card is with status Lost which is a final status. The merchant should retain the card.
CARD_STOLEN - An attempt with a card in status 'Stolen' was made. Merchant needs to retain the card.
CARD_EXPIRED - A payment attempt was made with an expired card.
CARD_LOCKED - Cardholder to unlock the card and try again.
EXPIRY_DATE_MISSING - Merchant acquirer did not include Expiry date in the authorization.
CARDHOLDER_AUTHENTICATION_MISSING - There was no authentication method provided by the merchant. Cardholder to attempt a CHIP and PIN payment for card-present transactions.
TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER - The customer attempted to perform a transaction that is not supported by the setup of this card. This is most commonly caused attempts to make a purchase with cashback transaction which is not supported at present.
CHIP_AND_PIN_REQUIRED - The payment needs to be authenticated with CHIP and PIN.
CHIP_AND_PIN_ACTIVATION_REQUIRED - Digital First cards require that the cardholder perform a successful CHIP and PIN transaction before they can use their card for cardpresent purchases. Cadholder can use the card for only ecommerce transactions in the meantime.
LIMITS_VIOLATION_AMOUNT - The cardholder exceeded the total transactions amount for the specific period. Cardholder to be educated for amount limits and asked to try again later. N.B: These are rolling limits. E.g. if amout limits is 100 USD and a cardholder makes a 10 USD payment at 1 AM, their remaining limits will be 90 USD until 1AM on the next day.
LIMITS_VIOLATION_VELOCITY - The cardholder exceeded the maximum number of transactions for the specific period. Cardholder to be educated for velocity limits and asked to try again later. N.B: These are rolling limits. E.g. if cardholders makes a 1 transaction at 1 AM and his velocity limits is 10, the velocity limit will be reduced to 9 until 1AM on the next day.
PIN_TRIES_EXCEEDED - Cardholder exceeded the wrong PIN attempts on POS or ATM. The failed PIN counter will be reset back to zero automatically after 24 hours. PIN blocked on POS can be reset within the 24-hours window, if the customer confirms correct PIN on ATM.
WRONG_CVV - Payment was declined by the card scheme. Most oftern because the CVV on the back of the card was not read correctly. Cardholder may try again.
RESTRICTED_MCC - Transactions with this Merchant Category Code (MCC) are not allowed.
WRONG_EXPIRATION_DATE - The card's expiry date has passed, or the value provided by the merchant does not match the value on record.
CVV_TRIES_EXCEEDED - The cardholder exceeded the maximum number of wrong CVV attempts. Please contact Paysafe for details.
SCA_REQUIRED_CURRENCY_MISMATCH - Cardholder needs to complete SCA again as the merchant acquirer sent an authorization for currency different than the currency of the original authentication. Such transactions will normally be declined and customer may try again.
SCA_RETRY_REQUIRED - Cardholder needs to complete SCA again as the merchant acquirer sent an authorization for amounts that is at least 20% higher than the amount provided during the 3Ds authentication.
RETAIN_CARD - Our processing partner have risk concerns and have advised the ATM provider to retain the card. Cancel the card and ask the consumer to order a new one.
INVALID_PIN - Cardholder to check their PIN and try again.
FORMAT_ERROR - The processing partner could not recognize the transaction as a result of wrongly formatted payment details. Cardholder to confirm their card details and try again.
DO_NOT_HONOR - This is a general decline. Please check that the account and card are in good standing.
AUTH_EXPIRED - The authorization for this payment has expired as clearing was not received within the expected time frame.
CARD_NOT_FOUND - An attempts for invalid card number was received. Normally linked to BIN attacks. Please contact Paysafe`s staff in case you see a spike in these attempts.
WITHDRAWAL_RESTRICTED - The account linked cannot perform outgoing transactions. Normally applied due to risk concerns. Please do not share with cardholder and contact us for details.
DEPOSIT_RESTRICTED - The account linked cannot perform incoming transactions. Normally applied due to risk concerns. Please do not share with cardholder and contact us for details.
TEST_USER - A test user attempted to perform a transaction on production environment.
MERCHANT_COUNTRY_NOT_SUPPORTED - Merchant country is not supported.
GAMBLING_BLOCK_ENABLED - Gambling transactions are not allowed.
ONLINE_GAMBLING_NOT_SUPPORTED - Transactions to merchants in this country are not allowed. Such declines normally appear when cardholders try to use their cards for payments to gambling merchants in countries where online gambling is not allowed.
INSTALLMENT_TRANSACTION - The merchant requested an authorization of an installment transaction (e.g. cardholder wants to purchase a TV for 600 USD, but wants to pay for it in 3 installments of 300 USD). Such transactions are specific for the LATAM region and are not supported.
REQUIRES_SCA - A contactless transaction was declined due to the contactless limits being exceeded. A CHIP and PIN payment is required to reset the limits. The cardholder should have been prompted to dip the card at POS.
RISK_CHECK_FAILED - Transaction declined due to security reasons. Please do not share with cardholder and contact Paysafe for details.
CVV_MISSING - No CVV was provided by the merchant for this transaction.
SYSTEM_TIMEOUT - Please try again later. And contact us if the issue persists.
INTERNAL_ERROR - Please try again later. And contact us, if you still have no success.
OTHER

Possible values: [INSUFFICIENT_FUNDS, RISK_ENGINE_DECLINE, CUSTOMER_RESTRICTED, TRANSFER_NOT_ENOUGH_BALANCE, TRANSFER_AUTH_HOLD_AMOUNT_MISMATCH, TRANSFER_AUTH_HOLD_NOT_FOUND, TRANSFER_AUTH_HOLD_STATUS_MISMATCH, TRANSFER_AUTH_HOLD_CURRENCY_MISMATCH, TRANSFER_NOT_ALLOWED, TRANSFER_PARTY_NOT_FOUND, TRANSFER_REQUEST_INVALID_CURRENCY, TRANSFER_LIMIT_EXCEEDED, TRANSFER_GENERAL_ERROR, DW-TRANSFER-NOT-ENOUGH-BALANCE, DW-TRANSFER-DUPLICATED-MERCHANT-REF, DW-TRANSFER-INVALID-CURRENCY, DW-TRANSFER-LIMIT-EXCEEDED, DW-TRANSFER-GENERAL-ERROR, DW-TRANSFER-NOT-ALLOWED, DW-SCHEDULED-TRANSFER-DUPLICATION, TRANSFER_DUPLICATE_MERCHANT_REF, EXTERNAL_PROCESSING_GATEWAY_SYSTEM_ERROR, ACTION_REQUIRED, PENDING_KYC, PENDING_REVIEW, PENDING_SCREENING, RECIPIENT_ACTION_REQUIRED, PENDING_THIRTY_MINUTES_LAG, WAITING_FOR_RECIPIENT_ACCOUNT, DW-DEPOSIT-PROVIDER-ERROR, DW-DEPOSIT-NOT-CONFIRMED, DW-UNSUPPORTED-BANK, DW-DEPOSIT-BANK-CHANGE-NOT-ALLOWED, DW-DEPOSIT-AUTH-FAILED, DW-DEPOSIT-BANK-UNAVAILABLE, DW-DEPOSIT-LIMIT-EXCEEDED, DW-DEPOSIT-ACCOUNT-MISMATCH, DW-DEPOSIT-INVALID-USER-INPUT, DW-DEPOSIT-ACCOUNT-NOT-FOUND, DW-BANK-DECLINE, DW-DEPOSIT-PENDING-CONFIRMATION, DW-DEPOSIT-ATTEMPT-LIMIT-EXCEEDED, CARD_CANCELLED, CARD_SUSPENDED, CARD_NOT_ACTIVE, CARD_LOST, CARD_STOLEN, CARD_EXPIRED, CARD_LOCKED, EXPIRY_DATE_MISSING, CARDHOLDER_AUTHENTICATION_MISSING, TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER, CHIP_AND_PIN_REQUIRED, CHIP_AND_PIN_ACTIVATION_REQUIRED, LIMITS_VIOLATION_AMOUNT, LIMITS_VIOLATION_VELOCITY, PIN_TRIES_EXCEEDED, WRONG_CVV, RESTRICTED_MCC, WRONG_EXPIRATION_DATE, CVV_TRIES_EXCEEDED, SCA_REQUIRED_CURRENCY_MISMATCH, SCA_RETRY_REQUIRED, RETAIN_CARD, INVALID_PIN, FORMAT_ERROR, DO_NOT_HONOR, AUTH_EXPIRED, CARD_NOT_FOUND, WITHDRAWAL_RESTRICTED, DEPOSIT_RESTRICTED, TEST_USER, MERCHANT_COUNTRY_NOT_SUPPORTED, GAMBLING_BLOCK_ENABLED, ONLINE_GAMBLING_NOT_SUPPORTED, INSTALLMENT_TRANSACTION, REQUIRES_SCA, RISK_CHECK_FAILED, CVV_MISSING, SYSTEM_TIMEOUT, INTERNAL_ERROR, OTHER]

paymentInstrumentReference object

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

idstringrequired

Instrument identifier.

Example: 1001

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

DepositUpdateObject
{
  "eventType": "TRANSFER_UPDATE",
  "paymentDetails": [
    {
      "key": "PAYSAFECASH_BARCODE_TYPE",
      "value": "string"
    }
  ],
  "status": "FAILED",
  "nextStatus": [
    "FAILED"
  ],
  "statusReason": "INSUFFICIENT_FUNDS",
  "paymentInstrumentReference": {
    "id": "1001",
    "instrumentType": "CARD"
  }
}