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
Thredd Cards API
HomeDocumentationRecipesAPI ExplorerWhat's Changed?
thredd.aiDocumentation PortalThredd Cards API
Documentation
thredd.aiDocumentation Portal
HomeDocumentationRecipesAPI ExplorerWhat'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
    • Create Card - Field Descriptions
    • Card Manufacturer Approved Characters
    • Master Virtual Cards
    • Primary and Secondary Cards
  • 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
    • Card Status Codes
    • Retrieve Card Status - Field Descriptions
    • Update Card Status - Field Descriptions
  • PIN Management
    • Set PIN - Field Descriptions
    • Get PIN - Field Descriptions
    • Get PIN Status - Field Descriptions
    • Unblock PIN - Field Descriptions
  • Card Verification Value (CVV2)
    • Get CVV - Field Descriptions
    • Get CVV Status - Field Descriptions
    • Unblock CVV - Field Descriptions
  • 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 Card Limits (Product Level)
      • List Cards Limits - Field Descriptions (Product Level)
    • Get Card Limits (Card Level)
    • Set Card Limits (Card Level)
  • Get Full PAN
    • Get Full PAN - Field Descriptions
  • Bulk Create Physical Cards
    • Create Bulk Physical Cards - Field Descriptions
    • Get Bulk Card Progress - Field Descriptions
    • Get Bulk Card Tokens - Field Descriptions
  • 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
    • Create 3DS Credentials - Field Descriptions
    • List 3DS Credentials - Field Descriptions
    • Update 3DS Credentials - Field Descriptions
    • Delete 3DS Credentials - Field Descriptions

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
    • Validate Customisable Card Number - Field Descriptions
    • Create Card with Customisable Card Number - Field Descriptions
    • Create Card with Thredd Generated Card Number

Merchant

  • Merchant Allow Lists
    • Get Merchant Allow List - Field Descriptions
    • Add Merchant to Allow List - Field Descriptions
    • Remove Merchant from Allow List - Field Descriptions
  • Merchant Disallow Lists
    • Get Merchant Disallow List - Field Descriptions
    • Add Merchant to Disallow List - Field Descriptions
    • Remove Merchant from Disallow List - Field Descriptions

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
      • Event Code 101 - Fraud Rule Triggered by a Transaction
      • Event Code 102 - Fraud Acknowledgement Notification
      • Event Code 103 - Card Status Change
      • Event Code 104 - Custom PAN Creation
      • Event Code 105 - Payment Manual Review Outcome
      • Event Code 106 - Tokenisation Authorisation Request (TAR)
      • Event Code 107 - Activation Code Notification (ACN)
      • Event Code 108 - Tokenisation Complete Notification (TCN)
      • Event Code 109 - Tokenisation Event Notification (TEN)
      • Event Code 110 - Tokenisation Status Update Failure Notification (TFN)
      • Event Code 111 - Apata Finalised Event
      • Event Code 112 - Transaction Confirmation Event
      • Event Code 115 - FTM Alert Creation
      • Event Code 117 - Open Banking Registration
  • Create and View Webhooks
    • Create Webhook - Field Descriptions
    • List Webhooks - Field Descriptions
    • Get Webhook Details - Field Descriptions
    • Ping Webhook - Field Descriptions
  • Manage Webhook Details
    • Get Webhook Details - Field Descriptions
    • Update Webhook Details - Field Descriptions
    • Update Webhook Status - Field Descriptions
  • Manage Event Subscriptions
    • Get Event Subscriptions - Field Descriptions
    • Add Event Subscriptions - Field Descriptions
  • Manage Notifications
    • Get Notifications for Event Code - Field Descriptions
    • Get Notification Details - Field Descriptions
    • Get Undelivered Notification Details - Field Descriptions
    • Resend Thredd Notifications - Field Descriptions

Fraud

  • Introduction to the Fraud Alert Service
    • Fraud Alert Response FAQs
    • Fraud Detection Events - Field Descriptions
    • Fraud Action Events - Field Descriptions
    • Fraud Alert Response - Field Descriptions
  • 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 

Introduction to Card Transactions & Balances

    • Card Transactions
    • Card Balance
      • Updating the card balance