List All Payment Instruments

attention

This API is available for Finix Flex and Finix Core customers.

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

Example Response:

Copy
Copied
{
  "_embedded" : {
    "payment_instruments" : [ {
      "id" : "PIs4ZXrQB1RjbYJSgkfbcrbM",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "fingerprint" : "FPRw9NoorETQgCjFgwKPvcGsV",
      "tags" : { },
      "expiration_month" : 12,
      "expiration_year" : 2029,
      "bin" : "495703",
      "last_four" : "0454",
      "brand" : "VISA",
      "card_type" : "UNKNOWN",
      "name" : null,
      "address" : {
        "line1" : "741 Douglass St",
        "line2" : "Apartment 7",
        "city" : "San Mateo",
        "region" : "CA",
        "postal_code" : "94114",
        "country" : "USA"
      },
      "address_verification" : "UNKNOWN",
      "security_code_verification" : "UNKNOWN",
      "created_at" : "2022-01-27T07:37:27.42Z",
      "updated_at" : "2022-01-27T07:37:27.21Z",
      "instrument_type" : "PAYMENT_CARD",
      "type" : "PAYMENT_CARD",
      "currency" : "USD",
      "identity" : "IDpYDM7J9n57q849o9E9yNrG",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/verifications"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
        },
        "updates" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIs4ZXrQB1RjbYJSgkfbcrbM/updates"
        }
      }
    }, {
      "id" : "PIm8mdyYcEnYAZLLyw8g59Pw",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "fingerprint" : "FPRd5moHxL3Ltuvk4cczxetCg",
      "tags" : {
        "Bank Account" : "Company Account"
      },
      "bank_code" : "123123123",
      "country" : "USA",
      "masked_account_number" : "XXXXX3123",
      "name" : "Alice",
      "account_type" : "SAVINGS",
      "created_at" : "2022-01-27T07:37:03.48Z",
      "updated_at" : "2022-01-27T07:37:03.37Z",
      "instrument_type" : "BANK_ACCOUNT",
      "type" : "BANK_ACCOUNT",
      "currency" : "USD",
      "identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIm8mdyYcEnYAZLLyw8g59Pw"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIm8mdyYcEnYAZLLyw8g59Pw/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIm8mdyYcEnYAZLLyw8g59Pw/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIm8mdyYcEnYAZLLyw8g59Pw/verifications"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
        }
      }
    }, {
      "id" : "PIk3AG7aUSCyNgYpDwCKkwDC",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "fingerprint" : "FPRd5moHxL3Ltuvk4cczxetCg",
      "tags" : {
        "Bank Account" : "Company Account"
      },
      "bank_code" : "123123123",
      "country" : "USA",
      "masked_account_number" : "XXXXX3123",
      "name" : "Alice",
      "account_type" : "SAVINGS",
      "created_at" : "2022-01-27T07:37:01.13Z",
      "updated_at" : "2022-01-27T07:37:01.02Z",
      "instrument_type" : "BANK_ACCOUNT",
      "type" : "BANK_ACCOUNT",
      "currency" : "USD",
      "identity" : "IDgWxBhfGYLLdkhxx2ddYf9K",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIk3AG7aUSCyNgYpDwCKkwDC"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIk3AG7aUSCyNgYpDwCKkwDC/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIk3AG7aUSCyNgYpDwCKkwDC/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIk3AG7aUSCyNgYpDwCKkwDC/verifications"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K"
        }
      }
    }, {
      "id" : "PIe2YvpcjvoVJ6PzoRPBK137",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "fingerprint" : "FPRogKWsRQks2HGaau5eGR9AF",
      "tags" : {
        "card_name" : "Business Card"
      },
      "expiration_month" : 12,
      "expiration_year" : 2029,
      "bin" : "489514",
      "last_four" : "0006",
      "brand" : "VISA",
      "card_type" : "UNKNOWN",
      "name" : "Amy White",
      "address" : {
        "line1" : "900 Metro Center Blv",
        "line2" : null,
        "city" : "San Francisco",
        "region" : "CA",
        "postal_code" : "94404",
        "country" : "USA"
      },
      "address_verification" : "POSTAL_CODE_AND_STREET_MATCH",
      "security_code_verification" : "MATCHED",
      "created_at" : "2022-01-27T07:37:00.53Z",
      "updated_at" : "2022-01-27T07:37:10.88Z",
      "instrument_type" : "PAYMENT_CARD",
      "type" : "PAYMENT_CARD",
      "currency" : "USD",
      "identity" : "IDgWxBhfGYLLdkhxx2ddYf9K",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/verifications"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K"
        },
        "updates" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137/updates"
        }
      }
    }, {
      "id" : "PI8sdzepdapDehPWKFTcre1m",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "fingerprint" : "FPRd5moHxL3Ltuvk4cczxetCg",
      "tags" : {
        "Display Name" : "Updated Field"
      },
      "bank_code" : "123123123",
      "country" : "USA",
      "masked_account_number" : "XXXXX3123",
      "name" : "Alice",
      "account_type" : "SAVINGS",
      "created_at" : "2022-01-27T07:36:57.62Z",
      "updated_at" : "2022-01-27T07:36:59.17Z",
      "instrument_type" : "BANK_ACCOUNT",
      "type" : "BANK_ACCOUNT",
      "currency" : "USD",
      "identity" : "IDpYDM7J9n57q849o9E9yNrG",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI8sdzepdapDehPWKFTcre1m/verifications"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
        }
      }
    }, {
      "id" : "PI5S1g6JqVhFqBEVspWMhWzn",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "fingerprint" : "FPRd5moHxL3Ltuvk4cczxetCg",
      "tags" : {
        "Bank Account" : "Company Account"
      },
      "bank_code" : "123123123",
      "country" : "USA",
      "masked_account_number" : "XXXXX3123",
      "name" : "Alice",
      "account_type" : "SAVINGS",
      "created_at" : "2022-01-27T07:36:57.06Z",
      "updated_at" : "2022-01-27T07:36:56.98Z",
      "instrument_type" : "BANK_ACCOUNT",
      "type" : "BANK_ACCOUNT",
      "currency" : "USD",
      "identity" : "IDuquemzE7UkUJioGJfVKBKt",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI5S1g6JqVhFqBEVspWMhWzn"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI5S1g6JqVhFqBEVspWMhWzn/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI5S1g6JqVhFqBEVspWMhWzn/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PI5S1g6JqVhFqBEVspWMhWzn/verifications"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDuquemzE7UkUJioGJfVKBKt"
        }
      }
    }, {
      "id" : "PIbKNyLxrCRDUBwKJfvS6NNu",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "fingerprint" : "FPRsDD3AMHfci5QNZiaHrPTou",
      "tags" : {
        "Bank Account" : "Company Account"
      },
      "bank_code" : "123456789",
      "country" : "USA",
      "masked_account_number" : "XXXXX6789",
      "name" : "Operating Account",
      "account_type" : "CHECKING",
      "created_at" : "2022-01-27T07:36:34.69Z",
      "updated_at" : "2022-01-27T07:36:34.73Z",
      "instrument_type" : "BANK_ACCOUNT",
      "type" : "BANK_ACCOUNT",
      "currency" : "USD",
      "identity" : "IDddHpRqwf2VsH2XB1fmLfhM",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIbKNyLxrCRDUBwKJfvS6NNu"
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIbKNyLxrCRDUBwKJfvS6NNu/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIbKNyLxrCRDUBwKJfvS6NNu/transfers"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIbKNyLxrCRDUBwKJfvS6NNu/verifications"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/payment_instruments?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 7
  }
}

HTTP Request

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