v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
PayIDs

Update PayID Status

Update the status of the PayID.

patch/pay_ids/{id}/status

Path parameters

idstring uuid required

Id of the PayID resource.

Request body

statusstring

Example request

{
  "status": "deregistered"
}

Response

Accepted

idstring uuid

Identifies the PayID.

messagestring

Example response

{
  "id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
  "message": "PayID deregistration has been accepted for processing",
  "links": {
    "self": "/pay_ids/46deb476-c1a6-41eb-8eb7-26a695bbe5bc"
  }
}