Field Name

Description

Used By & Required (R)/Optional (O)

Validation

notificationEmail

Email address to which batch status updates are sent.

(R) POSTs to
/batches

Valid email address

merchantReference

Your reference to identify the batch.

(O) POSTs to
/batches

0 to 255 characters

type

Indicates whether batch is a one-off update for Visa and/or Mastercard, or an enrollment in American Express Cardrefresher. Possible values:

noneOff (default): Visa or Mastercard

namexRegistration: American Express

(O) POSTs to
/batches

included

Elements to be included. Must include one of the following:

ntokens

ninstrument_identifier

(R) POSTs to
/batches

tokens

Comma-separated list of subscription IDs, Token Management Service (TMS) customer or payment instrument tokens.

(O) POSTs to
/batches

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

Token Management Service (TMS) instrument identifier token assigned to the tokenized PAN and its associated expiration dates.

(O) POSTs to
/batches

id

ID for the instrument identifier token.

(R) POSTs to
/batches

String (32)

expirationMonth

Two-digit month in which the card expires.

(R) POSTs to
/batches

String (2)

expirationYear

Four-digit year in which the card expires.

(R) POSTs to
/batches

String (4)