Account Vault Updates

The accountvaultupdates endpoint is used for bulk management of account vault subscription to automatic card account updates.

Note: Card Account Updates will only be available for Account Vaults with CC payment method. ACH account vaults are not applicable and should not be included in requests as they will be ignored.

Fields

Name Max Format Default POST Comments
action 32 string "subscribe_all" O

Allowed values and their effect include:

  1. "subscribe_all" - will subscribe all of the account vaults provided to updates
  2. "subscribe_recurring_only" - will subscribe only those account vaults provided that are tied to an active recurring.
  3. "unsubscribe_all" - will unsubscribe all of the account vaults provided from updates
  4. "unsubscribe_non_recurring" - will unsubscribe only those acccount vaults that are NOT tied to an active recurring.

If ommitted, action will default to "subscribe_all".

account_vault_id 32 string   O

An array of account_vault_id values for individual account vaults that you would like to effect.

* At least 1 account_vault_id or product_transaction_id value is required, although both can be provided.

product_transaction_id 32 string   O

An array or product_transaction_id values whose associated account vaults should be affected.

* At least 1 account_vault_id or product_transaction_id value is required, although both can be provided.

* R = Required, O = Optional, Y = Yes, N = No

Actions

Subscribe to Updates

The default action on this endpoint is "subscribe_all". If action is ommitted, then "subscribe_all" is the assumed action. If you only need to subscribe those Account Vaults that are associated with an active Recurring, provide the action field with a value of "subscribe_recurring_only" as you will see demonstrated in the "Using Both" tab below.

POST /v2/accountvaultupdates

{
	"accountvaultupdate": {
	    "action": "subscribe_all", // Default action.
		"account_vault_id": [
			"23048230sdf0js230js0"
		]
	}
}
{
	"accountvaultupdate": {
	    "action": "subscribe_all",
		"product_transaction_id": [
			"xvs9djs9f23rnsdfn93rskdfnwr0"
		]
	}
}
{
	"accountvaultupdate": {
	    "action": "subscribe_recurring_only", // affect Recurring Account Vaults Only
		"account_vault_id": [
			"23048230sdf0js230js0",
			"as8d9fja9dunt23k4jnd"
		],
		"product_transaction_id": [
			"xvs9djs9f23rnsdfn93rskdfnwr0",
			"xkn92395jsf82skh2rksdfns910a"
		]
	}
}

Unsubscribe From Updates

If you only need to unsubscribe those Account Vaults that are NOT associated with an active Recurring, provide the action field with a value of "unsubscribe_non_recurring" as you will see demonstrated in the "Using Both" tab below.

POST /v2/accountvaultupdates

{
	"accountvaultupdate": {
	    "action": "unsubscribe_all",
		"account_vault_id": [
			"23048230sdf0js230js0"
		]
	}
}
{
	"accountvaultupdate": {
	    "action": "unsubscribe_all",
		"product_transaction_id": [
			"xvs9djs9f23rnsdfn93rskdfnwr0"
		]
	}
}
{
	"accountvaultupdate": {
	    "action": "unsubscribe_non_recurring", // affect non-Recurring Account Vaults Only
		"account_vault_id": [
			"23048230sdf0js230js0"
		],
		"product_transaction_id": [
			"xvs9djs9f23rnsdfn93rskdfnwr0"
		]
	}
}