Version Log

2024-10-14

the card.firstNumbers, card.scheme and identifiers.amexApprovalCode properties from the transaction object when the card network is Amex. This applies to all relevant endpoints returning transactions.

2022-07-13

We are decommissioning this API version, after 2025-01-31, as part of our ongoing efforts to improve performance, security, and maintainability.
We recommend migrating to the latest version available to take advantage of the latest features and improvements.
For migration guidance and further details, please refer to our API Documentation

2021-09-28

We are decommissioning this API version, after 2025-01-31, as part of our ongoing efforts to improve performance, security, and maintainability.
We recommend migrating to the latest version available to take advantage of the latest features and improvements.
For migration guidance and further details, please refer to our API Documentatio

2019-03-05

We are decommissioning this API version, after 2025-01-31, as part of our ongoing efforts to improve performance, security, and maintainability.
We recommend migrating to the latest version available to take advantage of the latest features and improvements.
For migration guidance and further details, please refer to our API Documentation

2018-01-05

We are decommissioning this API version, after 2025-01-31, as part of our ongoing efforts to improve performance, security, and maintainability.
We recommend migrating to the latest version available to take advantage of the latest features and improvements.
For migration guidance and further details, please refer to our API Documentation

2017-12-05

We are decommissioning this API version, after 2025-01-31, as part of our ongoing efforts to improve performance, security, and maintainability.
We recommend migrating to the latest version available to take advantage of the latest features and improvements.
For migration guidance and further details, please refer to our API Documentation

2017-11-27

We are decommissioning this API version, after 2025-01-31, as part of our ongoing efforts to improve performance, security, and maintainability.
We recommend migrating to the latest version available to take advantage of the latest features and improvements.
For migration guidance and further details, please refer to our API Documentation

2022-07-13

the cardPresent property to the transaction object to flag when a transaction was made online or in store. Test transactions' cardPresent is null.

2021-09-28

new webhook (credits.balance.low).
automatedReimbursement for offers

• This affects:
  • Endpoints:
    • transactions/{transactionsId}
    • brand/{brandId}/transactions
    • program/{programId}/transactions
    • offers
    • offers/{offerId}
  • Webhooks:
    • transaction.auth
    • transaction.auth.qualified
    • transaction.clearing
    • transaction.clearing.qualified

2019-03-05

statusCode for USA locations.
geolocation information on the transactions.
cleaned up transactions objects.

• This affects:
  • Endpoints:
    • transactions/{transactionsId}
    • brand/{brandId}/transactions
    • program/{programId}/transactions
  • Webhooks:
    • transaction.auth
    • transaction.auth.qualified
    • transaction.clearing
    • transaction.clearing.qualified

HOW TO MIGRATE:

• :
  • datetime - local date time and does NOT have timezone information
  • brand
  • card
  • location
  • identifiers
• :
  • merchantId
  • live
  • date
  • time
• :
  • metadata is now a card property.
  • midid is now a property of identifiers as MID.
  • brand is an object containing id, name, logoURL and metadata,
  • all the properties from cards moved under card (id, firstNumbers, lastNumbers, scheme),
  • all the properties from locations moved under location (id, address, city, postcode, countryCode, timezone*, geolocation*, metadata*),

*new properties.

2018-01-05

new webhooks (brand.consent and program.status)

2017-12-05

metadata to Brand, Location and Program objects

2017-11-27

the currency property from the create/update location schema

2017-11-12

initial base API version