---
updatedAt: 2025-08-21T13:31:26.000Z
agentTools:
  siteIndex: https://merchants.westpac.com.au/llms.txt
  projectIndex: https://merchants.westpac.com.au/onlinepay/llms.txt
---

# Deactivate Key Pair

This sets the status of the key pair to inactive.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "eCommerce API",
    "description": "The OnlinePay eCommerce API is used to process and manage payments via RESTful API requests.",
    "version": "2.0.0",
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "contact": {}
  },
  "servers": [
    {
      "url": "https://au.gsc.verifone.cloud/oidc",
      "description": "Australia"
    },
    {
      "url": "https://cst.test-gsc.vfims.com/oidc",
      "description": "Global Sandbox"
    }
  ],
  "components": {
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "BadRequestV2Docs": {
        "type": "object",
        "properties": {
          "details": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "timestamp": {
            "type": "number",
            "description": "Error timestamp",
            "example": 1596467016700
          },
          "reversal_status": {
            "type": "string",
            "description": "Indicates to the API client if a technical reversal has been completed by Verifone.",
            "default": "NONE",
            "enum": [
              "NONE",
              "REQUIRED",
              "COMPLETED"
            ]
          },
          "code": {
            "type": "number",
            "example": 400,
            "enum": [
              400
            ],
            "default": 400
          },
          "message": {
            "type": "string",
            "example": "At least one parameter is invalid. Examine the details property for more information. Invalid parameters are listed and prefixed accordingly: body for parameters submitted in the requests body, query for parameters appended to the requests URL, and params for templated parameters of the requests URL.",
            "enum": [
              "At least one parameter is invalid. Examine the details property for more information. Invalid parameters are listed and prefixed accordingly: body for parameters submitted in the requests body, query for parameters appended to the requests URL, and params for templated parameters of the requests URL."
            ],
            "default": "At least one parameter is invalid. Examine the details property for more information. Invalid parameters are listed and prefixed accordingly: body for parameters submitted in the requests body, query for parameters appended to the requests URL, and params for templated parameters of the requests URL."
          }
        },
        "required": [
          "message"
        ]
      },
      "UnauthorizedV2Docs": {
        "type": "object",
        "properties": {
          "details": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "timestamp": {
            "type": "number",
            "description": "Error timestamp",
            "example": 1596467016700
          },
          "reversal_status": {
            "type": "string",
            "description": "Indicates to the API client if a technical reversal has been completed by Verifone.",
            "default": "NONE",
            "enum": [
              "NONE",
              "REQUIRED",
              "COMPLETED"
            ]
          },
          "code": {
            "type": "number",
            "example": 401,
            "enum": [
              401
            ],
            "default": 401
          },
          "message": {
            "type": "string",
            "example": "Access is restricted to authenticated users only. The query can't be made without a valid JWT token (check the Authorization header of your request).",
            "enum": [
              "Access is restricted to authenticated users only. The query can't be made without a valid JWT token (check the Authorization header of your request)."
            ],
            "default": "Access is restricted to authenticated users only. The query can't be made without a valid JWT token (check the Authorization header of your request)."
          }
        },
        "required": [
          "message"
        ]
      },
      "ForbiddenV2Docs": {
        "type": "object",
        "properties": {
          "details": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "timestamp": {
            "type": "number",
            "description": "Error timestamp",
            "example": 1596467016700
          },
          "reversal_status": {
            "type": "string",
            "description": "Indicates to the API client if a technical reversal has been completed by Verifone.",
            "default": "NONE",
            "enum": [
              "NONE",
              "REQUIRED",
              "COMPLETED"
            ]
          },
          "code": {
            "type": "number",
            "example": 403,
            "enum": [
              403
            ],
            "default": 403
          },
          "message": {
            "type": "string",
            "example": "Insufficient permissions. Your current user roles don't allow you to perform this query. Should you believe this error to be incorrect, please contact an administrator.",
            "enum": [
              "Insufficient permissions. Your current user roles don't allow you to perform this query. Should you believe this error to be incorrect, please contact an administrator."
            ],
            "default": "Insufficient permissions. Your current user roles don't allow you to perform this query. Should you believe this error to be incorrect, please contact an administrator."
          }
        },
        "required": [
          "message"
        ]
      },
      "NotFoundV2Docs": {
        "type": "object",
        "properties": {
          "details": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "timestamp": {
            "type": "number",
            "description": "Error timestamp",
            "example": 1596467016700
          },
          "reversal_status": {
            "type": "string",
            "description": "Indicates to the API client if a technical reversal has been completed by Verifone.",
            "default": "NONE",
            "enum": [
              "NONE",
              "REQUIRED",
              "COMPLETED"
            ]
          },
          "code": {
            "type": "number",
            "example": 404,
            "enum": [
              404
            ],
            "default": 404
          },
          "message": {
            "type": "string",
            "example": "The requested resource, or one of its sub-resources, can't be found. If the submitted query is valid, this error is likely to be caused by a problem with a nested resource that has been deleted or modified. Check the details property for additional insights.",
            "enum": [
              "The requested resource, or one of its sub-resources, can't be found. If the submitted query is valid, this error is likely to be caused by a problem with a nested resource that has been deleted or modified. Check the details property for additional insights."
            ],
            "default": "The requested resource, or one of its sub-resources, can't be found. If the submitted query is valid, this error is likely to be caused by a problem with a nested resource that has been deleted or modified. Check the details property for additional insights."
          }
        },
        "required": [
          "message"
        ]
      },
      "InternalErrorV2Docs": {
        "type": "object",
        "properties": {
          "details": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "timestamp": {
            "type": "number",
            "description": "Error timestamp",
            "example": 1596467016700
          },
          "reversal_status": {
            "type": "string",
            "description": "Indicates to the API client if a technical reversal has been completed by Verifone.",
            "default": "NONE",
            "enum": [
              "NONE",
              "REQUIRED",
              "COMPLETED"
            ]
          },
          "code": {
            "type": "number",
            "example": 500,
            "enum": [
              500
            ],
            "default": 500
          },
          "message": {
            "type": "string",
            "example": "Unexpected error: if the error persists, please contact an administrator, quoting the code and timestamp of this error",
            "enum": [
              "Unexpected error: if the error persists, please contact an administrator, quoting the code and timestamp of this error"
            ],
            "default": "Unexpected error: if the error persists, please contact an administrator, quoting the code and timestamp of this error"
          }
        },
        "required": [
          "message"
        ]
      }
    }
  },
  "security": [
    {
      "BasicAuth": []
    }
  ],
  "paths": {
    "/api/v2/key/{keyAlias}/deactivate": {
      "patch": {
        "operationId": "deactiveKeyPair",
        "summary": "Deactivate Key Pair",
        "description": "This sets the status of the key pair to inactive.",
        "parameters": [
          {
            "name": "keyAlias",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Success. Key pair deactivated."
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestV2Docs"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorised",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnauthorizedV2Docs"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenV2Docs"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundV2Docs"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalErrorV2Docs"
                }
              }
            }
          }
        },
        "tags": [
          "Secure Card Capture"
        ],
        "security": [
          {
            "BasicAuth": []
          }
        ]
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "ECOMMERCE",
      "tags": [
        "Ecom Payments",
        "Payment Modifications",
        "Transaction",
        "Secure Card Capture",
        "Wallet"
      ]
    },
    {
      "name": "Loyalty Program Operations",
      "tags": [
        "Redemption Order"
      ]
    },
    {
      "name": "Balance Enquiry",
      "tags": [
        "Balance Enquiry"
      ]
    },
    {
      "name": "Gift Card Operations",
      "tags": [
        "Load Card",
        "Activate Card"
      ]
    },
    {
      "name": "Bin",
      "tags": [
        "Bin"
      ]
    },
    {
      "name": "Token Management",
      "tags": [
        "Token Management"
      ]
    },
    {
      "name": "Health Check",
      "tags": [
        "Health"
      ]
    }
  ]
}
```