# Thredd Cards API Documentation

> Discover the API that powers the award winning issuer processing platform enabling next-generation payment technology.

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Overview](https://cardsapidocs.thredd.com/docs/getting-started-1.md)
- [Accessing the API](https://cardsapidocs.thredd.com/docs/accessing-the-api.md)
- [Set up on Production](https://cardsapidocs.thredd.com/docs/integration-steps-set-up-on-production-environment.md)
- [Go Live Checklist](https://cardsapidocs.thredd.com/docs/onboarding-checklist.md)
- [What is Idempotency?](https://cardsapidocs.thredd.com/docs/what-is-idempotency.md)
- [Accessing the Cards API with mTLS](https://cardsapidocs.thredd.com/docs/authenticating-cards-api-with-mtls.md)
- [Creating a Card](https://cardsapidocs.thredd.com/docs/create-card-2.md)
- [Create Card - Field Descriptions](https://cardsapidocs.thredd.com/docs/create-card-field-descriptions.md)
- [Master Virtual Cards](https://cardsapidocs.thredd.com/docs/master-virtual-cards.md)
- [Primary and Secondary Cards](https://cardsapidocs.thredd.com/docs/parent-child-cards.md)
- [Retrieve a Card](https://cardsapidocs.thredd.com/docs/retrieve-a-card.md)
- [Updating a card](https://cardsapidocs.thredd.com/docs/updating-a-card.md)
- [Update Card - Field Descriptions](https://cardsapidocs.thredd.com/docs/update-card-field-descriptions.md)
- [Card Status](https://cardsapidocs.thredd.com/docs/card-status.md)
- [Card Status Codes](https://cardsapidocs.thredd.com/docs/card-status-codes.md)
- [Retrieve Card Status - Field Descriptions](https://cardsapidocs.thredd.com/docs/card-status-field-descriptions.md)
- [PIN Management](https://cardsapidocs.thredd.com/docs/card-personal-identification-number-pin.md)
- [Card Verification Value (CVV2)](https://cardsapidocs.thredd.com/docs/card-verification-value-cvv.md)
- [Card Renewal, Card Replacement & Lost Cards](https://cardsapidocs.thredd.com/docs/card-renewal-and-replacement.md)
- [Replace Card - Field Descriptions](https://cardsapidocs.thredd.com/docs/replace-card-field-descriptions.md)
- [Renew Card - Field Descriptions](https://cardsapidocs.thredd.com/docs/replace-card-field-descriptions-copy.md)
- [Get Card Image](https://cardsapidocs.thredd.com/docs/get-card-image.md)
- [Cardholder Details - Field Descriptions](https://cardsapidocs.thredd.com/docs/cardholder-details-field-descriptions.md)
- [Get Card Limits (Product Level)](https://cardsapidocs.thredd.com/docs/get-card-limits.md)
- [List Cards Limits - Field Descriptions (Product Level)](https://cardsapidocs.thredd.com/docs/get-cards-limits-field-descriptions.md)
- [Bulk Create Physical Cards](https://cardsapidocs.thredd.com/docs/bulk-create-cards.md)
- [Create Bulk Physical Cards - Field Descriptions](https://cardsapidocs.thredd.com/docs/create-bulk-physical-cards-field-descriptions.md)
- [Get Bulk Card Progress - Field Descriptions](https://cardsapidocs.thredd.com/docs/get-bulk-card-progress.md)
- [Get Bulk Card Tokens - Field Descriptions](https://cardsapidocs.thredd.com/docs/get-bulk-card-tokens-field-descriptions.md)
- [Card Acceptors](https://cardsapidocs.thredd.com/docs/card-acceptors.md)
- [Introduction to Card Control Groups](https://cardsapidocs.thredd.com/docs/introduction-to-card-controls.md)
- [Managing Card Control Groups](https://cardsapidocs.thredd.com/docs/card-controls.md)
- [Transaction Types](https://cardsapidocs.thredd.com/docs/loading-unloading-a-card.md)
- [List Card Transactions](https://cardsapidocs.thredd.com/docs/retrieving-card-transactions.md)
- [Load and Unload Card for Issuer](https://cardsapidocs.thredd.com/docs/load-and-unload-bin-sponsor.md)
- [Load and Unload Card for Issuer - Field Descriptions](https://cardsapidocs.thredd.com/docs/load-and-unload-bin-sponsor-field-descriptions.md)
- [Introduction to 3D Secure](https://cardsapidocs.thredd.com/docs/introduction-to-3d-secure.md)
- [Managing 3D Secure Credentials](https://cardsapidocs.thredd.com/docs/creating-3d-secure-credentials.md)
- [Getting Product Data](https://cardsapidocs.thredd.com/docs/getting-product-data.md)
- [Customisable Card Number](https://cardsapidocs.thredd.com/docs/custom-cards.md)
- [Validate Customisable Card Number - Field Descriptions](https://cardsapidocs.thredd.com/docs/validate-custom-pan-field-descriptions.md)
- [Create Card with Customisable Card Number - Field Descriptions](https://cardsapidocs.thredd.com/docs/create-card-with-custom-pan-field-descriptions.md)
- [Create Card with Thredd Generated Card Number](https://cardsapidocs.thredd.com/docs/create-card-with-thredd-generated-card-number.md)
- [Merchant Allow Lists](https://cardsapidocs.thredd.com/docs/merchant-allow-lists.md)
- [Merchant Disallow Lists](https://cardsapidocs.thredd.com/docs/merchant-disallow-lists.md)
- [Introduction to Sending Secure Data](https://cardsapidocs.thredd.com/docs/introduction-to-sending-secure-data.md)
- [Get Card Data](https://cardsapidocs.thredd.com/docs/get-encrypted-data.md)
- [Get Card Data - Field Descriptions](https://cardsapidocs.thredd.com/docs/get-card-data-field-descriptions.md)
- [Introduction to Card Tokenisation](https://cardsapidocs.thredd.com/docs/introduction-to-card-tokenization.md)
- [Get Card Payment Tokens](https://cardsapidocs.thredd.com/docs/get-card-payment-tokens.md)
- [Get Card Payment Tokens - Field Descriptions](https://cardsapidocs.thredd.com/docs/get-card-payment-tokens-field-descriptions.md)
- [Get Card Payment Token Details](https://cardsapidocs.thredd.com/docs/get-card-payment-token-details.md)
- [Get Card Payment Token Details - Field Descriptions](https://cardsapidocs.thredd.com/docs/get-card-payment-token-details-field-descriptions.md)
- [Unbind Payment Token](https://cardsapidocs.thredd.com/docs/unbind-payment-token.md)
- [External Host Interface (EHI)](https://cardsapidocs.thredd.com/docs/external-host-interface-ehi.md)
- [Thredd Portal: Card and Transaction Management](https://cardsapidocs.thredd.com/docs/thredd-portal.md)
- [Chargebacks](https://cardsapidocs.thredd.com/docs/chargebacks.md)
- [Tokenisation (Digital Wallets)](https://cardsapidocs.thredd.com/docs/tokenisation.md)
- [Card Transaction System (CTS)](https://cardsapidocs.thredd.com/docs/card-test-service-cts.md)
- [3D Secure](https://cardsapidocs.thredd.com/docs/3d-secure.md)
- [Transaction XML Reports](https://cardsapidocs.thredd.com/docs/transaction-xml-reports.md)
- [Virtual Cards](https://cardsapidocs.thredd.com/docs/virtual-cards.md)
- [Fraud Transaction Monitoring](https://cardsapidocs.thredd.com/docs/fraud-transaction-monitoring.md)
- [Smart Client](https://cardsapidocs.thredd.com/docs/smart-client.md)
- [Glossary](https://cardsapidocs.thredd.com/docs/glossary.md)
- [General FAQs](https://cardsapidocs.thredd.com/docs/general-faqs.md)
- [Contact Us](https://cardsapidocs.thredd.com/docs/contact-us.md)

## API Reference
- [API Explorer](https://cardsapidocs.thredd.com/reference/introduction-1.md)
- [Errors](https://cardsapidocs.thredd.com/reference/errors.md)
- [Using Postman](https://cardsapidocs.thredd.com/reference/using-postman.md)
- [Create a Card](https://cardsapidocs.thredd.com/reference/create-card.md)
- [Retrieve a Card](https://cardsapidocs.thredd.com/reference/retrieve-card.md)
- [Update a Card](https://cardsapidocs.thredd.com/reference/update-card.md)
- [Renew a Card](https://cardsapidocs.thredd.com/reference/renew-card.md)
- [Replace a Card](https://cardsapidocs.thredd.com/reference/replace-card.md)
- [Retrieve Card Status](https://cardsapidocs.thredd.com/reference/retrieve-card-status.md)
- [Update Card Status](https://cardsapidocs.thredd.com/reference/update-card-status.md)
- [Update Card Status - Idempotent](https://cardsapidocs.thredd.com/reference/update-card-status-idempotent.md)
- [List Card Balance](https://cardsapidocs.thredd.com/reference/list-card-balance.md)
- [Get Card Image](https://cardsapidocs.thredd.com/reference/get-card-image-1.md)
- [Get Cardholder Details](https://cardsapidocs.thredd.com/reference/get-cardholder-details.md)
- [Create Bulk Cards](https://cardsapidocs.thredd.com/reference/create-bulk-cards.md)
- [Gets the bulk card progress.](https://cardsapidocs.thredd.com/reference/gets-the-bulk-card-progress.md)
- [Get Encrypted Data](https://cardsapidocs.thredd.com/reference/retrieven-encrypted-card-includes-pannd-cvv.md)
- [Retrieve a Card with unmasked PAN](https://cardsapidocs.thredd.com/reference/retrieve-card-with-unmasked-pan.md)
- [Gets the Card Control Overrides.](https://cardsapidocs.thredd.com/reference/gets-the-card-control-overrides.md)
- [Get Card Control Overrides or Defaults.](https://cardsapidocs.thredd.com/reference/get-card-control-overrides-or-defaults.md)
- [Convert Card](https://cardsapidocs.thredd.com/reference/convert-card.md)
- [Convert Card - Idempotent](https://cardsapidocs.thredd.com/reference/convert-card-idempotent.md)
- [Update Card STIP Balance](https://cardsapidocs.thredd.com/reference/update-card-stip-balance.md)
- [Update Card STIP Balance - Idempotent](https://cardsapidocs.thredd.com/reference/update-card-stip-balance-idempotent.md)
- [Gets the bulk card tokens.](https://cardsapidocs.thredd.com/reference/gets-the-bulk-card-tokens.md)
- [Return allow/disallow listed card acceptors group and merchants under the group](https://cardsapidocs.thredd.com/reference/returnllowdisallow-listed-cardcceptors-groupnd-merchants-under-the-group.md)
- [Complete a Card Replacement](https://cardsapidocs.thredd.com/reference/complete-card-replacement.md)
- [Complete a Card Replacement - Idempotent](https://cardsapidocs.thredd.com/reference/complete-card-replacement-idempotent.md)
- [List Card Control Groups](https://cardsapidocs.thredd.com/reference/list-card-control-groups-1.md)
- [Update Card Control Groups](https://cardsapidocs.thredd.com/reference/update-card-control-groups-1.md)
- [Update Card Control Groups - Idempotent](https://cardsapidocs.thredd.com/reference/update-card-control-groups-idempotent.md)
- [Create 3DS Credentials](https://cardsapidocs.thredd.com/reference/create-3ds-credentials.md)
- [List 3DS Credentials.](https://cardsapidocs.thredd.com/reference/list-3ds-credentials.md)
- [List card enrollment details](https://cardsapidocs.thredd.com/reference/list-card-enrollment-details.md)
- [Delete 3DS Credential.](https://cardsapidocs.thredd.com/reference/delete-3ds-credential.md)
- [Update 3DS Credentials](https://cardsapidocs.thredd.com/reference/update-3ds-credentials.md)
- [Update 3DS Credentials - Idempotent](https://cardsapidocs.thredd.com/reference/update-3ds-credentials-idempotent.md)
- [Get PIN](https://cardsapidocs.thredd.com/reference/get-pin.md)
- [Set PIN](https://cardsapidocs.thredd.com/reference/set-pin.md)
- [Get PIN Status](https://cardsapidocs.thredd.com/reference/get-pin-status.md)
- [Unblock PIN](https://cardsapidocs.thredd.com/reference/unblock-pin.md)
- [Get CVV](https://cardsapidocs.thredd.com/reference/get-cvv.md)
- [Get CVV Status](https://cardsapidocs.thredd.com/reference/get-cvv-status.md)
- [Unblock CVV](https://cardsapidocs.thredd.com/reference/unblock-cvv.md)
- [Unblock CVV - Idempotent](https://cardsapidocs.thredd.com/reference/unblock-cvv-idempotent.md)
- [Get Transaction Details of a single transaction](https://cardsapidocs.thredd.com/reference/get-transaction-details-of-single-transaction.md)
- [Load or Unload Card](https://cardsapidocs.thredd.com/reference/load-or-unload-card.md)
- [Get Card Transactions](https://cardsapidocs.thredd.com/reference/get-card-transactions.md)
- [Get Product](https://cardsapidocs.thredd.com/reference/get-product-1.md)
- [Get Product Card Stock](https://cardsapidocs.thredd.com/reference/get-product-card-stock.md)
- [Get list of Products for a given Program Manager / Issuer](https://cardsapidocs.thredd.com/reference/get-list-of-products-for-given-program-manager-issuer.md)
- [Remove Merchant from Allow List](https://cardsapidocs.thredd.com/reference/remove-merchant-from-allow-list-1.md)
- [Remove Merchant from Disallow List](https://cardsapidocs.thredd.com/reference/remove-merchant-from-disallow-list.md)
- [Get Disallowed Merchants](https://cardsapidocs.thredd.com/reference/get-disallowed-merchants-1.md)
- [Get Allowed Merchants](https://cardsapidocs.thredd.com/reference/get-allowed-merchants-1.md)
- [Add Merchant to Allow List](https://cardsapidocs.thredd.com/reference/add-merchant-to-allow-list-1.md)
- [Add Merchant to Disallow List](https://cardsapidocs.thredd.com/reference/add-merchant-to-disallow-list-1.md)
- [Get a list of Card Payment Tokens.](https://cardsapidocs.thredd.com/reference/get-list-of-card-payment-tokens.md)
- [Get details for a card payment token.](https://cardsapidocs.thredd.com/reference/get-details-for-card-payment-token.md)
- [Get a list of Card Payment Token Devices.](https://cardsapidocs.thredd.com/reference/get-list-of-card-payment-token-devices.md)
- [Update Payment Token Status - Legacy](https://cardsapidocs.thredd.com/reference/update-payment-token-status-legacy.md)
- [Update Payment Token Status](https://cardsapidocs.thredd.com/reference/update-payment-token-status-1.md)
- [Unbind a Device From a Token](https://cardsapidocs.thredd.com/reference/unbind-device-from-token.md)
- [Validate Custom PAN](https://cardsapidocs.thredd.com/reference/validate-custom-pan-1.md)
- [Create Custom PAN](https://cardsapidocs.thredd.com/reference/create-custom-pan-1.md)

## Recipes
- [Activate a Card](https://cardsapidocs.thredd.com/recipes/activate-a-card.md)
- [Block a Lost Card](https://cardsapidocs.thredd.com/recipes/block-a-lost-card.md)
- [Create a Physical Card](https://cardsapidocs.thredd.com/recipes/create-a-physical-card.md)
- [Get a Balance Enquiry](https://cardsapidocs.thredd.com/recipes/get-a-balance-enquiry.md)
- [Get Card Transactions](https://cardsapidocs.thredd.com/recipes/get-card-transactions.md)
- [Get Cardholder Details](https://cardsapidocs.thredd.com/recipes/get-cardholder-details.md)
- [Load a Card](https://cardsapidocs.thredd.com/recipes/load-a-card.md)
- [Renew a Card](https://cardsapidocs.thredd.com/recipes/renew-a-card.md)
- [Set PIN](https://cardsapidocs.thredd.com/recipes/set-pin.md)

## Changelog
- [Release Notes for the 10th July](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-10th-july.md)
- [Release Notes for the 3rd July](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-3rd-july.md)
- [Release Notes for the 5th June](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-5th-june.md)
- [PRN-296](https://cardsapidocs.thredd.com/changelog/prn-296.md)
- [Release Notes for the 17th April](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-17th-april-1.md)
- [Release Notes for the 2nd April](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-2nd-april.md)
- [Release Notes for the 20th February](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-20th-february.md)
- [Release Notes for the 6th February](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-6th-february.md)
- [Release Notes for the 23rd January 2026](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-23rd-january-2026.md)
- [Release Notes for the 17th April](https://cardsapidocs.thredd.com/changelog/release-notes-for-the-17th-april.md)