Account Updater

Subscribe

post

https://sandbox.vgsapi.comhttps://vgsapi.com

/cards/{card_id}/card-update-subscriptions

To begin receiving automated updates for a card, it must be enrolled in account updater using the Subscribe operation. This API enables continuous tracking of card status with the issuing network. If the card is already subscribed, the system will automatically skip re-enrollment. Subscribing ensures that your application will receive updates on card replacements, expiration changes, and other important lifecycle events, keeping your records accurate without customer input.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

card_idstringRequired

Responses

200

Card subscription details

application/vnd.api+json

201

Card subscription details

application/vnd.api+json

400

The request was invalid.

application/vnd.api+json

403

Valid credentials were provided, but they do not permit access to this resource.

application/vnd.api+json

404

Resource not found.

application/vnd.api+json

500

Internal Server Error

application/vnd.api+json

503

Service Unavailable

application/json

post

/cards/{card_id}/card-update-subscriptions

HTTPcURLJavaScriptPython

POST /cards/{card_id}/card-update-subscriptions HTTP/1.1
Host: sandbox.vgsapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "type": "card_update_subscriptions",
    "id": "CUS9ecrtBiwFpyT4qCtStYp4e",
    "attributes": {
      "created_at": "2025-01-10T18:23:48.96686",
      "state": "enrolled",
      "updated_at": "2025-01-10T18:23:48.966869"
    }
  }
}

Unsubscribe

delete

https://sandbox.vgsapi.comhttps://vgsapi.com

/cards/{card_id}/card-update-subscriptions

When a card is no longer needed for Account Update tracking, you can unsubscribe it from account updater using a DELETE call to the Card API. This removes account updater tracking from the specified card, and the system will no longer request or deliver updates for it. After unsubscription:

• The account updater object is removed from the card’s metadata.

• No future updates will be received for this card.

• The card is considered unenrolled from account updater in the CMP system. This is useful when cards are retired, no longer relevant for recurring billing, or should be managed manually.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

card_idstringRequired

Responses

204

Card unsubscribed

401

No credentials were provided, or the provided credentials were expired.

application/vnd.api+json

403

Valid credentials were provided, but they do not permit access to this resource.

application/vnd.api+json

404

Resource not found.

application/vnd.api+json

424

Underlying service experiences high load

application/vnd.api+json

500

Internal Server Error

application/vnd.api+json

503

Service Unavailable

application/json

delete

/cards/{card_id}/card-update-subscriptions

HTTPcURLJavaScriptPython

DELETE /cards/{card_id}/card-update-subscriptions HTTP/1.1
Host: sandbox.vgsapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

On-Demand updates

post

https://sandbox.vgsapi.comhttps://vgsapi.com

/cards/{card_id}/check

The On-Demand Card Updates API offers a stateless, real-time way to check for the latest card information without enrolling the card in account updater. This feature supports Visa and Mastercard only and is ideal for one-time update lookups. For American Express (AMEX) and Discover, updates are only available for cards that have already been enrolled in account updater via VGS. This API is useful for verifying card updates without committing to long-term account updater tracking. It returns the most current data available at the time of the request, helping businesses make decisions in real time without the overhead of subscription.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

card_idstringRequired

Responses

200

Card updates

application/vnd.api+json

400

The request was invalid.

application/vnd.api+json

401

No credentials were provided, or the provided credentials were expired.

application/vnd.api+json

403

Valid credentials were provided, but they do not permit access to this resource.

application/vnd.api+json

404

Resource not found.

application/vnd.api+json

424

Underlying service experiences high load

application/vnd.api+json

500

Internal Server Error

application/vnd.api+json

503

Service Unavailable

application/json

post

/cards/{card_id}/check

HTTPcURLJavaScriptPython

POST /cards/{card_id}/check HTTP/1.1
Host: sandbox.vgsapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "type": "card_updates",
    "attributes": {
      "updated_values": [
        {
          "field_name": "pan",
          "old_value": 4211111111111112,
          "new_value": 4311111111111113
        },
        {
          "field_name": "exp_month",
          "old_value": 4,
          "new_value": 6
        },
        {
          "field_name": "exp_year",
          "old_value": 24,
          "new_value": 33
        }
      ],
      "event": "updated"
    }
  }
}