Skip to main content

CustomerDeactivationList

deactivations object[]
  • Array [
  • idstringrequired

    The deactivation request unique identifier.

    Possible values: <= 50 characters

    Example: b3d0dca9-8e0c-4b75-8c99-0b4b8621b5b5
    customerIdstring

    Paysafe embedded wallet internal identifier.

    Possible values: <= 20 characters

    externalIdExternalId (string)

    Customer identifier used in Partner system.

    Possible values: non-empty and <= 40 characters

    Example: af5c8b52-0afd-4799-85ab-fe659a076932
    categoryCustomerDeactivationCategory (string)required

    The customer deactivation category.

    • MERCHANT_INITIATED - Indicates that the merchant is the one to initiate the customer deactivation.
    • CUSTOMER_INITIATED - Indicates that the customer is the one to initiate the customer deactivation.

    Possible values: [MERCHANT_INITIATED, CUSTOMER_INITIATED]

    Example: MERCHANT_INITIATED
    reasonCustomerDeactivationReason (string)required

    The customer deactivation reason.

    • FRAUD - The reason for requesting customer deactivation is fraud-related.
    • INACTIVITY - The reason for requesting customer deactivation is customer inactivity.
    • T_C_ABUSE - Terms & Conditions Abuse
    • NO_SERVICE_COUNTRY - No service country.
    • OTHER - The reason for requesting customer deactivation is not present in this list.

    Possible values: [FRAUD, INACTIVITY, T_C_ABUSE, NO_SERVICE_COUNTRY, OTHER]

    Example: INACTIVITY
    statusCustomerDeactivationStatus (string)required

    Customer deactivation request status.

    • MANUAL_REVIEW - deactivation request is in manual review status without final resolution.
    • APPROVED - deactivation request was approved.
    • DECLINED - deactivation request was declined.

    Possible values: [APPROVED, DECLINED, MANUAL_REVIEW]

    Example: APPROVED
    commentstring

    Optional field that might contain additional information regarding the deactivation request review outcome.

    creationTimedate-time

    Deactivation request date and time.

  • ]
  • meta object

    Contains paging information regarding the returned records, when response is paginated.

    The input for paginated query contains two parameters:

    • limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
    • offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

    Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

    The number of previous pages can be calculated by dividing offset to limit.

    numberOfRecordsinteger

    This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

    Example: 1
    limitinteger

    This is the requested number of records to be returned per page.

    Example: 10
    offsetinteger

    This is the requested starting position of the response, where 0 is the first record.

    Example: 0
    pageinteger

    This is the page of records on which the lookup starts. The starting page is 1.

    Example: 1
    CustomerDeactivationList
    {
    "deactivations": [
    {
    "id": "b3d0dca9-8e0c-4b75-8c99-0b4b8621b5b5",
    "customerId": "string",
    "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
    "category": "MERCHANT_INITIATED",
    "reason": "INACTIVITY",
    "status": "APPROVED",
    "comment": "string",
    "creationTime": "2024-07-29T15:51:28.071Z"
    }
    ],
    "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "offset": 0,
    "page": 1
    }
    }