PUT/counterparty/{userId}/counterparties/{counterpartyId}/disable

Disable Counterparty

Disables a counterparty, preventing it from being used in future payments.

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	Unique user ID.
`counterpartyId`	string	Required	—	Unique counterparty ID.

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	Confirmation message when the counterparty is disabled.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": "Your Beneficiary \"James Michael Doe\" is now disabled."
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": "Your Beneficiary \"James Michael Doe\" is now disabled."
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.