Execute a pending USDT trade on a transfer

curl --request POST \
  --url https://api.bridge.xyz/v0/transfers/{transferID}/execute \
  --header 'Api-Key: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

import requests

url = "https://api.bridge.xyz/v0/transfers/{transferID}/execute"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Api-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', 'Api-Key': '<api-key>'}
};

fetch('https://api.bridge.xyz/v0/transfers/{transferID}/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bridge.xyz/v0/transfers/{transferID}/execute",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bridge.xyz/v0/transfers/{transferID}/execute"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bridge.xyz/v0/transfers/{transferID}/execute")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bridge.xyz/v0/transfers/{transferID}/execute")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "amount": "<string>",
  "currency": "usd",
  "on_behalf_of": "<string>",
  "developer_fee": "<string>",
  "source": {
    "currency": "brl",
    "payment_rail": "ach",
    "payment_scheme": "sepa_credit",
    "omad": "<string>",
    "imad": "<string>",
    "trace_number": "<string>",
    "bank_beneficiary_name": "<string>",
    "bank_beneficiary_address": "<string>",
    "bank_routing_number": "<string>",
    "bank_name": "<string>",
    "originator_name": "<string>",
    "originator_address": "<string>",
    "wire_message": "<string>",
    "bridge_wallet_id": "<string>",
    "sender_name": "<string>",
    "sender_bank_routing_number": "<string>",
    "end_to_end_id": "<string>",
    "description": "<string>",
    "tracking_number": "<string>",
    "clabe": "<string>",
    "bank_code": "<string>",
    "transaction_id": "<string>",
    "co_bank_transfer": {
      "sender_data": {
        "full_name": "<string>",
        "document_type": "cc",
        "document_number": "<string>",
        "email": "<string>",
        "phone_number": "<string>"
      }
    },
    "payment_received_rail": "ach",
    "from_address": "<string>"
  },
  "destination": {
    "currency": "brl",
    "payment_rail": "ach",
    "external_account_id": "<string>",
    "bridge_wallet_id": "<string>",
    "omad": "<string>",
    "imad": "<string>",
    "trace_number": "<string>",
    "end_to_end_id": "<string>",
    "wire_message": "<string>",
    "sepa_reference": "<string>",
    "swift_reference": "<string>",
    "spei_reference": "<string>",
    "reference": "<string>",
    "charge_bearer": "our",
    "ach_reference": "<string>",
    "uetr": "<string>",
    "blockchain_memo": "<string>",
    "deposit_id": "<string>",
    "tracking_number": "<string>",
    "transaction_id": "<string>",
    "sending_institution_name": "<string>",
    "amount": "<string>",
    "to_address": "<string>"
  },
  "state": "awaiting_funds",
  "receipt": {
    "initial_amount": "<string>",
    "developer_fee": "<string>",
    "exchange_fee": "<string>",
    "subtotal_amount": "<string>",
    "developer_exchange_fee": {
      "amount": "<string>",
      "currency": "<string>"
    },
    "pre_conversion_subtotal_amount": "<string>",
    "mid_market_rate": "<string>",
    "converted_amount": "<string>",
    "remaining_prefunded_balance": "<string>",
    "gas_fee": "<string>",
    "final_amount": "<string>",
    "source_tx_hash": "<unknown>",
    "destination_tx_hash": "<unknown>",
    "exchange_rate": "<unknown>",
    "url": "<string>",
    "bank_details": {
      "sending_routing_number": "<string>",
      "ach_description": "<string>",
      "ach_trace_id": "<string>",
      "wire_message": "<string>",
      "imad": "<string>",
      "recipient_name": "<string>",
      "sending_bic": "<string>",
      "sepa_reference": "<string>",
      "uetr": "<string>",
      "receiving_account_last_four": "<string>",
      "receiving_bic": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "client_reference_id": "<string>",
  "developer_fee_percent": "<string>",
  "source_deposit_instructions": {
    "payment_rail": "wire",
    "amount": "75.0",
    "currency": "usd",
    "deposit_message": "BVI7depositmessage",
    "bank_name": "Bank name",
    "bank_address": "Bank address",
    "bank_routing_number": "123456789",
    "bank_account_number": "1234567890",
    "bank_beneficiary_name": "Bank beneficiary",
    "bank_beneficiary_address": "Bank beneficiary address"
  },
  "return_details": {
    "reason": "<string>",
    "refund_reference_id": "<string>",
    "risk_rejection_reason": "<string>"
  },
  "return_instructions": {
    "address": "<string>",
    "memo": "<string>"
  },
  "exchange_details": {
    "fixed_rate": "<string>",
    "estimated_market_rate": "<string>",
    "traded_market_rate": "<string>",
    "trade_at_market": true,
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "template_id": "<string>",
  "first_confirmed_at": "2023-11-07T05:31:56Z"
}

POST

transfers

{transferID}

execute

Execute a pending USDT trade on a transfer

curl --request POST \
  --url https://api.bridge.xyz/v0/transfers/{transferID}/execute \
  --header 'Api-Key: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

import requests

url = "https://api.bridge.xyz/v0/transfers/{transferID}/execute"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Api-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', 'Api-Key': '<api-key>'}
};

fetch('https://api.bridge.xyz/v0/transfers/{transferID}/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bridge.xyz/v0/transfers/{transferID}/execute",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bridge.xyz/v0/transfers/{transferID}/execute"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bridge.xyz/v0/transfers/{transferID}/execute")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bridge.xyz/v0/transfers/{transferID}/execute")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "amount": "<string>",
  "currency": "usd",
  "on_behalf_of": "<string>",
  "developer_fee": "<string>",
  "source": {
    "currency": "brl",
    "payment_rail": "ach",
    "payment_scheme": "sepa_credit",
    "omad": "<string>",
    "imad": "<string>",
    "trace_number": "<string>",
    "bank_beneficiary_name": "<string>",
    "bank_beneficiary_address": "<string>",
    "bank_routing_number": "<string>",
    "bank_name": "<string>",
    "originator_name": "<string>",
    "originator_address": "<string>",
    "wire_message": "<string>",
    "bridge_wallet_id": "<string>",
    "sender_name": "<string>",
    "sender_bank_routing_number": "<string>",
    "end_to_end_id": "<string>",
    "description": "<string>",
    "tracking_number": "<string>",
    "clabe": "<string>",
    "bank_code": "<string>",
    "transaction_id": "<string>",
    "co_bank_transfer": {
      "sender_data": {
        "full_name": "<string>",
        "document_type": "cc",
        "document_number": "<string>",
        "email": "<string>",
        "phone_number": "<string>"
      }
    },
    "payment_received_rail": "ach",
    "from_address": "<string>"
  },
  "destination": {
    "currency": "brl",
    "payment_rail": "ach",
    "external_account_id": "<string>",
    "bridge_wallet_id": "<string>",
    "omad": "<string>",
    "imad": "<string>",
    "trace_number": "<string>",
    "end_to_end_id": "<string>",
    "wire_message": "<string>",
    "sepa_reference": "<string>",
    "swift_reference": "<string>",
    "spei_reference": "<string>",
    "reference": "<string>",
    "charge_bearer": "our",
    "ach_reference": "<string>",
    "uetr": "<string>",
    "blockchain_memo": "<string>",
    "deposit_id": "<string>",
    "tracking_number": "<string>",
    "transaction_id": "<string>",
    "sending_institution_name": "<string>",
    "amount": "<string>",
    "to_address": "<string>"
  },
  "state": "awaiting_funds",
  "receipt": {
    "initial_amount": "<string>",
    "developer_fee": "<string>",
    "exchange_fee": "<string>",
    "subtotal_amount": "<string>",
    "developer_exchange_fee": {
      "amount": "<string>",
      "currency": "<string>"
    },
    "pre_conversion_subtotal_amount": "<string>",
    "mid_market_rate": "<string>",
    "converted_amount": "<string>",
    "remaining_prefunded_balance": "<string>",
    "gas_fee": "<string>",
    "final_amount": "<string>",
    "source_tx_hash": "<unknown>",
    "destination_tx_hash": "<unknown>",
    "exchange_rate": "<unknown>",
    "url": "<string>",
    "bank_details": {
      "sending_routing_number": "<string>",
      "ach_description": "<string>",
      "ach_trace_id": "<string>",
      "wire_message": "<string>",
      "imad": "<string>",
      "recipient_name": "<string>",
      "sending_bic": "<string>",
      "sepa_reference": "<string>",
      "uetr": "<string>",
      "receiving_account_last_four": "<string>",
      "receiving_bic": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "client_reference_id": "<string>",
  "developer_fee_percent": "<string>",
  "source_deposit_instructions": {
    "payment_rail": "wire",
    "amount": "75.0",
    "currency": "usd",
    "deposit_message": "BVI7depositmessage",
    "bank_name": "Bank name",
    "bank_address": "Bank address",
    "bank_routing_number": "123456789",
    "bank_account_number": "1234567890",
    "bank_beneficiary_name": "Bank beneficiary",
    "bank_beneficiary_address": "Bank beneficiary address"
  },
  "return_details": {
    "reason": "<string>",
    "refund_reference_id": "<string>",
    "risk_rejection_reason": "<string>"
  },
  "return_instructions": {
    "address": "<string>",
    "memo": "<string>"
  },
  "exchange_details": {
    "fixed_rate": "<string>",
    "estimated_market_rate": "<string>",
    "traded_market_rate": "<string>",
    "trade_at_market": true,
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "template_id": "<string>",
  "first_confirmed_at": "2023-11-07T05:31:56Z"
}

Authorizations

Api-Key

string

header

required

Headers

Idempotency-Key

string

required

Path Parameters

transferID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

Response

Transfer with trade execute at market rate enabled successfully

string

required

read-only

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Pattern: [a-z0-9]*

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,

brl,

cop,

gbp

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

Show child attributes

destination

object

required

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

Show child attributes

state

enum<string>

required

read-only

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,

refund_in_flight,

refund_failed,

refunded

receipt

object

required

Receipt information of a transfer

Show child attributes

created_at

string<date-time>

required

read-only

Time of creation of the transfer

updated_at

string<date-time>

required

read-only

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

Fiat · object

read-only

Instructions for a fiat bank deposit. Which bank fields are present depends on the payment rail.

Fiat
Crypto

Show child attributes

Example:

{
  "payment_rail": "wire",
  "amount": "75.0",
  "currency": "usd",
  "deposit_message": "BVI7depositmessage",
  "bank_name": "Bank name",
  "bank_address": "Bank address",
  "bank_routing_number": "123456789",
  "bank_account_number": "1234567890",
  "bank_beneficiary_name": "Bank beneficiary",
  "bank_beneficiary_address": "Bank beneficiary address"
}

return_details

object

read-only

Return information, if the transfer has been returned.

Show child attributes

return_instructions

object

read-only

Optional return instructions configured when creating or updating the transfer.

Show child attributes

exchange_details

object

read-only

Exchange details for the associated trade, if applicable.

Show child attributes

template_id

string

read-only

The ID of the static template transfer from which this transfer was instantiated. Only present for transfers created from a template.

Required string length: 1 - 42

Pattern: [a-z0-9]*

first_confirmed_at

string<date-time>

read-only

Time when the withdrawal transaction received its first on-chain confirmation. Only present for crypto withdrawal transfers where this feature is enabled for the developer.