Skip to main content

Customer restriction update event

POST 
/customers/restrictions

When applying restrictions to a customer, the system has two distinct behaviours, depending on the type of restriction being placed:

  • All regulatory restrictions are applied immediately, e.g. Sanctions; for these type of restrictions, the Merchant will receive just the one webhook with operationType == 'UPDATE'.
  • Fraud related restrictions are synchronized between Paysafe and Merchant, as the customer could have pending operations on the Merchant's system. In this case:
    • Paysafe will first send a webhook with operationType == 'SYNC'; the restriction is not yet applied on Paysafe's side
    • Merchant must confirm the restriction by calling the restriction confirmation API; if the restriction is not confirmed within a time frame (e.g. 60sec), the restriction will be applied automatically;
    • When the restriction is applied on Paysafe side, a new webhook will be sent, where operationType == 'UPDATE'.
  • Webhooks with operationType='NOTIFY' can be sent to the Merchant with dueDate set to a date which defines when the restriction will be applied to the Merchant's customer. The Merchant needs to take the appropriate actions to prevent the restriction from applying to the customer until dueDate.

Request​

Header Parameters

    Signature string

    HMAC signature of the request

    Content-Type stringrequired

    Default value: application/json

    application/json

Body

    id stringrequired
    timestamp date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    customer

    object

    required

    id stringrequired
    externalId ExternalId (string)required

    Possible values: non-empty and <= 40 characters

    Customer identifier used in Partner system.

    restrictions

    object[]

  • Array [

    • name RestrictionName (string)required

    Possible values: [ALL_TRANSACTIONS, OUTGOING_TRANSACTIONS, INCOMING_TRANSACTIONS, SEND_MONEY, INCOMING_TRANSACTIONS_AND_SEND_MONEY, CARD_DEPOSITS, CARD_AND_ACH_DEPOSITS, DEPOSITS, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS, OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS, DEPOSITS_AND_WITHDRAWALS, CRYPTO_TRANSACTIONS, OTHER]

    Restrictions applied to customer wallet.

    • ALL_TRANSACTIONS - Block all types of transactions.
    • OUTGOING_TRANSACTIONS - Block withdrawals and send money transactions.
    • INCOMING_TRANSACTIONS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks.
    • SEND_MONEY - Block all send money transactions to other customers and merchants.
    • INCOMING_TRANSACTIONS_AND_SEND_MONEY - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks. Block all send money transactions to other customers and merchants.
    • CARD_DEPOSITS - Block all deposit made by card.
    • CARD_AND_ACH_DEPOSITS - Block all deposit made by card and ACH bank deposits.
    • DEPOSITS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits.
    • OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS - Block withdrawals and send money transactions and all card deposits.
    • OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS - Block all types of withdrawals (including ATM and POS trn with prepaid card) and ACH deposits.
    • DEPOSITS_AND_WITHDRAWALS - Bocks all withdrawals and deposits.
    • CRYPTO_TRANSACTIONS - Block all crypto trn including buy and sell, received and send crypto.
    • OTHER - Other restrictions.
    reason RestrictionReason (string)required

    Possible values: [RISK_CONTROLS, COMPLIANCE, CLOSE_ACCOUNT, DUPLICATE_ACCOUNT, KYC, NO_SERVICE_COUNTRY, PREPAID_CARD_CHARGEBACK, T_C_ABUSE, TERMINATED, UNDER_18, OTHER, CONFIRM_TXN_ACTIVITY, MERCHANT_REQUEST]

    Reason for placing the restriction.

    • RISK_CONTROLS - The reason for setting up the restriction requires additional risk checks to the end-customer's account.
    • COMPLIANCE - The reason for setting up the restriction is related to the customer's due diligence and requires an additional compliance check of the end-customer's account.
    • CLOSE_ACCOUNT - Account closure.
    • DUPLICATE_ACCOUNT - The reason for setting up the restriction shows that the same person already exists as the account owner.
    • KYC - The reason for setting up the restriction is related to the customer's KYC verification and requires KYC document submissions.
    • NO_SERVICE_COUNTRY - No service country.
    • PREPAID_CARD_CHARGEBACK - Pre-paid card chargeback.
    • T_C_ABUSE - Terms & Conditions Abuse
    • TERMINATED - Account terminated.
    • UNDER_18 - Customer under 18.
    • MERCHANT_REQUEST - Merchant placed the restriction.
    • CONFIRM_TXN_ACTIVITY - Contact customer to confirm pre-paid card transactional activities.
    • OTHER - Other reason.
    requiredActions RequiredAction (string)[]

    Possible values: [CONTACT_CUSTOMER_SERVICE, KYC_VERIFICATION, SUBMIT_ID, SUBMIT_SSN_CARD, SECOND_FORM_OF_ID, SUBMIT_AD, PEP_DECLARATION, BANK_ACCOUNT_VERIFICATION, WAIT, NO_REMEDIATION, COMPLETE_ONBOARDING, OTHER]

    Actions to be completed in order to resolve

    creationTime date-time

    Represents RFC 3339, section 5.6 date-time.

    id stringrequired

    Possible values: <= 36 characters

    Restriction id

  • ]

    • operationType RestrictionType (string)required

    Possible values: [UPDATE, SYNC, NOTIFY]

Responses​

OK

Loading...