API Reference

Introduction

Credit Card Transactions API Documentation

Overview

The Credit Card API provides a robust interface for managing credit card transactions, recurring payments, and tokenized cards. It has been designed to integrate systems efficiently and securely, ensuring a smooth experience for users and developers.

Key Features:

  • Credit Card Transactions: Process single or installment payments.
  • Recurring Payments: Automate recurring charges in a simple way.
  • Tokenized Credit Cards: Securely store and manage customers' payment cards using tokens instead of raw card data, reducing PCI scope and improving security.

Recurring Payments

The Credit Card Recurrence API enables automated recurring charges for subscription-based services, installment plans, and periodic payments. This feature simplifies the management of recurring transactions by automatically processing charges based on predefined schedules.

How it works

  1. Create a recurrence by defining the payment frequency (daily, weekly, monthly, or yearly), start date, and recurrence type.
  2. Choose between LIMITED_TIMES (fixed number of charges) or INDETERMINATE (ongoing until canceled).
  3. The system automatically processes charges according to the schedule, with configurable retry attempts for failed transactions.
  4. Monitor and manage recurrences through consultation endpoints, and cancel them when needed.

Recurrence types

  • LIMITED_TIMES: A fixed quantity of credit card transactions scheduled with the specified frequency. Requires the numberInstallments field.
  • INDETERMINATE: Continuous transaction generation according to the frequency for an indefinite period until canceled. The numberInstallments field must be null.

Tokenized Credit Cards

The Tokenized Credit Cards API allows you to securely store and manage customers' payment cards using tokens instead of raw card data. Tokenization reduces PCI scope and improves security by replacing sensitive card details (PAN, CVV) with a non-sensitive token that can be used for subsequent charges.

How it works

  1. Client sends card data (PAN, expiry, CVV, name) to the Tokenize endpoint. The API returns a token (cardTokenizeId and masked card information).
  2. Store the cardTokenizeId in your system. Use the token for future payments instead of card numbers.
  3. To prevent misuse, tokens can be enabled or disabled. You may require an activation code to enable a tokenized card.

Best practices for tokenization

  • Do not store raw card data on your servers. Use the token returned by the API.
  • Use HTTPS for all requests to the API.
  • Use the masked card number returned by the API for display purposes (e.g., ** ** **** 1111).

Tokenization endpoints

  • POST /v1/tokenize — Register a card
  • GET /v1/tokenize — List tokenized cards (supports paging)
  • GET /v1/tokenize/{cardTokenizeId} — Get token details
  • DELETE /v1/tokenize/{cardTokenizeId} — Delete a tokenized card