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
PEXA

PEXA Settlement API

The Settlement API from PEXA — 8 operation(s) for settlement.

Documentation Provider Profile APIs.io OpenAPI GitHub

PEXA Settlement API is one of 18 APIs that PEXA 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, an API reference, authentication docs, and API documentation.

This API exposes 14 operations across 8 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://localhost/.

14 operations 8 paths 20 schemas 8 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.pexa.com.au
Resource Areas
1

Paths & Operations 14

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

Settlement 14
GET
/v1/workspace/financial
Retrieves settlement statement
retrieveSetllementStatementV1UsingGET 3 params → 200401403404
POST
/v1/workspace/financial
Upload Financial Settlement Line Items
createUsingPOST_1 body → 200201401403404
GET
/v1/workspace/settlement
Retrieves Settlement Availability
settlementAvailability 4 params → 200401403404
PUT
/v1/workspace/settlement
Maintain Settlement Date and Time
maintainsettlement_1 body → 200201401403404
GET
/v1/workspace/settlementCompletionRecord
Generate the Settlement Completion Record
retrieveSettlementCompletionRecordV1UsingGET 3 params → 200401403404
GET
/v1/workspace/{workspaceId}/settlement/balanceDueToEffectSettlement
Add/Update/Agree Balance due to effect Settlement
createUsingGET 2 params body → 200401403404
PUT
/v1/workspace/{workspaceId}/settlement/balanceDueToEffectSettlement
Add/Update/Agree Balance due to effect Settlement
createUsingPUT 2 params body → 200201401403404
GET
/v2/workspace/financial
Retrieves settlement statement
retrieveSetllementStatementV1UsingGET 3 params → 200401403404
POST
/v2/workspace/financial
Upload Financial Settlement Line Items
createUsingPOST_1 body → 200201401403404
GET
/v2/workspace/settlement
Retrieves Settlement Availability
settlementAvailability 4 params → 200401403404
PUT
/v2/workspace/settlement
Maintain Settlement Date and Time
maintainsettlement_1 body → 200201401403404
GET
/v2/workspace/settlementCompletionRecord
Generate the Settlement Completion Record
retrieveSettlementCompletionRecordV1UsingGET 3 params → 200401403404
GET
/v2/workspace/{workspaceId}/settlement/balanceDueToEffectSettlement
Retrieve Balance due to effect Settlement
getBalanceDueToEffectSettlementUsingGET 2 params → 200401403404
PUT
/v2/workspace/{workspaceId}/settlement/balanceDueToEffectSettlement
Add/Update/Agree Balance due to effect Settlement
updateBalanceDueToEffectSettlementUsingPUT 2 params body → 200201401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem (10 properties), au.net.pexa.api.schema._1.MaintainSettlementDateAndTimeRequest (6 properties), au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination (4 properties), au.net.pexa.api.schema._1.SettlementUploadRequest (4 properties). Each schema is shown below with its type and property counts.

au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse
object
2 properties
au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents.Document
object
3 properties
au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails
object
2 properties
au.net.pexa.api.schema._1.SettlementAvailabilityResponse
object
3 properties
au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.BPay
object
2 properties
au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents
object
1 property
au.net.pexa.api.schema._1.AvailableSettlementTimeType
object
1 property
au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Source
object
2 properties
au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.Account
object
3 properties
au.net.pexa.api.schema._1.SettlementDetailsType
object
3 properties
au.net.pexa.api.schema._1.MaintainSettlementDateAndTimeRequest
object
6 properties
au.net.pexa.api.schema._1.SettlementStatementRetrieval
object
2 properties
au.net.pexa.api.schema._1.SettlementUploadResponse
object
1 property
au.net.pexa.api.schema._1.WarningResponseType
object
2 properties
au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination
object
4 properties
au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem
object
10 properties
au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule
object
1 property
au.net.pexa.api.schema._1.SettlementUploadRequest
object
4 properties
au.net.pexa.api.schema._1.BalanceDueToEffectSettlementRequest
object
1 property
au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pexa-settlement-api-openapi.yml Raw ↑

Other APIs PEXA publishes across the network.

PEXA Exchange API
AE Profile APIs.io
PEXA Billing API
AE Profile APIs.io
PEXA Conversation API
AE Profile APIs.io
PEXA Document API
AE Profile APIs.io
PEXA Health Check API
AE Profile APIs.io
PEXA Invitation API
AE Profile APIs.io
PEXA Landtitle API
AE Profile APIs.io
PEXA Notification API
AE Profile APIs.io
PEXA Notification Service [$] API
AE Profile APIs.io
PEXA Notification Registration API
AE Profile APIs.io
PEXA Project API
AE Profile APIs.io
PEXA Standalone Discharge Experience API
AE Profile APIs.io
#Settlement
← Back to P APIs
API Details
ID
pexa:pexa-settlement-api
Base URL
https://api.pexa.com.au
Docs
https://developer.pexa.com.au/Exchange/api/apireference/
Provider
PEXA
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=pexa-settlement-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pexa-settlement-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 PEXA Settlement 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.