POST
/
transfers
Create a transfer
curl --request POST \
  --url https://api.bridge.xyz/v0/transfers \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "client_reference_id": "<string>",
  "amount": "<string>",
  "on_behalf_of": "<string>",
  "developer_fee": "<string>",
  "developer_fee_percent": "<string>",
  "source": {
    "currency": "dai",
    "payment_rail": "ach",
    "payment_scheme": "reversed_payment",
    "external_account_id": "<string>",
    "bridge_wallet_id": "<string>",
    "from_address": "<string>"
  },
  "destination": {
    "currency": "dai",
    "payment_rail": "ach",
    "external_account_id": "<string>",
    "bridge_wallet_id": "<string>",
    "wire_message": "<string>",
    "sepa_reference": "<string>",
    "swift_reference": "<string>",
    "spei_reference": "<string>",
    "swift_charges": "our",
    "ach_reference": "<string>",
    "blockchain_memo": "<string>",
    "deposit_id": "<string>",
    "to_address": "<string>"
  },
  "features": {
    "flexible_amount": true,
    "static_template": true,
    "allow_any_from_address": true
  }
}'
{
  "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

Headers

​
Idempotency-Key
string
required

Body

application/json

Transfer object to be created

The body is of type object.

Response

201
application/json

Transfer object created

The response is of type object.