How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Finix Payments Payment Instruments API

{'$ref': 'api-descriptions/tags/payment-instruments.md'}

Finix Payments Payment Instruments API is one of 19 APIs that Finix Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Instruments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 21 schemas. It is described by OpenAPI 3.0.2, at version 2022-02-01.

Requests are made against a single base URL, https://finix.sandbox-payments-api.com.

5 operations 3 paths 21 schemas 2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
2022-02-01
Base URL
https://finix.live-payments-api.com
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Finix Payments Payment Instruments API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment Instruments 5

{'$ref': 'api-descriptions/tags/payment-instruments.md'}

POST
/payment_instruments
Create a Payment Instrument
createPaymentInstrument 1 param body → 201400401403406
GET
/payment_instruments
List Payment Instruments
listPaymentInstruments 17 params → 200401403406
GET
/payment_instruments/{payment_instrument_id}
Fetch a Payment Instrument
getPaymentInstrument 1 param → 200401403404406422
PUT
/payment_instruments/{payment_instrument_id}
Update a Payment Instrument
updatePaymentInstrument 2 params body → 200401403404406
POST
/apple_pay_sessions
Create an Apple Pay Session
createApplePaySession body → 200401403404406

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are PaymentInstrument (33 properties), CreatePaymentInstrumentRequest (16 properties), UpdatePaymentInstrumentRequest (7 properties), Address (6 properties). Each schema is shown below with its type and property counts.

Address
object
Address of the account owner.
6 properties
Error406NotAcceptable
object
2 properties
Country
string
The sender’s country.
Currency
string
ISO 4217 3 letter currency code.
PaymentInstrumentsList
object
3 properties
Error401Unauthorized
object
2 properties
CreatePaymentInstrumentRequest
object
16 properties
UpdatePaymentInstrumentRequest
object
7 properties
ErrorGeneric
object
2 properties
Tags
object
Include up to 50 key: value pairs to annotate requests with custom metadata. - Maximum character length for individual keys is 40. - Maximum character length f…
PaymentInstrument
object
33 properties
PageCursor
object
Details the page that's returned.
2 properties
Error403ForbiddenList
object
2 properties
ListLinks
object
For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these links to make your follow-up requ…
2 properties
ApplePaySession
object
5 properties
Error404NotFoundList
object
2 properties
ApplePaySessionRequest
object
4 properties
UpdatedAt
string
Timestamp of when the object was last updated.
Error422InvalidFieldList
object
Invalid field
2 properties
LogRef
object
1 property
CreatedAt
string
Timestamp of when the object was created.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

finix-payments-payment-instruments-api-openapi.yml Raw ↑

Other APIs Finix Payments publishes across the network.

Finix Payments Authorizations API
Finix Payments Balance Transfers API
Finix Payments Compliance Forms API
Finix Payments Devices API
Finix Payments Disputes API
Finix Payments Fee Profiles API
Finix Payments Files API
Finix Payments Identities API
Finix Payments Instrument Updates API
Finix Payments Merchant Profiles API
Finix Payments Merchants API
Finix Payments Onboarding Forms API
Where this information came from

This is an independent, third-party profile of Finix Payments Payment Instruments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.