API Reference

Versioning 🆕

Here you will find all the versions and changes made to our API by date and version

May 6th 2024

Field Inclusions

Endpoint: Cards

  1. Limit Adjustment (Patch): New endpoint to adjust the limit of a certain Card
  2. Lock/Unlock Card (Patch): New endpoint to Lock or Unlock a specific Card

Endpoint: Transactions

  1. authorizationNumber → It refers to the approval number from MasterCard that is also on the Transactions report in the Clara Platform

April 15th 2024

We're thrilled to share that our Clara Card API has undergone a significant update, bringing exciting new capabilities to developers like you. We're introducing WRITE MODE functionality for Cards, Labels, and Groups!

With the addition of Write Mode, you now have the ability to not only retrieve data but also create and manage cards, labels, and groups directly through our API. This expansion provides you with greater flexibility and control over your data, enabling you to tailor your applications to better suit your needs.

Here's an overview of the key features you can expect with Clara Card API's Write Mode:

Endpoint: Cards

  1. Create Cards: Easily generate new cards with customizable parameters.

Endpoint: Groups

  1. Create Groups: Expand your organizational capabilities by creating and managing groups to better organize your users.

Endpoint: Labels

  1. Create Labels: Enhance transaction categorization by creating and applying custom labels.

March 26th 2024

Field Modifications

Endpoint: Users

  1. userFullName → We inverted the First Last Name and Second Last Name (Only MX and CO)

February 26th 2024

Filters Inclusions

Endpoint: Transactions

  1. sort: Sort the results by specific fields and directions. (accountingDate | operationDate),(ASC | DESC)

February 21th 2024

Field Inclusions

Endpoint: Transactions

  1. maskedPan: First 6 digits and last 4 digits of the card

Filters Inclusions

Endpoint: Transactions

  1. cardLastDigits: Masked Pan Last Digits of the card associated with the transactions

February 19th 2024

Field Inclusions

Endpoint: Transactions

  1. Attachments: Information about the files attached to the transaction
    1. fileName
    2. type: TRANSACTIONS_RECEIPT/TRANSACTIONS_INVOICE
    3. hasReceipt: Boolean
    4. hasInvoice: Boolean

Filters Inclusions

Endpoint: Transactions

  1. userErpId: ERP id of the transaction user from the Team panel in Clara's Platform
  2. username: Username of the transaction user

February 8th 2024

Field Modifications

Endpoint: Transactions

  1. statusCode → status
  2. comments → comment

Field Removals

Endpoint: Transactions

  1. tax: Removed because it didn't refer to the purchase taxes but rather to transaction values.
  2. expirationDate: Was a static value. We are creating a new field to bring this expiration value for each transaction.

June 15th 2024

Field Inclusions

Endpoint: Transactions

  1. billingStatement: Billing statement dates - start, end, and dueDate
  2. authorizationNumber: Number of authorization from a transaction