Creating Subscriptions

This section provides request examples for the various operations that are available for subscribing cards with the service.

Request Parameters

Each end-point below accepts a JSON object as the request body and will require the following parameters to be present. End-point-specific parameters will be outlined in the relevant examples.

🚧

Note on the pan Response Format

Using this option currently requires an account on our ShieldConex platform. If this option is something you would like to make use of please let us know during your integration.

Using PayConex Tokens

To subscribe a PayConex token (or tokens) to be updated the following end-point can be used.

/api/v4/accounts/{accountId}/account-updater/payconex/subscribe

In addition to the parameters above, the request body would also include a token parameter. This parameter is an array of PayConex transaction_id values to include in the subscription request.

Example Request Body:

{
  "responseFormat": "payconex",
  "tokens": [
    {
      "token": "100001234567"
    }
  ],
  "periodDate": "2022-02-01",
  "periodId": "PERIOD_1W"
}

An HTTP response code of 201 indicates a successful request and the response body would be a JSON object.

An example response would appear something like this:

Example Response Body:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "periodId": "PERIOD_1W",
  "periodDate": "2022-10-04",
  "responseFormat": "payconex",
  "enabled": true,
  "createdAt": "string",
  "updatedAt": "string",
  "tokens": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "token": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "type": "payconex",
      "enabled": true,
      "expiry": "1230"
    }
  ]
}

Using PAN Data

To subscribe a card's PAN data for account updates the following end-point can be used.

/api/v4/accounts/{accountId}/account-updater/pan/subscribe

In addition to the parameters above, the request body would also include a cards parameter. This parameter is an array of card data values to include in the subscription request. Each element of the array would include the card number in the pan parameter and the expiration date for the card in the expiry parameter.

Example Request Body:

{
  "responseFormat": "payconex",
  "cards": [
    {
      "pan": "4444333322221111",
      "expiry": "1230"
    }
  ],
  "periodDate": "1643673600",
  "periodId": "PERIOD_1W"
}

An HTTP response code of 201 indicates a successful request and the response body would be a JSON object.

An example response would appear something like this:

Example Response Body:

{
  "id": "cssr_5cd5614dd4514735ae2d274597824c5e",
  "periodId": "PERIOD_1W",
  "periodDate": "2022-10-11",
  "responseFormat": "payconex",
  "enabled": true,
  "createdAt": "2022-10-11T02:20:21.643Z",
  "updatedAt": "2022-10-11T02:20:21.643Z",
  "tokens": [
    {
      "id": "cssr_5cd5614dd4514735ae2d274597824c5e",
      "token": "string",
      "createdAt": "2022-10-11T02:20:21.643Z",
      "updatedAt": "2022-10-11T02:20:21.643Z",
      "type": "payconex",
      "enabled": true,
      "expiry": "1230"
    }
  ]
}

Response Parameters

Period ID Definitions