Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Authorizations

List Authorizations

Retrieve a list of Authorizations.

For details on how to query endpoints using the available parameters, see Query Parameters.

{% admonition type="info" %} If no query parameters are specified in the request the API automatically limits the response to records from the last 30 days. You can request older data by passing an explicit created_at.lte filter. {% /admonition %}

get/authorizations

Query parameters

after_cursorstring

Return every resource created after the cursor value.

amount.gtinteger
Example:100

Filter by an amount greater than.

amount.gteinteger
Example:100

Filter by an amount greater than or equal.

amount.ltinteger
Example:100

Filter by an amount less than.

amount.lteinteger
Example:100

Filter by an amount less than or equal.

amountinteger
Example:100

Filter by an amount equal to the given value.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

currencystring
Example:USD

Filter by the currency of the resource.

devicestring
Example:DVsEanpBtsAVvCHbNXkFaH6f

Filter by the device's ID.

idempotency_idstring
Example:15d32948-c766-4033-8d87-dfbdcabcbc5c

Filter by Idempotency ID.

instrument_account_last4string

Filter Transactions by the last 4 digits of the bank account. The bank account last 4 are the last 4 digits of the masked account number.

instrument_binstring

Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number.

instrument_brand_typestring
Example:VISA

Filter by card brand.

instrument_card_last4string

Filter by the payment card last 4 digits.

instrument_namestring
Example:Alice

Filter Transactions by the name of the Payment Instrument.

is_voidboolean

Show only voided authorizations.

limitinteger
Example:10

The numbers of items to return.

merchantstring
Example:MUeDVrf2ahuKc9Eg5TeZugvs

Filter by the Merchant ID.

merchant_identity_namestring
Example:John

Filter Transactions by name of the Identity.

merchant_midstring
Example:FNXrzKj8xCLBwB8FdxjfU9txe

Filter by Merchant Identification Number (MID).

merchant_processor_idstring

Filter by Processor ID.

state'SUCCEEDED' | 'FAILED' | 'PENDING' | 'CANCELED'
Example:SUCCEEDED

Filter by transaction state.

tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

trace_idstring
Example:021fc4ed-f0a8-4932-820c-b22b542526f8

Filter by trace_id.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

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

Response

List of Authorization objects

Example response

{
  "_embedded": {
    "authorizations": [
      {
        "id": "AUxxxxxxxxxxxxxxxxxx",
        "amount": 5000,
        "device": "DVxxxxxxxxxxxxxxxxxx",
        "ip_address_details": {
          "ipv4": {
            "ip": "192.168.1.1"
          }
        },
        "merchant": "MUxxxxxxxxxxxxxxxxxxxxxx",
        "merchant_identity": "IDxxxxxxxxxxxxxxxxxxxxxx",
        "network_details": {
          "brand": "VISA"
        },
        "source": "PIxxxxxxxxxxxxxxxxxx",
        "transfer": "TRxxxxxxxxxxxxxxxxxx"
      }
    ]
  }
}