API Endpoint Index
This page contains all endpoints available for API Hub, with links to the relevant documentation, field descriptions, and API Explorer page for each.
Information
Use the menu to the right to quickly navigate to a specific category of endpoints.
Cards Endpoints
The following table lists endpoints that are used for managing cards, such as creating cards and updating a card status.
Groups Endpoints
The following table lists endpoints that are used for listing and updating card control groups.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| List Card Control Groups | Managing Card Control Groups | List Card Groups - Field Descriptions | List Card Control Groups |
| Update Card Control Groups | Managing Card Control Groups | Update Card Control Groups | Update Card Control Groups |
3DS Credentials Endpoints
The following table lists endpoints for managing 3DS credentials.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Create 3DS Credentials | Managing 3D Secure Credentials | Create 3DS Credentials - Field Descriptions | Create 3DS Credentials |
| List 3DS Credentials | Managing 3D Secure Credentials | List 3DS Credentials - Field Descriptions | List 3DS Credentials |
| Get 3DS Configuration | Managing 3D Secure Credentials | Get 3DS Configuration | |
| Update 3DS Credentials | Managing 3D Secure Credentials | Update 3DS Credentials - Field Descriptions | Update 3DS Credentials |
| Delete 3DS Credentials | Managing 3D Secure Credentials | Delete 3DS Credentials - Field Descriptions | Delete 3DS Credential |
Card PIN Endpoints
The following table lists endpoints that are used for retrieving and updating a card's PIN.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Get PIN | PIN Management | Get PIN - Field Descriptions | Get PIN |
| Set PIN | PIN Management | Set PIN - Field Descriptions | Set PIN |
| Get PIN Status | PIN Management | Get PIN Status - Field Descriptions | Get PIN Status |
| Unblock PIN | PIN Management | Unblock PIN - Field Descriptions | Unblock PIN |
Card CVV Endpoints
The following table lists endpoints that are used for retrieving and unblocking a card's CVV.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Get CVV | Card Verification Value (CVV2) | Get CVV - Field Descriptions | Get CVV |
| Get CVV Status | Card Verification Value (CVV2) | Get CVV Status - Field Descriptions | Get CVV Status |
| Unblock CVV | Card Verification Value (CVV2) | Unblock CVV - Field Descriptions | Unblock CVV |
Transaction Endpoints
The following table lists endpoints that are used for making a retrieving transactions.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Create Card Transaction | Transaction Types | Transactions - Field Descriptions | Load or Unload Card |
| Get Card Transactions | Retrieving Card Balance(s) | Retrieve Card Balance - Field Descriptions | Get Card Transactions |
Product Endpoints
The following table lists endpoints that are used to retrieve product data.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Get Products for Program Manager | Getting Product Data | Get list of Products for a given Program Manager - Field Descriptions | Get list of Products for a given Program Manager |
| Get Product Details | Getting Product Data | Get Product - Field Descriptions | Get Product |
| Get Product Card Stock | Getting Card Stock Data | Get Card Stock Data - Field Descriptions | Get Product Card Stock |
Merchant Endpoints
The following table lists endpoints that are used for managing the Allow and Disallow lists.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Remove Merchant from Allow List | Merchant Allow Lists | Add Merchant to Allow List - Field Descriptions | Remove Merchant from Allow List |
| Remove Merchant from Disallow List | Merchant Disallow Lists | Remove Merchant from Disallow List - Field Descriptions | Remove Merchant from Disallow List |
| Add Merchant to Allow List | Merchant Allow Lists | Add Merchant to Allow List - Field Descriptions | Add Merchant to Allow List |
| Add Merchant to Disallow List | Merchant Disallow Lists | Add Merchant to Disallow List - Field Descriptions | Add Merchant to Disallow List |
Tokenisation Endpoints
The following table lists endpoints that are used for managing card payment tokens.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Get Card Payment Tokens | Get Card Payment Tokens | Get Card Payment Tokens - Field Descriptions | Get a list of Card Payment Tokens |
| Get Card Payment Token Devices | Get Card Payment Token Devices | Get Card Payment Token Devices - Field Descriptions | Get a list of Card Payment Token Devices |
| Update Payment Token Status | Update Payment Token Status | Update Payment Token Status - Field Descriptions | Update Payment Token Status |
| Unbind Device from Token | Unbind Payment Token | Unbind Payment Token - Field Descriptions | Unbind a Device From a Token |
Digital Wallets Endpoints
The following table lists endpoints that are used for managing digital wallets, including In App Provisioning and Click to Pay.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Google In App Provisioning | Google In-App Push Provisioning | Google In-App Push Provisioning - Field Descriptions | Google In App Push Provisioning |
| Apple In App Provisioning | Apple In-App Push Provisioning | Apple In-App Push Provisioning - Field Descriptions | Apple In App Push Provisioning |
| Enrol Data | Enrol Data | Enroll Data - Field Descriptions | Enrol Data |
| Enrol Payment Instruments | Enrol Payment Instruments | Enroll Payment Instruments - Field Descriptions | Enrol Payment Instruments |
Converted Endpoints
The following table lists endpoints that have been converted from our SOAP Web Services solution.
| Endpoint | Documentation | Field Descriptions | API Explorer |
|---|---|---|---|
| Set PIN Control | Set PIN Control | PIN Control - Field Descriptions | Card PIN Control |
| Clear Accumulator | Clear Accumulator | Clear Accumulator - Field Descriptions | Clear Accumulator |
| Card Balance Update | Card Balance Update | Update Card Balance - Field Descriptions | Card Balance Update |
| Customer Enquiry | Customer Enquiry | Customer Enquiry - Field Descriptions | Customer Enquiry |
| Send Message | Send Message | Send Message - Field Descriptions | Send Message |
Event Delivery System
The following table lists endpoints that are used to manage webhooks, notifications and events for the Event Delivery System.
Updated 8 days ago