|
Field Name |
Description |
Returned By |
Data Type & Length |
|
batchId |
When the request is successful, a batch ID is returned to the user. |
/batches /…/status /…/report |
Alphanumeric (26) |
|
batchItemCount |
When the request is successful, this value is the number of items that were included in the request. When the request is unsuccessful, the value of this field is 0. |
/batches /…/status /…/report |
Numeric (9) |
|
_links |
JSON object containing link elements relating to the request. Successful requests return the URI of the batch status. |
/batches /…/status /…/report |
|
|
self |
The resource address that was requested. Element within _links. |
/batches /…/status /…/report |
URL |
|
first |
First page in the result set. |
/batches |
URL |
|
next |
Next page in the result set. |
/batches |
URL |
|
last |
Last page in the result set. |
/batches |
URL |
|
status |
URI of the batch status resource. Note Do not hard-code the link to the batch status resource. Use the returned value to avoid errors if the URI structure changes. |
/batches |
URL |
|
reports |
URI of the batch associated with the batchId. |
/batches /status |
URL |
|
correlationId |
Returned when an error occurs. Provide this ID to Customer Support to help identify your transaction. |
/batches /…/status /…/report |
String (36) |
|
code |
HTTP Response code. Returned when an error occurs. See Response Codes and Reason Codes. |
/batches /…/status /…/report |
String (3) |
|
detail |
Returned when an error occurs. Detailed description of the error. See Response Codes and Reason Codes. |
/batches /…/status /…/report |
String (1024) |
|
fields |
Returned when an error occurs. The array contains elements that describe the erroneous fields. See Response Codes and Reason Codes. |
/batches |
|
|
path |
Returned when an error occurs. Element within the fields. Path of field name. See Response Codes and Reason Codes. |
/batches |
String (36) |
|
message |
Returned when an error occurs. This is a plain text error message and can be an element within the fields. This field can also appear with the fields JSON object. |
/batches |
String (256) |
|
localizationKey |
Returned when an error occurs. A unique key that represents the error message and can be an element within fields. See Response Codes and Reason Codes. This field can also appear with the JSON object. |
/batches |
String (128) |
|
version |
Version of the report. For example, Note You always receive the latest minor version of the report for the API you used to create the batch. |
/report |
|
|
batchSource |
Method used to create the batch. For example, TOKEN_API. |
/batches /status /report |
TOKEN_API SCHEDULER AMEX_REGISTRY AMEX_MAINTENANCE |
|
batchCaEndpoints |
Card associations to which the card numbers were sent. |
/batches /status /report |
Array containing one or more of the following: nVISA nMASTERCARD nAMEX |
|
batchCreatedDate |
Date on which the batch was created. |
/batches /status /report |
ISO_8601 UTC date |
|
reportCreatedDate |
Date on which the report was created. |
/batches /status /report |
ISO_8601 UTC date |
|
merchantReference |
Your reference, if present in the request. |
/batches /status /report |
0 to 255 characters |
|
totals |
JSON object containing the high-level summary of the batch. |
/batches /status /report |
|
|
acceptedRecords |
Number of tokens that were identified and retrieved for the merchant ID. |
/batches /status /report |
String (9) |
|
rejectedRecords |
Number of tokens that were not identified and retrieved. |
/batches /status /report |
String (9) |
|
updatedRecords |
Number of updates that were applied to a token. |
/batches /status /report |
String (9) |
|
caResponses |
Number of updates that were received from the card associations. This value represents updates that may have or have not been applied to a token. |
/batches /status /report |
String (9) |
|
caResponsesOmitted |
Number of updates that were not applied to a token. For example, a response is returned by more than one card association. |
/batches /status /report |
String (9) |
|
billing |
JSON object containing the billing summary information. |
/status /report |
|
|
nan/ned/acl/cch |
Number of each billed response type. |
/status /report |
String (3) |
|
records |
JSON object containing additional objects that relate to the original tokens and the updates or errors that occurred. |
/report |
|
|
id |
CyberSource generated ID for the record. |
/report |
|
|
sourceRecord |
JSON object containing details from the source token. |
/report |
|
|
token |
Subscription ID included in the request. |
/report |
|
|
cardNumber |
Masked card number before an update. First six digits and the last four digits are not masked. |
/report |
|
|
cardExpiryMonth |
Two-digit month in which the card expires. |
/report |
|
|
cardExpiryYear |
Four-digit month in which the card expires. |
/report |
|
|
cardType |
Type of card. Possible values: 001: Visa 002: Mastercard 003: American Express |
/report |
String (3) |
|
customerId |
Value of the customer token assigned to the tokenized shipping information and merchant defined data. Note This field is for TMS merchants only. |
/report |
|
|
paymentInstrumentId |
The value of the payment instrument token assigned to the tokenized billing information and card expiration dates. Note This field is for TMS merchants only. |
/report |
|
|
instrumentIdentifierId |
Value of the instrument identifier token assigned to the tokenized PAN. Note This field is for TMS merchants only. |
/report |
|
|
responseRecord |
JSON object containing the details that were made to the token. |
/report |
|
|
response |
Type of response. See Response Codes and Reason Codes. |
/report |
|
|
reason |
Reason code for the response. See Response Codes and Reason Codes. |
/report |
|
|
token |
If last-four-digit format-preserving tokens are used, a new token (subscription ID) can be returned that replaces the source record token. |
/report |
|
|
cardNumber |
Masked card number. First six and last four digits are not masked. |
/report |
|
|
cardExpiryMonth |
Two-digit month in which the card expires. |
/report |
|
|
cardExpiryYear |
Four-digit month in which the card expires. |
/report |
|
|
cardType |
Type of card. Possible values: 001: Visa 002: Mastercard 003: American Express |
/report |
String (3) |
|
instrumentIdentifierId |
Value of the instrument identifier token assigned to the updated tokenized PAN. Note This field is for TMS merchants only. |
/report |
|
|
instrumentIdentifierIdCreated |
Indicates whether this is the first time the PAN has been tokenized for you. Possible values: ntrue nfalse |
/report |
String (5) |
|
Details associated with a closed instrument identifier token. |
/report |
|
|
|
customerId |
Value of the customer token not present in the batch and associated with a closed instrument identifier token. |
/report |
String |
|
paymentInstrumentId |
Value of the payment instrument token not present in the batch and associated with a closed instrument identifier token. |
/report |
String |
|
creator |
Merchant that created the payment instrument token |
/report |
String |
|
state |
State of the token. |
/report |
“CLOSED” |
|
message |
Information about the tokens. |
/report |
String |