API End-point Overview
End-point definitions for the Account Updater API.
Environment URLs
There are two different environments for this service. The certification environment it 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
These end-points allow a developer the ability to register, retrieve, modify, and remove webhooks for the account updater API.
End-point: /api/v4/accounts/{accountId}/webhooks
/api/v4/accounts/{accountId}/webhooks
HTTP Method | Description |
---|---|
POST | Create a webhook. |
End-point: /api/v4/accounts/{accountId}/account-updater/webhooks/{webhookID}
/api/v4/accounts/{accountId}/account-updater/webhooks/{webhookID}
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. |
Card Subscription Services
This end-point allows a developer to subscribe to cardholder data so it can be continually updated on a set schedule. You can utilize either PayConex tokens through the payconex/subscribe
end-point or pan information through the pan/subscribe
end-point.
End-point: /api/v4/accounts/{accountId}/account-updater/payconex/subscribe
/api/v4/accounts/{accountId}/account-updater/payconex/subscribe
End-point: /api/v4/accounts/{accountId}/account-updater/pan/subscribe
/api/v4/accounts/{accountId}/account-updater/pan/subscribe
HTTP Method | Description |
---|---|
POST | Subscribe to a card (or cards) for continuous updates on a set schedule. |
This end-point allows a developer to retrieve the details of a previously set up account updater subscription.
End-point: /api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}
/api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}
HTTP Method | Description |
---|---|
GET | Allows the retrieval of the details of previously configured Account Updater subscriptions. |
Retrieving Account Updater Results
These end-points allow a developer to retrieve the updated card results when sent back from the card issuers.
End-point: /api/v4/accounts/{account}/account-updater/schedules/{scheduleId}/results
/api/v4/accounts/{account}/account-updater/schedules/{scheduleId}/results
HTTP Method | Description |
---|---|
GET | Fetches the details and most recent updates for a given scheduleId that was provided in a previous subscribe request. |
End-point: /api/v4/accounts/{account}/account-updater/updates/{updateId}
/api/v4/accounts/{account}/account-updater/updates/{updateId}
HTTP Method | Description |
---|---|
GET | Retrieve the results of a set of updates from the updateId provided in a webhook notification. |
Updated about 2 months ago
For detailed code examples please see the next article for request and response examples.