Environment URLs

PayConex provides two environments for integration and production usage:

• Certification (Testing) Environment: https://api-cert.payconex.net

Use this environment for development and testing.

• Production (Live) Environment: https://api.payconex.net

Use this environment for live requests.

All requests must be made over HTTPS for security. Append the endpoints described below to the appropriate base URL depending on whether you are testing or running in production.

---

Webhook Services

The PayConex webhook service enables you to receive real-time notifications whenever tokens or cards are updated by card issuers. By setting up a webhook, you can process updates as they occur.

Registering a Webhook

Endpoint:

/api/v4/accounts/{accountId}/webhooks

Methods:

Once registered, your webhook will receive notification POST requests when updates occur.

Managing a Webhook

Endpoint:

/api/v4/accounts/{accountId}/account-updater/webhooks/{webhookID}

Methods:

For more information and examples, please see our guide on Setting up and Managing Webhooks.

---

Card Subscription Services

A subscription, in the context of the PayConex Account Updater, defines a schedule and a set of tokens/cards that PayConex will keep updated. This is unrelated to recurring payment schedules; it specifically handles ongoing card information maintenance.

Creating a Subscription

Endpoints:

• PayConex tokens:

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

• PAN (Primary Account Number) data:

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

• ShieldConex tokens:

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

Methods:

When you create a subscription, you provide the set of tokens/cards and a periodId schedule. PayConex will periodically update these tokens/cards based on issuer data.

For detailed instructions and examples, see Creating Subscriptions.

---

Managing a Subscription

Endpoint:

/api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}

Methods:

See Managing Subscriptions for more information and examples.

Removing Individual Token/Card Records From a Subscription

Endpoint:

/api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}/records/{recordId}

Methods:

Adding Individual Token/Card Records to an Existing Subscription

You can add additional tokens or cards to an existing subscription using the appropriate endpoint depending on the token type:

Endpoints:

• Add PayConex tokens:

  /api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}/payconex
  

• Add ShieldConex tokens:

  /api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}/shieldconex
  

• Add PAN data:

  /api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}/pan
  

Methods:

For more details and examples, see Managing Subscriptions.

---

Retrieving Account Updater Results

Getting Subscription Details (Schedules)

Endpoint:

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

Methods:

Use this endpoint to review the results of the subscription runs that have occurred so far.

Getting Updates Using updateId

When you have a webhook configured, PayConex sends an updateId in each notification. You can retrieve the associated updates using that updateId.

Endpoint:

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

Methods:

For more detailed information, see Retrieving Card Updates.