Environment URLs

There are two different environments for this service. The certification environment is for testing integrations, and production is for live production requests.

The certification environment URL is: https://api-cert.payconex.net
The production environment URL is: https://api.payconex.net

The end-point definitions below describe the services that each end-point can provide via different HTTP methods.

Webhook Services

The PayConex webhook service allows a developer to create a webhook that will receive notifications when tokens/card accounts are updated by the card issuers.

Registering a Webhook

This end-point allows a developer the ability to create a webhook.

End-point(s)

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

HTTPS Method(s)

HTTP Method	Description
POST	Create a webhook.

Managing a Webhook

This end-point allows the retrieval, modification, or removal of a previously configured webhook.

End-point(s)

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

HTTPS Method(s)

HTTP Method	Description
GET	Retrieve the details of a previously created webhook.
PATCH	Modify the details of a previously created webhook.
DELETE	Remove a previously created webhook.

If you'd like to read more about these functions and see some example request/response information please see our guide on Setting up and Managing Webhooks.

Card Subscription Services

A PayConex Account Updater subscription is an object that contains an array of token/card data along with instructions for how frequently PayConex should update the card data on file.

📘
Note
The term subscription in this context is not tied to a recurring payment schedule within PayConex. In this context it means you are subscribing token/card data to be updated on a set schedule.
The PayConex account updater service does work with the recurring payment schedules in PayConex natively. If you're interested in using PayConex for recurring payments please see our guide on how to Schedule Transactions.

Creating a Subscription

These end-points allow a developer to subscribe customer's stored token/card data for continuous updates by the card issuers.

When a subscription is created PayConex will issue the token/card data records for updates on a set schedule. The records and schedule are defined as part of the API request body.

PayConex tokens can be sent through the payconex/subscribe end-point, pan information through the pan/subscribe end-point, or ShieldConex tokens by using the shieldconex/subscribe end-point.

End-point(s)

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

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

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

HTTPS Method(s)

HTTP Method	Description
POST	Subscribe to a card (or cards) for continuous updates on a set schedule.

If you'd like to read more about these functions and see some example request/response information please see our guide on Creating Subscriptions.

Managing a Subscription

This end-point allows a developer to retrieve/change the details of or delete a previously set up account updater subscription.

End-point(s)

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

HTTPS Method(s)

HTTP Method	Description
GET	Allows the retrieval of the details of previously configured Account Updater subscriptions.
PATCH	Update the given subscription with new details or configuration.
DELETE	Remove/delete the given subscription schedule so that account updates no longer occur.

Removing Individual Token/Card Records to a Subscription

This end-point allows the removal of a specific record that is part of an account updater subscription.

End-point(s)

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

HTTPS Method(s)

HTTP Method	Description
DELETE	Remove/delete the given card/token record from the given subscription.

Adding Individual Token/Card Records to a Subscription

These end-points allow new tokens or cards to be added to an existing subscription using a subscriptionId.

PayConex tokens can be sent through the payconex/subscribe end-point, pan information through the pan/subscribe end-point, or ShieldConex tokens by using the shieldconex/subscribe end-point.

End-point(s)

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

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

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

HTTPS Method(s)

HTTP Method	Description
POST	Add a new token/account record to an existing subscription.

If you'd like to read more about these functions and see some example request/response information please see our guide on Managing a Subscription.

Retrieving Account Updater Results

Getting Subscription Details

This end-point returns the full details of a subscription. The id of a previous subscription request/response is used as the scheduleId.

End-point(s)

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

HTTPS Method(s)

HTTP Method	Description
GET	Fetches the details and most recent updates for a given `scheduleId` that was provided in a previous `subscribe` request.

Getting Updates

After configuring a webhook and an account updater subscription PayConex will issue notifications to the webhook URL provided. When a webhook notification is received this end-point can be used with the resulting updateId to retrieve all updates associated with the webhook notification.

End-point(s)

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

HTTPS Method(s)

HTTP Method	Description
GET	Retrieve the results of a set of updates from the `updateId` provided in a webhook notification.

If you'd like to read more about these functions and see some example request/response information please see our guide on Retrieving Card Updates.