> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pushcash.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Simulate a user suspension

> **Sandbox only.** Suspends the user, so you can exercise your `user.suspended` webhook handler without waiting for a real suspension. This endpoint is not available in the production environment.




## OpenAPI

````yaml /openapi.yaml post /sandbox/user/{id}/suspend
openapi: 3.0.1
info:
  title: Push API
  version: 0.0.1
servers:
  - url: https://api.pushcash.com
    description: Production API
  - url: https://sandbox.pushcash.com
    description: Sandbox API used for developing an integration with Push
security:
  - bearer: []
tags:
  - name: user
  - name: tokenization
  - name: authorization
  - name: intent
  - name: dispute
  - name: refund
  - name: ledger
    description: >-
      Accounts, transactions, and transfers — the records that make up the Push
      ledger.
  - name: simulation
  - name: webhook
paths:
  /sandbox/user/{id}/suspend:
    post:
      tags:
        - simulation
      summary: Simulate a user suspension
      description: >
        **Sandbox only.** Suspends the user, so you can exercise your
        `user.suspended` webhook handler without waiting for a real suspension.
        This endpoint is not available in the production environment.
      operationId: simulateUserSuspension
      parameters:
        - name: id
          in: path
          description: The push identifier for the user
          required: true
          schema:
            type: string
            example: user_28CJjV7P4Go5PNJvfzghiD
      responses:
        '200':
          description: >
            The suspended user. A user who is already suspended is returned
            unchanged, with `status` still `suspended`, and no webhook is
            delivered — only a transition into suspension emits one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              example:
                id: user_28CJjV7P4Go5PNJvfzghiD
                tag: 4c8e6b4f
                status: suspended
                created_at: '2023-04-10T05:10:14.532Z'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          description: Push's identifier assigned to the user
        tag:
          type: string
          nullable: true
          description: The tag provided in the request to create the user
        status:
          $ref: '#/components/schemas/UserStatus'
        created_at:
          type: string
          description: Date and time in which user was first created in system
          format: date-time
      example:
        id: user_28CJjV7P4Go5PNJvfzghiD
        tag: 4c8e6b4f
        status: enabled
        created_at: '2023-04-10T05:10:14.532Z'
      required:
        - id
        - tag
        - status
        - created_at
    error:
      description: Description of the error encountered from the API request
      type: object
    UserStatus:
      type: string
      enum:
        - created
        - enabled
        - suspended
        - disabled
      x-enumDescriptions:
        created: >-
          The user has been created but has not yet performed a successful
          intent.
        enabled: The user is enabled and has successfully performed an intent.
        suspended: The user is temporarily suspended for review due to unusual activity.
        disabled: >-
          A suspension was upheld and the user has been permanently disabled by
          Push Cash.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````