{
  "opencollection": "1.0.0",
  "info": {
    "name": "Finix Authorizations Payment Instruments API",
    "version": "2022-02-01"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Payment Instruments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Payment Instruments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://finix.sandbox-payments-api.com/payment_instruments",
            "params": [
              {
                "name": "account_last4",
                "value": "",
                "type": "query",
                "description": "Filter by the last 4 digits of the account if available."
              },
              {
                "name": "account_routing_number",
                "value": "",
                "type": "query",
                "description": "Filter by the account routing number if available."
              },
              {
                "name": "after_cursor",
                "value": "",
                "type": "query",
                "description": "Return every resource created after the cursor value."
              },
              {
                "name": "application",
                "value": "",
                "type": "query",
                "description": "Filter by `Application` ID."
              },
              {
                "name": "before_cursor",
                "value": "",
                "type": "query",
                "description": "Return every resource created before the cursor value."
              },
              {
                "name": "bin",
                "value": "",
                "type": "query",
                "description": "Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number."
              },
              {
                "name": "created_at.gte",
                "value": "",
                "type": "query",
                "description": "Filter where `created_at` is after the given date."
              },
              {
                "name": "created_at.lte",
                "value": "",
                "type": "query",
                "description": "Filter where `created_at` is before the given date."
              },
              {
                "name": "expiration_month",
                "value": "",
                "type": "query",
                "description": "Filter by the expiration month associated with the `Payment Instrument` if applicable. This filter only applies to payment cards."
              },
              {
                "name": "expiration_year",
                "value": "",
                "type": "query",
                "description": "Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards."
              },
              {
                "name": "last4",
                "value": "",
                "type": "query",
                "description": "Filter by the last 4 digits of the `Payment Instrument` card. This filter only applies to payment cards."
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "The numbers of items to return."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter by the name."
              },
              {
                "name": "owner_identity_id",
                "value": "",
                "type": "query",
                "description": "Filter by the owner id of the associated `Identity`."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by the `Payment Instrument` type."
              },
              {
                "name": "tags.key",
                "value": "",
                "type": "query",
                "description": "Filter by the [`key` of a `Tag`](/api/overview/#section/Tags)."
              },
              {
                "name": "tags.value",
                "value": "",
                "type": "query",
                "description": "Filter by the [value of a `Tag`](https://finix.com/docs/api/overview/#section/Tags)."
              }
            ]
          },
          "docs": "Retrieve a list of `Payment Instruments`."
        },
        {
          "info": {
            "name": "Create a Payment Instrument",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://finix.sandbox-payments-api.com/payment_instruments",
            "headers": [
              {
                "name": "Finix-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a `Payment Instrument` resource using a card or bank account.\n\n- The creation of `Payment Instruments` directly via Finix's API should only be done for testing purposes. You must use [our hosted fields](/guides/payments/making-a-payment/using-hosted-fields/) or the javascript client to remain out of PCI scope."
        },
        {
          "info": {
            "name": "Fetch a Payment Instrument",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://finix.sandbox-payments-api.com/payment_instruments/:payment_instrument_id",
            "params": [
              {
                "name": "payment_instrument_id",
                "value": "",
                "type": "path",
                "description": "ID of object"
              }
            ]
          },
          "docs": "Retrieve the details of a `Payment Instrument`."
        },
        {
          "info": {
            "name": "Update a Payment Instrument",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://finix.sandbox-payments-api.com/payment_instruments/:payment_instrument_id",
            "headers": [
              {
                "name": "Finix-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "payment_instrument_id",
                "value": "",
                "type": "path",
                "description": "ID of object"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a `Payment Instrument` to:\n- Change the **billing address** in case the account holder moved (`instrument_type`:**PAYMENT_CARD** only).\n- Disable the `Payment Instrument` resource so it can't be used in requests.\n- Update the `name` on the `Payment Instrument`.\n- Change the `tags`."
        },
        {
          "info": {
            "name": "Create an Apple Pay Session",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://finix.sandbox-payments-api.com/apple_pay_sessions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an `apple_pay_session` to process Apple Pay transactions on the web.\n\nTo create an Apple Pay Session, pass the unique `validation_url` (provided by Apple) while creating an `apple_pay_sessions` resource. Finix returns a `merchantSession` object that you can use to create a payment. For more information, see [Apple Pay](/guides/payments/alternative-payment-methods/apple-pay/)."
        }
      ]
    }
  ],
  "bundled": true
}