Bridge Transfers API is one of 24 APIs that Bridge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transfers. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
8 operations
across 5 paths,
and defines 57 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.
The identity and technical contract details declared by the specification.
TravelRuleWalletAttestedOwnershipAt
string
Required when wallettype is self-custodied or hosted. Must be a timestamp in the past indicating when wallet ownership was attested.
TravelRuleData
object
Travel Rule data for a crypto movement. Send this on create or update when the same counterparty should apply to every future use of a reusable resource, or se…
2 properties
TransferRouteResponse
object
2 properties
2 required
TransferReturnDetails
object
3 properties
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…
Error
object
3 properties
2 required
ExchangeDetails
object
Exchange information for a currency conversion.
5 properties
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…
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
TransferDestination
object
22 properties
2 required
SepaSwiftInclusivePaymentRail
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…
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…
Uetr
string
Deprecated: use trackingnumber instead. The unique end-to-end transaction reference, for tracing purposes.
Imad
string
(Wire only) The IMAD of a wire transfer, if available
TransferRequest
object
13 properties
3 required
TransferInitiation
object
Payment initiation context required for transfers sourced from wallets where initiationrequired: true. Captures how the payment was initiated (channel and subc…
3 properties
3 required
DepositInstructions
object
24 properties
3 required
CoBankTransferDocumentType
string
Colombian document type identifier. cc = Cédula de Ciudadanía, ce = Cédula de Extranjería, nit = NIT (tax ID), rut = RUT (worker registration), pa = Passport,…
TransferInitiationSca
object
2 properties
1 required
EuroInclusiveCurrency
string
IdentifyingInformation
array
TransactionId
string
Deprecated: use trackingnumber instead. The unique transaction identifier for this payment.
TravelRuleName
string
Legal name of the originator or beneficiary. Usually omitted when isself is true.
TransferResponse
object
18 properties
11 required
Id
string
A UUID that uniquely identifies a resource
EuroInclusiveFiatCurrency
string
Receipt
object
12 properties
4 required
TraceNumber
string
The trace number of an ACH transfer
Omad
string
(Wire only) The OMAD of a wire transfer, if available
TransferSourcePaymentRail
string
Clabe
string
The 18-digit CLABE (Clave Bancaria Estandarizada) of the sender who initiated this SPEI transaction
TransferInitiationAuthFactor
object
3 properties
3 required
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…
client_reference_id
string
A client-provided reference ID that uniquely identifies a resource in the client's system
PlaceOfBirthInput
object
Country (and optionally city) of birth. EEA / BBSA in-scope customers: supply when onboarding individuals or associated persons under the [EEA updated requirem…
2 properties
TravelRuleBeneficiary
object
Travel Rule details for beneficiary crypto movement.
6 properties
DepositId
string
A UUID that uniquely identifies a deposit
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
TravelRuleAddress
object
Address for travel rule submissions. All fields are optional to support partial address data (e.g. country-only).
6 properties
Reference
A payment reference message for newer payment rails (e.g. Pix and Faster Payments).
TransferUpdateRequest
object
4 properties
TravelRuleWalletType
string
Indicates the custody model for the wallet. Use selfcustodied for customer-owned wallets (customer controls private keys), hosted for wallets managed by a deve…
TransferInitiationAttestations
object
1 property
1 required
TransferSource
object
23 properties
2 required
TravelRuleOriginator
object
Travel Rule details for originator crypto movement.
9 properties
ReturnInstructions
object
Optional instructions for where to send funds if the transfer is returned (e.g. refund). Only supported when the source payment rail is crypto. Memo is require…
2 properties
1 required
TravelRuleIsSelf
boolean
Set to true when this party is the same person or business as the Bridge customer on the resource. When true, Bridge uses the customer's name and address on fi…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bridge publishes across the network.
