PayConexDecryptxShieldConexTECS Platform
API Reference
Request SandboxContact Us

Create a recurring AccountUpdater PAN Update

post
https://api-cert.payconex.net/api/v4/accounts//account-updater/pan/subscribe

Create an Account Updater schedule from raw PAN data

This endpoint allows the creation of a recurring schedule of raw PAN data to be sent to the Account Updater to receive updates

Requirements

  • You must have an active ShieldConex Account linked to your PayConex Account
  • The template reference associated with your ShieldConex account must be valid for PayConex tokenization/detokenization
  • If requesting a response format of payconex:
    • You must have an active PayConex gateway account

Required Scopes

The API Key calling this endpoint must have one of the following scopes:

  • pcx:account_updater:*
  • pcx:account_updater:schedules:create
Path Params
string
required
Body Params

Details about the subscription to create

string
enum

The formats that an Account Updater schedule can be created with, and that the values can be returned in for schedules created without payconex transaction IDs

Allowed Values

FormatDescription
shieldconexThe record is a ShieldConex token
panThe record is a raw card number
Allowed:
cards
array of objects
required
cards*
date

The date that should be used for calculating when a token should be sent to card_sync

string
enum
required

How often a specified action should happen. For example, when creating an account updater schedule, this value will determine how often a PAN will be sent to the Account Updater service to check for updates

Allowed Values

Period NameDescriptionRequires Date
PERIOD_1WEvery one weekYes
PERIOD_2WEvery two weeksYes
PERIOD_1MEvery one monthYes
PERIOD_2MEvery two monthsYes
PERIOD_3MEvery three monthsYes
PERIOD_6MEvery six monthsYes
PERIOD_1YEvery one yearYes
MONTHLY_1_15On the first and fifteenth of every monthNo
MONTHLY_5_20On the fifth and twentieth of every monthNo
MONTHLY_FIRSTOn the first day of each monthNo
MONTHLY_LASTOn the last day of each monthNo
QUARTERLY_1On the first day of each quarterNo
QUARTERLY_LASTOn the last day of each quarterNo
YEARLY_Q1_1Once a year on the first day of Q1No
YEARLY_Q2_1Once a year on the first day of Q3No
YEARLY_Q3_1Once a year on the first day of Q4No
boolean

Whether the schedule is enabled or disabled

Responses

Updated 12 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 12 months ago