On This Page
Request Fields
Field Name | Description | Used By & Required (R) /Optional (O) | Validation |
|---|---|---|---|
notificationEmail | Email address to which batch status updates are sent. | POSTs to /batches (R) | Valid email address |
merchantReference | Your reference to identify the batch. | POSTs to /batches (O) | 0 to 255 characters |
type | Indicates whether batch is a one-time update for Visa and/or Mastercard, or an
enrollment in American Express Cardrefresher. Possible values:
| POSTs to /batches (O) | |
included | Elements to be included. Must include one of the following:
| POSTs to /batches (R) | |
tokens | Comma-separated list of subscription IDs, TMS customer or payment
instrument tokens. | POSTs to /batches (O) | If the array is present, then it should not be empty (min length = 1) or contain
null values. Maximum number of tokens is 10 million. |
instrumentIdentifiers | TMS instrument identifier token assigned to the tokenized PAN
and its associated expiration dates. | POSTs to /batches (O) | |
id | ID for the instrument identifier token. | POSTs to /batches (R) | String (32) |
expirationMonth | Two-digit month in which the card expires. | POSTs to /batches (R) | String (2) |
expirationYear | Four-digit year in which the card expires. | POSTs to /batches (R) | String (4) |