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

Paxos Settlement API

Use the Settlements API to facilitate simultaneous exchange of pre-funded assets. Automate a variety of use cases that require two-party approval, including net settlement of over-the-counter trades, withdrawal requests for tri-party collateral, payment requests, and bilateral settlement for marketplace end users.The simple request-and-approval workflow supports both one-directional and bidirectional transactions to allow a user to receive an asset (for example, send USDP) or simultaneously send and receive assets (for example, send USD and receive BTC and ETH). Only when all parties are in agreement and assets are fully funded does the Settlements API allow for change of custody. Upon completion, all settled assets are immediately available for trading, transferring, withdrawal or other supported activities.The Source Profile initiates the transaction for the Target Profile to approve. The `DIRECTION` of each asset is always relative to the Source Profile and only the owner of the Source Profile can cancel a transaction if it hasn't been approved by the Target Profile.

Paxos Settlement API is one of 43 APIs that Paxos 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.

This API exposes 5 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against 2 base URLs: https://api.paxos.com/v2, https://api.sandbox.paxos.com/v2.

5 operations 3 paths 8 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.paxos.com/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Paxos Settlement API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 36 scopes.

  • OAuth2 — Paxos APIs use [OAuth 2](https://tools.ietf.org/html/rfc6749) with the [client credentials](https://tools.ietf.org/html/rfc6749section-4.4) grant flow. Token U…

Paths & Operations 5

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

Settlement 5

Use the Settlements API to facilitate simultaneous exchange of pre-funded assets. Automate a variety of use cases that require two-party approval, including net settlement of over…

GET
/settlement/transactions
List Transactions
ListTransactions 5 params → 200403
POST
/settlement/transactions
Create Transaction
CreateTransaction body → 200400403409
GET
/settlement/transactions/{transaction_id}
Get Transaction
GetTransaction 1 param → 200403404
DELETE
/settlement/transactions/{transaction_id}
Cancel Transaction
CancelTransaction 1 param → 200403409
PUT
/settlement/transactions/{transaction_id}/affirm
Affirm Transaction
AffirmTransaction 1 param → 200400403

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Transaction (10 properties), CreateTransactionRequest (6 properties), Problem (5 properties), Obligation (4 properties). Each schema is shown below with its type and property counts.

Transaction
object
Transaction returned on create (Create Transaction), list (List Transactions) and get (Get Transaction) requests.
10 properties 10 required
TransactionStatus
string
- PENDING: Initial state of a settlement transaction upon creation. - SETTLED: Indicates all obligations belong to the settlement transaction have been enacted…
CreateObligationRequest
object
Request to create a obligation.
3 properties
CreateTransactionRequest
object
Request to create a bilateral settlement transaction with one or more legs.
6 properties
ObligationDirection
string
Direction of asset delivery for an obligation. - DELIVER: Assets are delivered from the source profile to the target profile. - RECEIVE: Assets are delivered f…
ListTransactionsResponse
object
2 properties
Obligation
object
4 properties 4 required
Problem
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paxos-settlement-api-openapi.yml Raw ↑

Other APIs Paxos publishes across the network.

Paxos Account Members API
Paxos Accounts API
Paxos Address Verification API
Paxos API Credentials API
Paxos Claims API
Paxos Crypto Deposits API
Paxos Crypto Withdrawals API
Paxos Deposit Addresses API
Paxos Events API
Paxos ExchangePublic API
Paxos Fees API
Paxos Fiat Transfers API
Where this information came from

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