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

Bridge Batch Settlements API

The Batch Settlements API from Bridge — 1 operation(s) for batch settlements.

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

Tagged areas include Batch Settlements. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 1 operation across 1 path, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://api.bridge.xyz/v0.

1 operations 1 paths 24 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://api.bridge.xyz/v0
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Bridge Batch Settlements API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Key (ApiKey). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Batch Settlements 1
POST
/customers/{customerID}/batch_settlement_schedulesdeprecated
Create a Batch Settlement Schedule
2 params body → 200401400500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are TransferDestination (22 properties), Error (3 properties), CreateBatchSettlementSchedule (1 property). Each schema is shown below with its type and property counts.

TransferDestination
object
22 properties 2 required
EuroInclusiveCurrency
string
SepaReference
string
A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must b…
AchReference
string
A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.
EndToEndId
string
The end-to-end ID of the FedNow transaction, assigned by the sending bank, and is not guaranteed to be unique across payments.
FasterPaymentsReference
string
TransactionId
string
Deprecated: use trackingnumber instead. The unique transaction identifier for this payment.
TrackingNumber
string
The primary tracking identifier for this fiat transaction. Format varies by payment rail (e.g., UETR for SEPA/FPS, clave de rastreo for SPEI, end-to-end ID for…
PixReference
string
Uetr
string
Deprecated: use trackingnumber instead. The unique end-to-end transaction reference, for tracing purposes.
Id
string
A UUID that uniquely identifies a resource
Reference
A payment reference message for newer payment rails (e.g. Pix and Faster Payments).
TraceNumber
string
The trace number of an ACH transfer
Omad
string
(Wire only) The OMAD of a wire transfer, if available
Imad
string
(Wire only) The IMAD of a wire transfer, if available
ChargeBearer
string
Which party bears the SWIFT transaction charges. - our: the sender (ordering customer) pays all charges. - sha: charges are shared — the sender pays their own…
SepaSwiftInclusiveOfframpPaymentRail
string
WireMessage
string
A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 chara…
Error
object
3 properties 2 required
CreateBatchSettlementSchedule
object
1 property 1 required
SwiftReference
string
A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by "\n"), each line with a…
DepositId
string
A UUID that uniquely identifies a deposit
SwiftCharges
string
Deprecated: this schema is the type of the deprecated swiftcharges field and will be removed in a future release. Prefer chargebearer, which is typed by Charge…
SpeiReference
string
A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric a-z, A-Z, 0-9, and space

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bridge-batch-settlements-api-openapi.yml Raw ↑

Other APIs Bridge publishes across the network.

Bridge API Keys API
Bridge Associated Persons API
Bridge Bridge Wallets API
Bridge Cards API
Bridge Crypto Return Policies API
Bridge Customers API
Bridge Developers API
Bridge Exchange Rates API
Bridge External Accounts API
Bridge Fiat Payout Configuration API
Bridge Funds Requests API
Bridge KYC Links API
Where this information came from

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