Card-On-File API

Overview

The Credit Card Tokenization API allows you to securely store credit card information and receive a token for future use. This token can be used for recurring payments (subscriptions) or subsequent transactions without requiring the customer to re-enter their payment details, improving the checkout experience while maintaining PCI compliance.

Key Features

  • 🔐 Secure tokenization of credit card data

  • 🪙 Optional micro-deposit validation for additional security

  • ℹ️ Simple retrieval of tokenized card information

  • Ability to invalidate tokens when no longer needed

  • PCI-compliant storage solution


Overview of Endpoints

This API includes three endpoints:

  1. Create Card Token

    • Method: POST

    • Path: v3/tokenization

    • Description: Tokenizes a customer’s card details and returns a secure card_identifier for future use.

    • Typical Use: Storing card details during a payment or onboarding process.

  2. Get Card Token

    • Method: GET

    • Path: v3/tokenization/{card_identifier}

    • Description: Retrieves the current status and details of a specific card token.

    • Typical Use: Checking if a token is still valid or active.

  3. Delete Card Token

    • Method: DELETE

    • Path: v3/tokenization/{card_identifier}

    • Description: Deletes a previously created card token. After this action the related token cannot longer be used.

    • Typical Use: Fetching additional details for display or backend validation.


Last updated

Was this helpful?