/mids/{midId}

DELETE /mids/{midId}

Delete a MID by ID

Soft deletes a specific MID by its ID (marks as terminated)

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

midId path string

The ID of the MID to delete

Try it out

Output:

Responses

Description

MID deleted successfully

{
  "message": "string",
  "mid": {
    "id": 0,
    "merchantId": 0,
    "midNumber": "string",
    "descriptor": "string",
    "status": "string",
    "processingStatus": "string",
    "agentId": "string",
    "agentName": "string",
    "isoId": "string",
    "isoName": "string",
    "activatedDate": "string",
    "lastProcessingDate": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/Mid

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/Mid

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    description: Unique identifier for the MID
  merchantId:
    type: integer
    description: ID of the merchant this MID belongs to
  midNumber:
    type: string
    description: Unique MID number
  descriptor:
    type: string
    description: MID descriptor
  status:
    type: string
    enum:
      - pending
      - active
      - suspended
      - terminated
    description: Current status of the MID
  processingStatus:
    type: string
    enum:
      - enabled
      - disabled
      - limited
      - hold
    description: Processing status of the MID
  agentId:
    type: string
    description: Agent ID associated with the MID
  agentName:
    type: string
    description: Agent name
  isoId:
    type: string
    description: ISO ID
  isoName:
    type: string
    description: ISO name
  activatedDate:
    type: string
    format: date-time
    description: Date when MID was activated
  lastProcessingDate:
    type: string
    format: date-time
    description: Last processing date
  createdBy:
    type: string
    description: User who created the MID
  updatedBy:
    type: string
    description: User who last updated the MID
  createdAt:
    type: string
    format: date-time
    description: Creation timestamp
  updatedAt:
    type: string
    format: date-time
    description: Last update timestamp

|
export interface Mid {
  /** Unique identifier for the MID */
  id?: number;
  /** ID of the merchant this MID belongs to */
  merchantId?: number;
  /** Unique MID number */
  midNumber?: string;
  /** MID descriptor */
  descriptor?: string;
  /** Current status of the MID */
  status?: "pending" | "active" | "suspended" | "terminated";
  /** Processing status of the MID */
  processingStatus?: "enabled" | "disabled" | "limited" | "hold";
  /** Agent ID associated with the MID */
  agentId?: string;
  /** Agent name */
  agentName?: string;
  /** ISO ID */
  isoId?: string;
  /** ISO name */
  isoName?: string;
  /** Date when MID was activated */
  activatedDate?: Date;
  /** Last processing date */
  lastProcessingDate?: Date;
  /** User who created the MID */
  createdBy?: string;
  /** User who last updated the MID */
  updatedBy?: string;
  /** Creation timestamp */
  createdAt?: Date;
  /** Last update timestamp */
  updatedAt?: Date;
}

Route Source Code

Check out the source code for this route entrypoint here: /mids/[midId]/route.ts

Or the swagger.yaml spec this documentation was generated from: /mids/swagger.yaml