API explorer
⁍ MatchMove Banking Operating System

Sections

API explorer

Theme switcher

Update recipient status

Header Parameters

X-Auth-User-IDstring Required

MatchMove provided ID for the user.

Authorizationstring

Path Parameters

idstring Required

Unique reference id of recipient.

Body Parameters

statusstring Required


* ACTIVATE - this is used to activate a deactivated recipient. Recipient with blocked, deleted, active, and pending status cannot be activated.
* DEACTIVATE - this is to temporarily deactivate a recipient. Once a recipient is deactivated it cannot be used to perform a transaction.
* DELETE - this is to permanently delete a recipient from the user recipient list. A deleted recipient cannot be used to perform a transaction.
* BLOCK - this status is used to perman...

Enum values:
ACTIVATEDEACTIVATEDELETEBLOCK
commentsstring

This field represents any comment to be added for the status update activity.

commentstring

Response

200
Object
OK

Response Attributes

idstring

Unique ID of recipient

messagestring

Response message showing whether it's activated(under review)/deactivated

statusstring


* PENDING - this is the recipient state right after activation is invoked, while it is queued for risk evaluation. Once risk evaluations is completed, recipient would either be updated as active or kept in pending status due to risk hit.
* INACTIVE - this status denotes that the recipient was previously active but is now prevented to perform transactions. This state can be reversed by re-activation.
* DELETED - this status denotes that the recipient is removed from th...

Enum values:
DELETEDBLOCKEDPENDINGINACTIVE
updated_atstring

update timestamp

updated_bystring

the user who has updated the user status.

400
Object
Bad Request | **Code** | **Title** | **Detail** | | ---------------------------------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------| | invalid_user_id | Invalid User ID | User does not exist. Please provide a valid user id. | | user_not_active | User Not Active | user is not active. | | invalid_recipient_id | Invalid Recipient ID | Recipient does not exist. Please provide a valid recipient id. | | validation_error | Validation Error | Validation errors. | | need_updation_recipient_data | Need Updation Recipient Data | Recipient data needs to be updated as per the latest recipient form version. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

401
Object
Unauthorized Request | **Code** | **Title** | **Detail** | | ---------------------------| ----------------------| ---------------------------------------------------| | token_required | Token Required | Access denied due to invalid token on header. | | invalid_tenant | Invalid Tenant | Access denied due to invalid tenant code. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

403
Object
Forbidden | **Code** | **Title** | **Detail** | | --------------------------| -----------------------| --------------------------------------------------------------------------------------------| | restricted_resource | Restricted Resource | Access denied to the resource. If your access key and source IP is correct, it would be because of `X-Auth-User-ID` is not passed on header. | | unauthorized_action | Forbidden | Operation is not allowed for this recipient. | | unauthorized_access | Unauthorized Access | Recipient does not belong to user. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

404
Object
Not Found | **Code** | **Title** | **Detail** | | --------------------------| ---------------------- | -------------------------------------| | resource_not_found | Resource Not Found | The requested URL was not found. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

500
Object
Internal Server Error | **Code** | **Title** | **Detail** | | --------------------------| -----------------------| -----------------------------------------------------| | generic_error | Generic Error | General application error. |

Response Attributes

idstring Required

Unique hash-id for the error message

statusinteger Required

Error response status code

codestring Required

Error response code

titlestring Required

Error response title

detailstring Required

Error response detail

sourcearray,string

Source defines the multiple error messages

Show child attributes

timestampstring Required

Response timestamp

Was this section helpful?

PUT

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude