---
title: "Update PayID Status"
method: PATCH
path: "/pay_ids/{id}/status"
tags: ["PayIDs"]
---

# Update PayID Status

`PATCH /pay_ids/{id}/status`

## Request

- Base URL: `https://sandbox.au-0000.api.assemblypay.com`
- URL: `https://sandbox.au-0000.api.assemblypay.com/pay_ids/{id}/status`
- Auth: none declared

Update the status of the _PayID_.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `status` string

## Response `202`

Accepted

- DeregisterPayId
  - `id` string, uuid: Identifies the _PayID_.
  - `message` string
  - `links` object
    - `self` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/hellozai/apis/virtual-accounts-and-payids.md) - [All operations](https://skmtc.dev/hellozai/apis/virtual-accounts-and-payids/llms.txt) - [OpenAPI document](https://skmtc.dev/hellozai/apis/virtual-accounts-and-payids/revisions/2c9e638dc4f4?raw)