---
updatedAt: 2026-05-28T02:36:27.000Z
agentTools:
  projectIndex: https://docs.payadvantage.com.au/llms.txt
---

# Delete a Authentication

All requests to the Pay Advantage API need to be authenticated.<br>The Authentication API's are used to authenticate to Pay Advantage using either your API credentials or via Oauth2 protocol.<br><br>Your API credentials can be found in the Integration Section of your Pay Advantage portal. Use our [helpful guide for step by step instructions.](https://docs.payadvantage.com.au/docs/api-authentication) <br><hr><br>This endpoint disconnects a merchant from your app. This will delete their active refresh token. This is useful if you want to force users to reconnect via the OAuth2 flow. <br>`NOTE: Merchant users can disconnect from your application at any time from within Pay Advantage portal.` <br>Once they have disconnected, you will no longer be able to obtain new access tokens. You will not receive any notification regarding the merchant's choice to disconnect.<br><br>On a successful delete, an empty body `200` API response is returned.

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "PayAdvantage Web API",
    "termsOfService": "https://www.payadvantage.com.au/terms-of-service",
    "contact": {
      "name": "Support",
      "url": "https://help.payadvantage.com.au/hc/en-us/categories/360000110195",
      "email": "support@payadvantage.com.au"
    },
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://api.test.payadvantage.com.au/v3/"
    }
  ],
  "paths": {
    "/token": {
      "delete": {
        "tags": [
          "Authentication"
        ],
        "summary": "Delete a Authentication",
        "description": "All requests to the Pay Advantage API need to be authenticated.<br>The Authentication API's are used to authenticate to Pay Advantage using either your API credentials or via Oauth2 protocol.<br><br>Your API credentials can be found in the Integration Section of your Pay Advantage portal. Use our [helpful guide for step by step instructions.](https://docs.payadvantage.com.au/docs/api-authentication) <br><hr><br>This endpoint disconnects a merchant from your app. This will delete their active refresh token. This is useful if you want to force users to reconnect via the OAuth2 flow. <br>`NOTE: Merchant users can disconnect from your application at any time from within Pay Advantage portal.` <br>Once they have disconnected, you will no longer be able to obtain new access tokens. You will not receive any notification regarding the merchant's choice to disconnect.<br><br>On a successful delete, an empty body `200` API response is returned.",
        "operationId": "authentications_delete",
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "User is not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "The requested resource could not be found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "The request was well-formed but was unable to be followed due to semantic errors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Request limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "504": {
            "description": "Gateway timeout",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ApiErrorResponse": {
        "type": "object",
        "properties": {
          "ErrorCode": {
            "type": "string",
            "nullable": true,
            "example": "abc"
          },
          "Messages": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}
```