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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Finix

Finix Settlements API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Settlement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 7 operations across 5 paths, and defines 31 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.

7 operations 5 paths 31 schemas 1 DELETE4 GET1 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
Finix
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 7

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

Settlements 7

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

POST
/identities/{identity_id}/settlements
Close Current Active Settlement
createIdentitySettlement 1 param body → 201400401403404406422
GET
/settlements
List All Settlements
listSettlements 10 params → 200401403406
GET
/settlements/{settlement_id}
Fetch a Settlement
getSettlement 1 param → 200401403404406
PUT
/settlements/{settlement_id}
Close a Settlement
closesettlements 2 params body → 201401403404406
GET
/settlements/{settlement_id}/funding_transfers
List Settlement Funding Transfers
listSettlementFundingTransfers 2 params → 200401403404406
DELETE
/settlements/{settlement_id}/transfers
Delete Settlement Transfers
removeSettlementTransfers 1 param body → 204401403404406422
GET
/settlements/{settlement_id}/transfers
List all Transfers in a Settlement
listSettlementTransfers 2 params → 200401403404406

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Transfer (37 properties), Settlement (19 properties), AdditionalPurchaseData (12 properties), CardPresentDetails (7 properties). Each schema is shown below with its type and property counts.

Error422InvalidFieldList
object
Invalid field
2 properties
ErrorGeneric
object
2 properties
Amount
integer
The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
FailureMessage
string
A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.
Error403ForbiddenList
object
2 properties
Messages
array
Message field that provides additional details. This field is typically null.
Raw
object
Raw response from the processor.
UpdatedAt
string
Timestamp of when the object was last updated.
PageCursor
object
Details the page that's returned.
2 properties
FeeType
string
Details the type of fee if the Transfer includes a fee.
CardPresentDetails
object
Details needed to process card present transactions.
7 properties
AdditionalPurchaseData
object
Additional information about the purchase. Used for [Level 2 and Level 3 Processing](/guides/payments/modify/level-2-and-level-3-processing/).
12 properties 2 required
SettlementsList
object
3 properties
Transfer
object
37 properties
AdditionalHealthcareData
object
Optional object detailing [specific healthcare amounts](/guides/making-a-payment/hsa-fsa/).
4 properties
Error404NotFoundList
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
LogRef
object
1 property
FailureCode
string
The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/developers/erro…
RemoveSettlementTransfer
object
1 property
Error406NotAcceptable
object
2 properties
CloseSettlement
object
1 property 1 required
Currency
string
ISO 4217 3 letter currency code.
TransfersList
object
3 properties
Error401Unauthorized
object
2 properties
Settlement
object
19 properties
CreatedAt
string
Timestamp of when the object was created.
CreateSettlementRequest
object
4 properties
IdempotencyId
string
Pass any randomly generated or internal ID to [idempotently](/api/overview/section/Idempotency-Requests) identify Transfers, Authorizations, and refund request…
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…
AdditionalBuyerCharges
object
Object detailing any [Buyer Charges](/guides/payments/making-a-payment/buyer-charges/) that got included in the Authorization.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

finix-settlements-api-openapi.yml Raw ↑

Other APIs Finix publishes across the network.

Finix Authorizations API
AE Profile APIs.io
Finix Balance Transfers API
AE Profile APIs.io
Finix Compliance Forms API
AE Profile APIs.io
Finix Devices API
AE Profile APIs.io
Finix Disputes API
AE Profile APIs.io
Finix Fee Profiles API
AE Profile APIs.io
Finix Files API
AE Profile APIs.io
Finix Identities API
AE Profile APIs.io
Finix Instrument Updates API
AE Profile APIs.io
Finix Merchant Profiles API
AE Profile APIs.io
Finix Merchants API
AE Profile APIs.io
Finix Onboarding Forms API
AE Profile APIs.io
#Settlement
← Back to F APIs
API Details
ID
finix:finix-settlements-api
Base URL
https://finix.live-payments-api.com
Docs
https://docs.finix.com/
Provider
Finix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=finix-settlements-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/finix-settlements-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Finix Settlements 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.