On This Page

American Express Daily and Token Harvest Update Reports

American Express update reports are generated daily, so the batch ID is not known in advance.

Similarly, token harvest updates are scheduled by the Account Updater service on a date that you agree upon with your

account representative

For daily and token harvest update reports, the first step is to retrieve the batch ID itself by sending an authenticated GET request, including the header

ACCEPT=application/json

, to one of the following resources:

Test:

https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches

Production:

https://api.smartpayfuse.barclaycard/accountupdater/v1/batches

The response is an array of batches. Paging is supported with offset and limit query parameters. For example, to return the second page of results with 50 per page, send

/v1/batches?offset=1&limit=50

To filter by date, add the

fromDate

and

toDate

fields as a query string using the UTC date format yyyymmddThhmmssZ. Example:

v1/batches?fromDate=20200315T000000Z&toDate=20200415T000000Z

HTTP 200: Successful Response

{
  "_links": [
    {
      "rel": "self",
      "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches?offset=0&limit=1"
    },
    {
      "rel": "first",
      "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches?offset=0&limit=1"
    },
    {
      "rel": "next",
      "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches?offset=1&limit=1"
    },
    {
      "rel": "last",
      "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches?offset=114&limit=1"
    }
  ],        
  "object": "collection",
  "offset": 0,
  "limit": 3,
  "count": 1,
  "total": 3,
  "_embedded": {
    "batches": [
      {
        "_links": {
        "reports": [
          {
          "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches/15416031479410002099212314/report"
            }
          ]
        },
        "batchId": "15416031479410002099212314",
        "batchCreatedDate": "2018-11-07T07:05:48Z",
        "batchModifiedDate": "2018-11-07T07:05:50Z",
        "batchSource": "SCHEDULER",
        "tokenSource": "TMS",
        "merchantReference": "Merchant Name",
        "batchCaEndpoints": [
          "VISA",
          "MASTERCARD"
        ],
        "status": "COMPLETE",
        "totals": {
          "acceptedRecords": 1,
          "rejectedRecords": 0,
        "updatedRecords": 1,
        "caResponses": 1,
        "caResponsesOmitted": 0
        }
      },
    {
      "_links": {
        "reports": [
          {
            "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches/15416025010730001655343827/report"
              }
            ]
          },
          "batchId": "15416025010730001655343827",
          "batchCreatedDate": "2018-11-07T06:55:01Z",
          "batchModifiedDate": "2018-11-07T06:56:52Z",
          "batchSource": "AMEX_REGISTRY_API",
          "tokenSource": "TMS",
          "batchCaEndpoints": [
          "AMEX"
          ],
          "status": "COMPLETE"
        },
      {
        "_links": {
          "reports": [
            {
              "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches/15402221273070001683984545/report"
            }
          ]
        },
        "batchId": "15402221273070001683984545",
        "batchCreatedDate": "2018-10-22T08:28:47Z",
        "batchModifiedDate": "2018-10-22T08:29:19Z",
        "batchSource": "AMEX_MAINTENANCE",
        "tokenSource": "TMS",
        "batchCaEndpoints": [
        "AMEX"
        ],
        "status": "COMPLETE",
        "totals": {
        "acceptedRecords": 0
        }
      }
    ]
  }
}

Batches are identified by the

batchCreatedDate

and the

batchSource

field values.

Batch Source Values
batchSource Value	Description
AMEX_REGISTRY_API	Batch for American Express token registration. American Express generates a report only when the registration batch contains errors.
AMEX_MAINTENANCE	Daily updates for tokens enrolled in the American Express Cardrefresher service.
TOKEN_API	Updates relating to a one-time request to Visa or Mastercard.
SCHEDULER	Updates relating to a monthly harvest of all tokens.

After you submit a batch for American Express token registration, you can access the batch status through the authenticated GET request using the URL returned in the response. A successful response returns the status of the batch. For information about registering American Express tokens for daily updtes, see Registering Tokens for American Express Daily Updates.

American Express Registry Status Response

{
  "_links": {
    "self": {             
    "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches/15816023535620001646854894/status "        
      },
      "report": [
{                 
        "href": "https://api.smartpayfuse-test.barclaycard/accountupdater/v1/batches/15816023535620001646854894/report"             
      }
    ]
  },
  "batchCaEndpoints": "AMEX",
  "batchCreatedDate": "2020-02-13T13.59.13Z",
  "batchId": "15816023535620001646854894",
  "batchSource": "AMEX_REGISTRY_API",
  "description": "Updates have been applied to your tokens. A batch report is available.",
  "merchantReference": "Merchant Name",
  "status": "COMPLETE",
  "totals": 
  {         
    "acceptedRecords": 999,
    "rejectedRecords": 123,
    "updatedRecords": 0,
    "caResponses": 0,        
    "caResponsesOmitted": 0     
  }
}