Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

List All Payment Instruments

List all of the Payment Instrument resources that have been created.

Copy
Copied
curl https://finix.sandbox-payments-api.com/payment_instruments \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Example Response:

Copy
Copied
{
  "_embedded" : {
    "payment_instruments" : [ {
      "id" : "PInbUSypj2c1sKXh17ioakyx",
      "created_at" : "2022-10-10T01:36:28.15Z",
      "updated_at" : "2022-10-10T01:36:28.15Z",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "created_via" : "API",
      "currency" : "USD",
      "enabled" : true,
      "fingerprint" : "FPRiCenDk2SoRng7WjQTr7RJY",
      "identity" : "IDgWxBhfGYLLdkhxx2ddYf9K",
      "instrument_type" : "PAYMENT_CARD",
      "address" : {
        "line1" : "900 Metro Center Blv",
        "line2" : null,
        "city" : "San Francisco",
        "region" : "CA",
        "postal_code" : "94404",
        "country" : "USA"
      },
      "address_verification" : "UNKNOWN",
      "bin" : "520082",
      "brand" : "MASTERCARD",
      "card_type" : "DEBIT",
      "expiration_month" : 12,
      "expiration_year" : 2029,
      "issuer_country" : "NON_USA",
      "last_four" : "8210",
      "name" : "John Smith",
      "security_code_verification" : "UNKNOWN",
      "tags" : {
        "card_name" : "Business Card"
      },
      "type" : "PAYMENT_CARD",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PInbUSypj2c1sKXh17ioakyx"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PInbUSypj2c1sKXh17ioakyx/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PInbUSypj2c1sKXh17ioakyx/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PInbUSypj2c1sKXh17ioakyx/verifications"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K"
        },
        "updates" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PInbUSypj2c1sKXh17ioakyx/updates"
        }
      }
    }, {
      "id" : "PIiw4E6mj8N2K3PvFKMe4Sf7",
      "created_at" : "2022-09-28T19:07:28.52Z",
      "updated_at" : "2022-09-28T19:07:28.52Z",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "created_via" : "API",
      "currency" : "USD",
      "enabled" : true,
      "fingerprint" : "FPRd5moHxL3Ltuvk4cczxetCg",
      "identity" : "ID4hfMWit7K1pNBC7ez7sytx",
      "instrument_type" : "BANK_ACCOUNT",
      "account_type" : "CHECKING",
      "bank_account_validation_check" : "NOT_ATTEMPTED",
      "bank_code" : "123123123",
      "country" : "USA",
      "masked_account_number" : "XXXXX3123",
      "name" : "Alice",
      "tags" : {
        "Bank Account" : "Company Account"
      },
      "type" : "BANK_ACCOUNT",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIiw4E6mj8N2K3PvFKMe4Sf7"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIiw4E6mj8N2K3PvFKMe4Sf7/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIiw4E6mj8N2K3PvFKMe4Sf7/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIiw4E6mj8N2K3PvFKMe4Sf7/verifications"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/ID4hfMWit7K1pNBC7ez7sytx"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/payment_instruments"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/payment_instruments?after_cursor=PIiw4E6mj8N2K3PvFKMe4Sf7"
    }
  },
  "page" : {
    "limit" : 100,
    "next_cursor" : "PIiw4E6mj8N2K3PvFKMe4Sf7"
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/payment_instruments