POST
/v2/beneficiary/change-statusChange Status
Enables or disables a beneficiary for transactions.
Headers
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
Authorization | string | Required | Bearer {SessionToken} | Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request. |
Request body
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
BeneficiaryId | string | Required | {beneficiaryID} | Unique beneficiary ID returned from Create Beneficiary or List Beneficiaries. |
Status | string | Required | Active | Disable | New beneficiary status: `Active` (enabled for payments) or `Disable`. |
Example request
{
"BeneficiaryId": "{beneficiaryID}",
"Status": "Disable"
}Response
| Field | Type | Possible values | Description |
|---|---|---|---|
ResponseCode | integer | 200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422 | 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 that the beneficiary status was updated. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": "Beneficiary has been enabled/disabled for transactions successfully."
}Note: "Permission Denied" message is returned with status code 400 when "Status" in request body is same as the beneficiary status.
Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.