v1

latestOpenAPI 3.0.22026-08-061303782.1 MB

Payment Instruments

List Instrument History Entries

Whenever a stored payment card's details are updated, an Instrument History Entry is created. Use this endpoint to retrieve a list of Instrument History Entries for a specific Payment Instrument.

get/payment_instruments/{payment_instrument_id}/instrument_history

Path parameters

payment_instrument_idstring required

The Payment Instrument that triggered the creation of this Instrument History Entry.

Query parameters

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

limitinteger

Example:10

The numbers of items to return.

Headers

Finix-Versionstring

Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Instrument History Entry objects.

Example response

{
  "_embedded": {
    "instrument_history_entries": [
      {
        "old_instrument_details": {
          "fingerprint": "FPRxxxxxxxxxxxxxxxxx"
        },
        "new_instrument_details": {
          "fingerprint": "FPRxxxxxxxxxxxxxxxxx"
        }
      }
    ]
  }
}