Skip to main content

Get Customer Restrictions

GET 
/v2/customers/:customerId/restrictions

Returns active restrictions placed on a customer.

Request​

Path Parameters

    customerId stringrequired

    Possible values: <= 20 characters

    Id of the customer on which the restriction is placed.

Responses​

OK

Schema

    id string

    Possible values: <= 20 characters

    Customer Id

    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]

    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.
    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, NATIONALITY, 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

  • ]

Loading...