Update Payment Token Status - Field Descriptions
The following page details each of the fields received in the response when using the Update Payment Token Status endpoint.
Request Fields
The following table describes fields that can be included in the body of the request when creating or updating a token status.
| Field | Description | Min Length | Max Length | Type | Mandatory |
|---|---|---|---|---|---|
| tokenId | Payment token identifier for the Mastercard Digital Enablement Services (MDES) or Visa Digital Enablement Program (VDEP) Card to be updated. Note, you can use the Get Card Payment Tokens endpoint to retrieve the Id of the token associated with card. | 0 | 2147483648 | Integer | No |
| status | New status code you want to change to. This can be either Active, Suspended or Deactivated. | 0 | 10 | String | No |
| notifyProcessor | If true, sets whether VDEP or MDES are notified about the payment status change. | 0 | 5 | Boolean | No |
| description | The reason why the status has been updated. | 0 | 800 | String | No |
| updatedBy | The user who updated the status. | 0 | 100 | String | No |
Response Fields
A successful response for the Update Payment Token Status endpoint will return a 200 response.
| Field | Description |
|---|---|
| status | A description of the new status for the payment token. |
| comment | If notifyProcessor is false, the comment will be 'Not processed by the payment processor'. If true, the comment will be "Successfully processed by the payment processor" if the request was successful, and "An error occured while processing {status} request for VDEP" if it failed. |
Updated 16 days ago