Update Statuses
Header Parameters
The matchmove issued user_id for which the request is being made
The IP using which the actor is making the request
The unique id of the device using which the actor is making the request
The user agent of the device using which the actor is making the request
The actor on behalf of whom the API request is being performed
Path Parameters
Unique identifier for your program, issued by MatchMove during onboarding. All requests must use the program_code assigned to your integration. Using a program_code that does not belong to your integration will result in an authorization error.
Unique identifier of the remittance recipient. Returned in the id field from POST /{program_code}/v2/users/wallets/payouts/remittances/recipients. This identifier is valid for both user-scoped (/v2/users/...) and admin-scoped (/v2/oauth/...) paths.
Body Parameters
Action to perform on the recipient status.
ACTIVATE- reactivates a deactivated recipient. Not allowed if BLOCKED, DELETED, ACTIVE, or PENDING.DEACTIVATE- temporarily prevents the recipient from being used for transactions. Reversible via ACTIVATE.DELETE- permanently removes the recipient from the user's recipient list. Irreversible.BLOCK- permanently blocks the recipient due to risk reasons. Irreversible.
ACTIVATEDEACTIVATEDELETEBLOCKOptional comment to record the reason for this status change.
Response
OK
Response Attributes
Unique ID of recipient
Response message showing whether it's activated(under review)/deactivated
* 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...
DELETEDBLOCKEDPENDINGINACTIVEupdate timestamp
the user who has updated the user status.
Created
Response Attributes
Unique ID of recipient
Response message showing whether it's activated(under review)/deactivated
* 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...
DELETEDBLOCKEDPENDINGINACTIVEupdate timestamp
the user who has updated the user status.
Bad Request
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Unauthorized
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Forbidden
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Not Found
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Internal Server Error
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Bad Gateway
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Service Unavailable
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Gateway Timeout
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API