Retrieving Card Updates

Overview

There are two functions for retrieving the card updates associated with a subscription:

• Retrieving updates after a webhook notification
• Retrieving most recent results for a given schedule ID

Retrieving Updates after a Webhook Notification

This is likely the primary method you will want to use for retrieving your updated card information after a webhook notification. This request is an HTTP GET request that contains a updateId within the URL path.

The updateId represents a group of records that were updated at a single point in time. It is not strictly linked to a subscription schedule.

For example, you may have a subscription schedule that contains three records. On day 1, records 1 and 2 are updated. An updateId is generated for those two records. These two updates are returned when this endpoint is called. On day 2, an update may arrive for the third card. It is assigned a new updateId and this update only is returned when this endpoint is called.

GET /api/v4/accounts/{accountId}/account-updater/updates/{updateId}

*Required Scopes: pcx:account_updater:results:read

HTTP response code 200 indicates a successful request. The body of the response is a JSON array containing a JSON object for each update for the given updateId. It has the following format.

This updateId is under mostRecentUpdate.updateId. See Retrieving Most Recent Results for a Given Schedule ID.

[
  {
    "id": "auru_2f418b31a4ce4736a54ed7d90126d8fe",
    "oldExpiry": "1230",
    "newExpiry": "1235",
    "oldToken": "123456789101",
    "newToken": "123456789121",
    "updateId": "aupres_7d7366c9b6564b9abff22829c3b9ce66",
    "updatedAt": "2022-10-11T03:06:47.488Z",
    "status": "valid",
    "accountUpdaterScheduleRecordId": "cssr_d468d4061ab44c309a46d3c3f4fd96e0",
    "accountUpdaterScheduleId" : "css_d4c2c2cd09924d71abad464ac3004a17",
    "format": "payconex"
  }
]

📘

Note

• oldToken: The old token that was provided to be updated (Note: this can be either a ShieldConex® token (bfid), PayConex™ token (token_id), or raw PAN data depending on how the schedule was created. See responseFormat).
• newToken: The updated new token (Note: this can be either a ShieldConex token (bfid), PayConex™ token (the new token_id for reissuing transactions via SLAPI or QSAPI), or raw PAN data depending on how the schedule was created. See responseFormat).

Update Response Parameters

Retrieving Most Recent Results for a Given Schedule ID

This endpoint allows you to check on the status of all records associated with a given scheduleId. The scheduleId is returned as cardSyncScheduleId after a subscription is created creating a subscription.

This method is handy for cases where you may need to get the most recent data independently of the record actually being updated or the webhook receiving a notification. Each record contains the mostRecentUpdate in the format of an update above.

This request is a HTTP GET request that contains a scheduleId within the URL path of the endpoint.

GET /api/v4/accounts/{accountId}/account-updater/schedules/{scheduleId}/results

*Required Scopes: pcx:account_updater:results:read

Response

{
  "id": "css_d4c2c2cd09924d71abad464ac3004a17",
  "periodId": "PERIOD_1W",
  "periodDate": "2024-07-12",
  "responseFormat": "shieldconex",
  "enabled": true,
  "createdAt": "2022-10-11T03:48:35.140Z",
  "updatedAt": "2022-10-11T03:48:35.140Z",
  "templateRef": "shieldconex_template_reference",
  "records": [
    {
      "id": "css_5cd5614dd4514735ae2d274597824c5e",
      "token": "transactionId",
      "createdAt": "2024-07-12T03:48:35.140Z",
      "updatedAt": "2024-07-12T03:48:35.140Z",
      "type": "shieldconex",
      "enabled": true,
      "expiry": "1230",
      "mostRecentUpdate": {
        "id": "auru_2f418b31a4ce4736a54ed7d90126d8fe",
        "oldExpiry": "1230",
        "newExpiry": "1235",
        "oldToken": "123456789101",
        "newToken": "4444333322221111",
        "updateId": "aupres_7d7366c9b6564b9abff22829c3b9ce66",
        "updatedAt": "2022-10-11T03:48:35.140Z",
        "status": "valid",
        "accountUpdaterScheduleRecordId": "cssr_d468d4061ab44c309a46d3c3f4fd96e0",
        "format": "shieldconex"
      }
    }
  ]
}

Result Response Parameters

Update Statuses

The table below contains a list of all the possible values that can come back from the card issuers as a notification or update.