Finix Payments Payment Instruments API
{'$ref': 'api-descriptions/tags/payment-instruments.md'}
OpenAPI Specification
openapi: 3.0.2
info:
title: Finix Authorizations Payment Instruments API
description:
$ref: api-descriptions/main.md
contact:
name: Finix
url: https://finix.com
email: support@finixpayments.com
version: '2022-02-01'
servers:
- description: Sandbox server to be used for testing and development
url: https://finix.sandbox-payments-api.com
security:
- BasicAuth: []
tags:
- name: Payment Instruments
description:
$ref: api-descriptions/tags/payment-instruments.md
paths:
/payment_instruments:
post:
tags:
- Payment Instruments
description: 'Create a `Payment Instrument` resource using a card or bank account.
- 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.'
summary: Create a Payment Instrument
operationId: createPaymentInstrument
requestBody:
$ref: '#/components/requestBodies/CreatePaymentInstrumentRequest'
responses:
'201':
$ref: '#/components/responses/PaymentInstrument'
'400':
$ref: '#/components/responses/ErrorUnprocessableEntity'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: create
parameters:
- schema:
type: string
default: '2018-01-01'
example: '2022-02-01'
in: header
name: Finix-Version
description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
x-python-method-name: create
get:
tags:
- Payment Instruments
description: Retrieve a list of `Payment Instruments`.
summary: List Payment Instruments
operationId: listPaymentInstruments
parameters:
- $ref: '#/components/parameters/QueryAccountLastFour'
- $ref: '#/components/parameters/QueryAccountRoutingNumber'
- $ref: '#/components/parameters/QueryAfterCursor'
- $ref: '#/components/parameters/QueryApplicationFilter'
- $ref: '#/components/parameters/QueryBeforeCursor'
- $ref: '#/components/parameters/QueryBin'
- $ref: '#/components/parameters/QueryCreatedAtGteFilter'
- $ref: '#/components/parameters/QueryCreatedAtLteFilter'
- $ref: '#/components/parameters/QueryExpirationMonth'
- $ref: '#/components/parameters/QueryExpirationYear'
- $ref: '#/components/parameters/QueryLastFour'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryName'
- $ref: '#/components/parameters/QueryOwnerIdentity'
- $ref: '#/components/parameters/QueryPaymentInstrumentType'
- $ref: '#/components/parameters/TagsKey'
- $ref: '#/components/parameters/TagsValue'
responses:
'200':
$ref: '#/components/responses/PaymentInstrumentsList'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: list
x-group-parameters: true
x-codeSamples:
- lang: cURL
label: curl
source: "curl \"https://finix.sandbox-payments-api.com/payment_instruments\" \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: list
x-returns-list: true
/payment_instruments/{payment_instrument_id}:
parameters:
- description: ID of object
required: true
in: path
name: payment_instrument_id
schema:
type: string
get:
tags:
- Payment Instruments
description: Retrieve the details of a `Payment Instrument`.
summary: Fetch a Payment Instrument
operationId: getPaymentInstrument
responses:
'200':
$ref: '#/components/responses/PaymentInstrument'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
'422':
$ref: '#/components/responses/Error422InvalidField'
x-java-method-name: get
x-codeSamples:
- lang: cURL
label: curl
source: "curl \"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY\" \\\n -H \"Finix-Version: 2022-02-01\" \\\n -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"
x-python-method-name: get
put:
tags:
- Payment Instruments
description: 'Update a `Payment Instrument` to:
- Change the **billing address** in case the account holder moved (`instrument_type`:**PAYMENT_CARD** only).
- Disable the `Payment Instrument` resource so it can''t be used in requests.
- Update the `name` on the `Payment Instrument`.
- Change the `tags`.'
summary: Update a Payment Instrument
operationId: updatePaymentInstrument
requestBody:
$ref: '#/components/requestBodies/UpdatePaymentInstrumentRequest'
responses:
'200':
$ref: '#/components/responses/PaymentInstrument'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
x-java-method-name: update
parameters:
- schema:
type: string
default: '2018-01-01'
example: '2022-02-01'
in: header
name: Finix-Version
description: Specify the API version of your request. For more details, see [Versioning.](/guides/developers/versioning/)
x-python-method-name: update
/apple_pay_sessions:
post:
summary: Create an Apple Pay Session
operationId: createApplePaySession
responses:
'200':
$ref: '#/components/responses/ApplePaySession'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
'403':
$ref: '#/components/responses/ErrorForbidden403'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/Error406NotAcceptable'
tags:
- Payment Instruments
x-java-method-name: createApplePaySession
requestBody:
$ref: '#/components/requestBodies/CreateApplePaySessionRequest'
description: 'Create an `apple_pay_session` to process Apple Pay transactions on the web.
To 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/).'
x-codeSamples:
- lang: cURL
label: curl
source:
$ref: xcode/curl/payment-instruments/createapplepay.md
x-python-method-name: create_apple_pay_session
components:
responses:
Error422InvalidField:
description: Invalid field
content:
application/json:
schema:
$ref: '#/components/schemas/Error422InvalidFieldList'
Error406NotAcceptable:
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/Error406NotAcceptable'
examples: {}
ErrorUnprocessableEntity:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorGeneric'
ErrorNotFound:
description: Object does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/Error404NotFoundList'
ApplePaySession:
description: Single apple_pay_session object
content:
application/json:
schema:
$ref: '#/components/schemas/ApplePaySession'
examples:
Apple Pay Session:
value:
id: APPLEPAYSESSION_xxx
created_at: '2021-11-22T23:58:19.50Z'
updated_at: '2021-11-22T23:58:19.50Z'
session_details: '{"epochTimestamp":1640213041060,"expiresAt":1640216641060,"merchantSessionIdentifier":"SSH1524BA9006A944B8B9B8FB60227D9990_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24","nonce":"a5ee8554","merchantIdentifier":"23D5E1F154400B277E14CC8361878AA0AAFD46B2DF74003C7587B256269102BD","domainName":"tj.ngrok.io","displayName":"Christmas Shopping","signature":"...","operationalAnalyticsIdentifier":"Christmas Shopping:23D5E1F154400B277E14CC8361878AA0AAFD46B2DF74003C7587B256269102BD","retries":0}'
_links:
self:
href: https://finix.sandbox-payments-api.com/apple_pay_sessions/APPLEPAYSESSION_xxx
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
PaymentInstrumentsList:
description: List of Payment Instrument objects
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentsList'
examples:
List of Payment Instruments:
value:
_embedded:
payment_instruments:
- id: PI3AbkuRR1JbT5kPiGQCXvD9
created_at: '2022-10-11T01:42:53.29Z'
updated_at: '2022-10-11T01:42:53.29Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: John
tags:
Bank Account: Company Account
type: BANK_ACCOUNT
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
- id: PIrb1DcGz1qjThotDJ5KURpv
created_at: '2022-10-06T20:23:38.74Z'
updated_at: '2022-10-06T20:23:38.74Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPRtvYkgcwLUdjq7B4AgxKfmr
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '666666666'
country: USA
masked_account_number: XXXXX3123
name: test_python
tags:
bank_account: Test Python Account
type: BANK_ACCOUNT
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIrb1DcGz1qjThotDJ5KURpv/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments?offset=0&limit=20&sort=created_at,desc&sort=id,desc
next:
href: https://finix.sandbox-payments-api.com/payment_instruments?offset=20&limit=20&sort=created_at,desc&sort=id,desc
last:
href: https://finix.sandbox-payments-api.com/payment_instruments?offset=14660&limit=20&sort=created_at,desc&sort=id,desc
page:
offset: 0
limit: 20
count: 14679
headers:
finix-apiuser-role:
$ref: '#/components/headers/finix-apiuser-role'
date:
$ref: '#/components/headers/date'
x-request-id:
$ref: '#/components/headers/x-request-id'
ErrorForbidden403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error403ForbiddenList'
ErrorUnauthorized:
description: Authentication information is missing or invalid
content:
application/json:
schema:
$ref: '#/components/schemas/Error401Unauthorized'
PaymentInstrument:
description: Single Payment Instrument object
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrument'
descriminator:
propertyName: type
examples:
Payment Instrument - Card:
value:
id: PI8uU6wfi6hqBoWmzm9L4F2b
created_at: '2022-10-11T01:42:22.32Z'
updated_at: '2022-10-11T01:42:22.32Z'
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:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI8uU6wfi6hqBoWmzm9L4F2b/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/PI8uU6wfi6hqBoWmzm9L4F2b/updates
Payment Instrument - Bank Account:
value:
id: PI3AbkuRR1JbT5kPiGQCXvD9
created_at: '2022-10-11T01:42:53.29Z'
updated_at: '2022-10-11T01:42:53.29Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: John
tags:
Bank Account: Company Account
type: BANK_ACCOUNT
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PI3AbkuRR1JbT5kPiGQCXvD9/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
Payment Instrument - Token:
value:
id: PImmCg3Po7oNi7jaZcXhfkEu
created_at: '2022-10-10T05:32:17.78Z'
updated_at: '2022-10-10T05:32:17.78Z'
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: Amy White
security_code_verification: UNKNOWN
tags:
card_name: Business Card
type: PAYMENT_CARD
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/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/PImmCg3Po7oNi7jaZcXhfkEu/updates
Payment Instrument - Apple Pay:
value:
id: PImE5ZhGZJNFy14DtX8wX6f6
created_at: '2022-10-10T05:36:55.27Z'
updated_at: '2022-10-10T05:36:55.27Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
enabled: true
fingerprint: FPR88YBDbK4TqYMUNU8t8fbeQ
identity: IDgWxBhfGYLLdkhxx2ddYf9K
instrument_type: APPLE_PAY
bin: '370382'
brand: AMERICAN_EXPRESS
card_type: UNKNOWN
expiration_month: 11
expiration_year: 2024
issuer_country: UNKNOWN
last_four: '8576'
name: John Smith
tags: {}
type: APPLE_PAY
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PImE5ZhGZJNFy14DtX8wX6f6/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K
Payment Instrument - Google Pay:
value:
id: PIf8dyFFcEGBqPhaG22hPyYs
created_at: '2022-10-10T05:36:55.27Z'
updated_at: '2022-10-10T05:36:55.27Z'
application: APeUfzF5qdNkBCtdgcf3333n
created_via: API
currency: USD
enabled: true
fingerprint: FPRrcobjtdU98gr4sjiqYR1Qg
identity: ID78Fh8mcnnzukVzbdoyex5y
instrument_type: GOOGLE_PAY
bin: '411111'
brand: VISA
card_type: UNKNOWN
expiration_month: 12
expiration_year: 2027
issuer_country: UNKNOWN
last_four: '1111'
name: Finix Sandbox
tags: {}
type: GOOGLE_PAY
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APeUfzF5qdNkBCtdgcf3333n
identity:
href: https://finix.sandbox-payments-api.com/identities/ID78Fh8mcnnzukVzbdoyex5y
Payment Instrument - Update a Card's Address:
value:
id: PIwWisLuZNwPBoLbCgQVTCoY
created_at: '2022-08-15T23:13:06.13Z'
updated_at: '2023-02-28T21:12:29.72Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: null
disabled_message: null
enabled: true
fingerprint: FPRmYp7ejhA3yDjSor4A5Ji2D
identity: IDgWxBhfGYLLdkhxx2ddYf9K
instrument_type: PAYMENT_CARD
address:
line1: 900 Metro Center Blv
line2: Suite 200
city: Los Angeles
region: CA
postal_code: '94404'
country: USA
address_verification: UNKNOWN
bin: '400000'
brand: VISA
card_type: UNKNOWN
expiration_month: 12
expiration_year: 2029
issuer_country: UNKNOWN
last_four: '9979'
name: Amy White
security_code_verification: UNMATCHED
tags:
card_name: Business Card
custom_key: custome value
type: PAYMENT_CARD
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/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/PIwWisLuZNwPBoLbCgQVTCoY/updates
Payment Instrument - Disable a Payment Instrument:
value:
id: PIwbvcQGrEP33HShmYM7BR8o
created_at: '2023-02-28T19:05:56.24Z'
updated_at: '2023-02-28T21:16:18.80Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: USER_INITIATED
disabled_message: The card has been disabled by a user.
enabled: false
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: null
tags:
card_name: Personal Card
type: BANK_ACCOUNT
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
Payment Instrument - Bank Account Validation Check:
value:
id: PIpU66orYpdrPSs91fqRJd66
created_at: '2023-03-13T23:28:34.10Z'
updated_at: '2023-03-13T23:28:34.10Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: null
disabled_message: null
enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: VALID
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: null
tags: {}
type: BANK_ACCOUNT
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIpU66orYpdrPSs91fqRJd66/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
href: https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG
Payment Instrument - Update Payment Instrument Tags:
value:
id: PIwbvcQGrEP33HShmYM7BR8o
created_at: '2023-02-28T19:05:56.24Z'
updated_at: '2023-02-28T21:18:24.79Z'
application: APgPDQrLD52TYvqazjHJJchM
created_via: API
currency: USD
disabled_code: null
disabled_message: null
enabled: true
fingerprint: FPRd5moHxL3Ltuvk4cczxetCg
identity: IDpYDM7J9n57q849o9E9yNrG
instrument_type: BANK_ACCOUNT
account_type: SAVINGS
bank_account_validation_check: NOT_ATTEMPTED
bank_code: '123123123'
country: USA
masked_account_number: XXXXX3123
name: null
tags:
card_name: Personal Card
type: BANK_ACCOUNT
_links:
self:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o
authorizations:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations
transfers:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers
verifications:
href: https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications
application:
href: https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM
identity:
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finix-payments/refs/heads/main/openapi/finix-payments-payment-instruments-api-openapi.yml