PUT
/
transfers
/
{transferID}
Update a transfer
curl --request PUT \
  --url https://api.bridge.xyz/v0/transfers/{transferID} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "<string>",
  "developer_fee": "<string>",
  "developer_fee_percent": "<string>"
}'
{
  "id": "transfer_123",
  "client_reference_id": "client_transfer_id_123",
  "state": "awaiting_funds",
  "on_behalf_of": "cust_123",
  "amount": "75.0",
  "developer_fee": "0.0",
  "source": {
    "payment_rail": "ethereum",
    "currency": "usdc",
    "from_address": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
  },
  "destination": {
    "payment_rail": "ach",
    "currency": "usd",
    "external_account_id": "ext_123"
  },
  "source_deposit_instructions": {
    "payment_rail": "ethereum",
    "amount": "75.0",
    "currency": "usdc",
    "from_address": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
    "to_address": "0xb794f5ea0ba39494ce839613fffba74279579268"
  },
  "receipt": {
    "initial_amount": "75.0",
    "developer_fee": "0.0",
    "exchange_fee": "0.0",
    "subtotal_amount": "75.0",
    "gas_fe": "0.0",
    "final_amount": "75.0",
    "url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"
  },
  "created_at": "2020-01-01T00:00:00.000Z",
  "updated_at": "2020-01-02T00:00:00.000Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
transferID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Body

application/json

Transfer object to be updated

​
amount
string

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.

​
developer_fee
string

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_percent
string

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.

Response

Transfer object created

​
id
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
​
amount
string
required

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.

​
currency
enum<string>
required

Fiat currency for the transfer amount and developer fee. It's the source currency if that is a fiat currency or the fiat currency to which the source currency is pegged.

Available options:
usd,
eur,
mxn
​
on_behalf_of
string
required

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

​
developer_fee
string
required

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.

​
source
object
required

The source of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address

​
destination
object
required

The destination of the transfer, which could be an external bank account, a bridge account, or a crypto wallet address

​
state
enum<string>
required

Status of the transfer. See Transfer States for more details.

Available options:
awaiting_funds,
in_review,
funds_received,
payment_submitted,
payment_processed,
canceled,
undeliverable,
returned,
refunded
​
receipt
object
required

Receipt information of a transfer

​
created_at
string<date-time>
required

Time of creation of the transfer

​
updated_at
string<date-time>
required

Time of update of the transfer

​
client_reference_id
string

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

Required string length: 1 - 256
​
developer_fee_percent
string

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.

​
source_deposit_instructions
object

Some transfers require a deposit to be made by the customer before Bridge can start the process. Instructions for how to kick off the transfer will be included here. The deposit must match these instructions exactly, or the transfer will fail.

​
return_details
object

Return information, if the transfer has been returned.