Skip to main content

UserRestriction

Represents a restriction.

Restrictions forbid certain user operations in the wallet. Determine the restricted action based on the restriction name. Check the requiredActions field to determine the course of action for resolving the restrictions.

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.
  • LOGIN - Block access to account login, preventing the user from signing in to view or manage their account.
  • 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, LOGIN, OTHER]

Example: ALL_TRANSACTIONS
requiredActionsRequiredAction (string)[]

Actions to be completed in order to resolve the restriction.

Possible values: [CONTACT_CUSTOMER_SERVICE, KYC_VERIFICATION, BANK_ACCOUNT_VERIFICATION, PEP_DECLARATION, WAIT, OTHER, MANUAL_REVIEW, COMPLETE_ONBOARDING]

Example: ["CONTACT_CUSTOMER_SERVICE","KYC_VERIFICATION"]
lastChangeDatedate-time

Represents RFC 3339, section 5.6 date-time.

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

Restriction id.

Example: 34fe6de4-e162-484c-b5e9-05a79e889110
activationTimedate-time

Represents RFC 3339, section 5.6 date-time.

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

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
UserRestriction
{
  "name": "ALL_TRANSACTIONS",
  "requiredActions": [
    "CONTACT_CUSTOMER_SERVICE",
    "KYC_VERIFICATION"
  ],
  "lastChangeDate": "2021-07-15T17:54:12Z",
  "id": "34fe6de4-e162-484c-b5e9-05a79e889110",
  "activationTime": "2021-07-15T17:54:12Z",
  "dueDate": "2021-07-15T17:54:12Z"
}