CustomerStatusChangeEvent

A webhook with operationType=NOTIFY can be send to the merchant with the dueDate which defines when the restriction will be applied to the merchant's customer

idstringrequired

timestampdate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

customer objectrequired

idstringrequired

externalIdExternalId (string)

Customer identifier used in Partner system.

Possible values: non-empty and <= 40 characters

Example: af5c8b52-0afd-4799-85ab-fe659a076932

restrictions object[]

Array [

nameRestrictionName (string)required

Represents the name of a restriction applied to a 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.

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]

Example: ALL_TRANSACTIONS

reasonRestrictionReason (string)required

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.

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]

requiredActionsRequiredAction (string)[]

Actions to be completed in order to resolve

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, NATIONALITY, OTHER]

creationTimedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

idstringrequired

Restriction id

Possible values: <= 36 characters

Example: 084666a4-cd47-40c1-afe2-4a575e341d59

]

operationTypeRestrictionType (string)required

Possible values: [UPDATE, SYNC, NOTIFY]

Example: UPDATE

CustomerStatusChangeEvent

{
  "id": "string",
  "timestamp": "2021-07-15T17:54:12Z",
  "customer": {
    "id": "string",
    "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
    "restrictions": [
      {
        "name": "ALL_TRANSACTIONS",
        "reason": "RISK_CONTROLS",
        "requiredActions": [
          "CONTACT_CUSTOMER_SERVICE"
        ],
        "creationTime": "2021-07-15T17:54:12Z",
        "id": "084666a4-cd47-40c1-afe2-4a575e341d59"
      }
    ]
  },
  "operationType": "UPDATE"
}