For AI agents: visit https://cardsapidocs.thredd.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Home Documentation Recipes API Explorer What's Changed?

thredd.ai Documentation Portal

Documentation

thredd.ai Documentation Portal

Home Documentation Recipes API Explorer What's Changed?

Getting Started

Overview
Accessing API Hub
Gaining Access to the Developer Portal
Generate Authentication Tokens
Configuring Headers
What is Idempotency?
Accessing the API Hub with mTLS
Introduction to Cardholders

API Index

API Endpoint Index

Cards

Creating a Card
Retrieve a Card
- Retrieve Card - Field Descriptions
Updating a Card
- Update Card - Field Descriptions
Converting a Card from Virtual to Physical
- Convert Card - Field Descriptions
Card Status
PIN Management
Card Verification Value (CVV2)
Card Renewal, Card Replacement & Lost Cards
- Replace Card - Field Descriptions
- Renew Card - Field Descriptions
Get Card Image
- Get Card Image - Field Descriptions
Cardholder Details
- Cardholder Details - Field Descriptions
BLC Complete Card Replacement
- BLC Complete Card Replacement - Field Descriptions
Introduction to Card Limits
Get Full PAN
- Get Full PAN - Field Descriptions
Bulk Create Physical Cards
Card Acceptors
- Get Card Acceptors - Field Descriptions

Card control Groups

Introduction to Card Control Groups
Managing Card Control Groups
- List Card Groups - Field Descriptions
- Update Card Control Groups - Field Descriptions

Card Transactions and Balances

Introduction to Card Transactions & Balances
Transaction Types
- Transactions - Field Descriptions
Retrieving Card Balance(s)
- Retrieve Card Balance - Field Descriptions
List Card Transactions
- List Card Transactions - Field Descriptions
Load and Unload Card for Issuer
- Load and Unload Card for Issuer - Field Descriptions

3D Secure Enrolment

Introduction to 3D Secure
Managing 3D Secure Credentials

Product

Getting Product Data
- Get Product - Field Descriptions
- Get list of Products for a given Program Manager - Field Descriptions
Getting Card Stock Data
- Get Card Stock Data - Field Descriptions

Custom PAN

Customisable Card Number

Merchant

Merchant Allow Lists
Merchant Disallow Lists

Sending Secure data

Introduction to Sending Secure Data
Get Card Data
- Get Encrypted Data - Field Descriptions

Card Tokenisation

Introduction to Card Tokenisation
Get Card Payment Tokens
- Get Card Payment Tokens - Field Descriptions
Get Card Payment Token Details
- Get Card Payment Token Details - Field Descriptions
Get Card Payment Token Devices
- Get Card Payment Token Devices - Field Descriptions
Unbind Payment Token
- Unbind Payment Token - Field Descriptions
Update Payment Token Status
- Update Payment Token Status - Field Descriptions

Provisioning Enablement

Introduction to Provisioning Enablement
Google Unified Push Provisioning
- Google In-App Push Provisioning - Field Descriptions
Apple In-App Push Provisioning
- Apple In-App Push Provisioning - Field Descriptions
Get Apple Wallet Verification
- Get Apple Wallet Verification - Field Descriptions
Samsung In-App Push Provisioning
- Samsung In-App Push Provisioning - Field Descriptions
Apple Web Push Provisioning
- Apple Web Push Provisioning - Field Descriptions

Click to Pay

Introduction to Click to Pay
Enroll Data
- Enroll Data - Field Descriptions
Get Payment Instrument Information
- Get Payment Instrument Information - Field Descriptions
Enroll Payment Instruments
- Enrol Payment Instruments - Field Descriptions
Manage Payment Instrument
- Manage Payment Instrument - Field Descriptions
Manage Consumer Information
- Manage Consumer Information - Field Descriptions
Delete Consumer Information
Delete Payment Instrument

Webhooks

Introduction to Webhooks
- Webhook Event Codes
Create and View Webhooks
Manage Webhook Details
Manage Event Subscriptions
- Get Event Subscriptions - Field Descriptions
- Add Event Subscriptions - Field Descriptions
Manage Notifications

Fraud

Introduction to the Fraud Alert Service
Fraud Login Event
- Fraud Login Event - Field Descriptions

Tokenisation Event Notifications

Introduction to Tokenisation Event Notifications
Token Authorisation Request Events
Activation Code Notification Events
Tokenisation Complete Notification Events
Tokenisation Event Notification Events
Tokenisation Status Update Failure Notification

Transaction Confirmation

Introduction to Transaction Confirmation Events
Transaction Confirmation Events
- Transaction Confirmation Event - Field Descriptions
Create Configuration
- Create Configuration - Field Descriptions
List Configurations
- List Configurations - Field Descriptions
Update Configuration
- Update Configuration - Field Descriptions
Update Configuration Status
- Update Configuration Status - Field Descriptions
Get Configuration by configId
- Get Configuration by configId - Field Descriptions
Delete Configuration

SOAP Converted Endpoints

Set PIN Control
- PIN Control - Field Descriptions
Customer Enquiry
- Customer Enquiry - Field Descriptions
Clear Accumulator
- Clear Accumulator - Field Descriptions
STIP Balance Update
- STIP Balance Update - Field Descriptions
Send Message
- Send Message - Field Descriptions
- Event ID

Our Products and Services

External Host Interface (EHI)
Thredd Portal: Card and Transaction Management
Chargebacks
Tokenisation (Digital Wallets)
Card Transaction System (CTS)
3D Secure
Transaction XML Reports
Virtual Cards
Fraud Transaction Monitoring
Smart Client

Glossary

Glossary

FAQs

General FAQs

Contact Us

Contact Us

Appendices

Account Types
Action Codes
Card Name Permitted Characters
Currency Codes
Item Source Types
Load Fund Types
Load Sources
Postcode Permitted Characters
Processing of Phone Numbers
Transaction Codes

Open Banking

Introduction to Open Banking
Register Open Banking Customer
- Register Open Banking - Field Descriptions
Get All Customer Accounts
- Get All Customer Accounts - Field Descriptions
Get Customer Account Details
- Get Customer Account Details - Field Descriptions
Get Institution Branding
- Get Institution Branding - Field Descriptions
Create Microdeposit Verification Link
- Create Microdeposit Verification Link - Field Descriptions

Aliasing

Introduction to Visa Alias Directory
Create Alias
- Create Alias - Field Descriptions
Get Alias
- Get Alias - Field Descriptions
Update Alias
- Update Alias - Field Descriptions
Update Alias Status
- Update Alias Status - Field Descriptions
Delete Alias
Get Alias ID from Value
- Get Alias ID from Value - Field Descriptions
Get Alias ID from External ID
- Get Alias ID from External ID - Field Descriptions
Create Additional Alias
- Create Additional Alias - Field Descriptions
Delete Additional Alias
Create Payment Credential
- Create Payment Credential - Field Descriptions
Get All Payment Credentials
- Get All Payment Credentials - Field Descriptions
Get Payment Credential
- Get Payment Credential - Field Descriptions
Update Payment Credential
- Update Payment Credential - Field Descriptions
Delete Payment Credential

Powered by

Postcode Permitted Characters

You can use the following characters in the Postcode field:

Arabic numerals "0" to "9"
letters of the ISO basic Latin alphabet (A-Z, a-z)
spaces
hyphens(-).