Sign in

v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Transfers

Create a transfer

Create a transfer.

If this transfer cannot be created because the funding source is temporarily busy processing another update, this endpoint may return 409 resource_state_conflict. This is a transient, retryable response. You may safely retry the same request with the same Idempotency-Key.

post/transfers

Headers

Idempotency-Keystring required

Request body

idstring

A UUID that uniquely identifies a resource

client_reference_idstring

A client-provided reference ID that uniquely identifies a resource in the client's system

amountstring

Amount of the transfer, expressed as a decimal string. Examples include "100.25", "0.1", "1.234567", "1.01" etc.

It is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.

on_behalf_ofstring required

The id of the Bridge customer that you are moving funds on behalf of.

developer_feestring

The fee, expressed as a decimal string, represents the amount you wish to reserve for your own account. This fee is the final amount deducted from what your customer ultimately receives, rather than a percentage.

It is denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged.

developer_fee_percentstring

The fee percent, expressed as a decimal string from 0.0 to 100.0, represents the percentage of the transfer you wish to reserve for your own account.

This field must be set instead of developer_fee when using Flexible Amounts.

dry_runboolean

Whether to validate the transfer route without creating a transfer. If set to true, a valid transfer will return a TransferRouteResponse indicating the transfer would have been valid. The same error response will be returned for an invalid transfer as in the non-dry-run case.

Example request

{
  "travel_rule_data": {
    "originator": {
      "name": "Jane Smith",
      "address": {
        "street_line_1": "123 Market St",
        "street_line_2": null,
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "USA"
      },
      "identifying_information": {
        "type": "national_id",
        "number": "1234567890",
        "issuing_country": "USA"
      },
      "birth_date": "2000-01-31",
      "place_of_birth": {
        "city": "San Francisco",
        "country": "USA"
      },
      "wallet_type": "self_custodied",
      "wallet_attested_ownership_at": "2026-04-01T12:00:00Z"
    },
    "beneficiary": {
      "is_self": true,
      "wallet_type": "external"
    }
  }
}

Response

Transfer object created

OR