Get all transfers

Authorizations

Api-Key

string

header

required

Path Parameters

customerID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Query Parameters

limit

integer

The number of items to return (default of 10, max of 100)

starting_after

string

This is a transfer id. If this is specified, the next page that starts with a transfer right AFTER the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers older than the specified transfer id will be returned (shouldn't be set if ending_before is set)

ending_before

string

This is a transfer id. If this is specified, the previous page that ends with a transfer right BEFORE the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers newer than the specified transfer id will be returned (shouldn't be set if starting_after is set)

tx_hash

string

The hash of the transaction

updated_after_ms

integer

This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned

updated_before_ms

integer

This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned

state

enum<string>

Filter transfers by their external state. See Transfer States for more details.

Available options:

awaiting_funds,

funds_received,

payment_submitted,

payment_processed,

in_review,

kyc_required,

kyc_in_review,

developer_kyb_required,

canceled,

error,

returned,

refunded,

undeliverable

Response

List of transfers (the returned list is empty if none found)

count

integer

required

The number of transfers returned

data

object[]

required

Show child attributes

data.id

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

data.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.

data.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

data.on_behalf_of

string

required

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

data.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.

data.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

data.source.currency

enum<string>

required

When eur is specified as the source currency:

the source rail must be sepa;
only usdc or eurc are supported as the destination currency The source currency

Available options:

dai,

eur,

eurc,

mxn,

pyusd,

usd,

usdb,

usdc,

usdt

data.source.payment_rail

enum<string>

required

When sepa is specified as the source rail:

the source currency must be eur;
only usdc or eurc are supported as the destination currency The source payment rail

Available options:

ach,

wire,

ach_push,

ach_same_day,

arbitrum,

avalanche_c_chain,

base,

bridge_wallet,

ethereum,

optimism,

polygon,

sepa,

solana,

spei,

stellar,

swift,

tron

data.source.payment_scheme

enum<string>

(SEPA only) The payment scheme used for this transaction, such as SEPA Credit Transfer or SEPA Instant

Available options:

reversed_payment,

sepa_credit,

sepa_instant

data.source.external_account_id

string

A UUID that uniquely identifies a resource

Required string length: 1 - 42

data.source.omad

string

deprecated

(Wire only) The OMAD of a wire transfer, if available

Required string length: 1 - 40

data.source.imad

string

(Wire only) The IMAD of a wire transfer, if available

Required string length: 1 - 40

data.source.bank_beneficiary_name

string

(Wire only) The name of the beneficiary of the bank account that the customer sent the deposit to

data.source.bank_beneficiary_address

string

(Wire only) The address of the beneficiary of the bank account that the customer sent the deposit to

data.source.bank_routing_number

string

(Wire only) The routing number of the bank that the customer sent the deposit to

data.source.bank_name

string

(Wire only) The name of the bank that the customer sent the deposit to

data.source.originator_name

string

(Wire only) The originator name of this wire

data.source.originator_address

string

(Wire only) The originator address of this wire

data.source.wire_message

string

(Wire only) The memo for this wire

data.source.bridge_wallet_id

string

(Bridge Wallet only) The ID of the Bridge Wallet to draw funds from

Required string length: 1 - 42

data.source.sender_name

string

(ACH only) The name of the business or individual who initiated the transaction

data.source.sender_bank_routing_number

string

(ACH only) The routing number of the entity that initiated this ACH transaction

data.source.description

string

(ACH only) The description of the deposit that the customer sent

data.source.tracking_number

string

The clave de rastreo or tracking number of a SPEI transaction

Required string length: 1 - 30

data.source.transaction_id

string

The unique transaction identifier for a Pix transaction

Required string length: 1 - 50

data.source.from_address

string

The crypto wallet address that the customer will send funds from, in order to kick off this transfer

data.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

data.destination.currency

enum<string>

required

When eur is specified as the destination currency, the destination rail must be sepa. The destination currency

Available options:

dai,

eur,

eurc,

mxn,

pyusd,

usd,

usdb,

usdc,

usdt

data.destination.payment_rail

enum<string>

required

When sepa is specified as the destination payment rail, the destination currency must be eur; when swift is specified as the destination payment rail, the destination currency must be usd. The destination payment rail

Available options:

ach,

wire,

ach_push,

ach_same_day,

arbitrum,

avalanche_c_chain,

base,

ethereum,

fiat_deposit_return,

optimism,

polygon,

sepa,

solana,

spei,

stellar,

swift,

tron

data.destination.external_account_id

string

External bank account Bridge should send the funds to. The currency associated with the External Account must match the destination currency.

Required string length: 1 - 42

data.destination.bridge_wallet_id

string

The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the destination payment rail.

Required string length: 1 - 42

data.destination.omad

string

deprecated

(Wire only) The OMAD of a wire transfer, if available

Required string length: 1 - 40

data.destination.imad

string

(Wire only) The IMAD of a wire transfer, if available

Required string length: 1 - 40

data.destination.trace_number

string

The trace number of an ACH transfer

Required string length: 15

data.destination.wire_message

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 characters according to the Fedwire standard. A message to be sent with a wire transfer, only allowed when the payment rail is a wire. This message will be validated against 4 lines, each with a max length of 35 char according to the Fedwire standard.

Required string length: 1 - 256

data.destination.sepa_reference

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 be from 6 to 140 characters. The allowed characters are a-z, A-Z, 0-9, spaces, ampersand (&), hyphen (-), full stop (.), and solidus (/). If not populated, the default value is "Payment via Bridge {unique_token}".

Required string length: 6 - 140

data.destination.swift_reference

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 max length of 35 chars. The allowed characters are a-z, A-Z, 0-9, special characters (/ - ? : ( ) . , ' +), and space

Required string length: 1 - 190

data.destination.spei_reference

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

Required string length: 1 - 40

data.destination.reference

string

A payment reference message for newer payment rails (e.g. Pix).

data.destination.swift_charges

enum<string>

Which party will bear the charges for the SWIFT transaction. When left blank, sha will be used as the default.

Available options:

our,

sha

data.destination.ach_reference

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.

Required string length: 1 - 10

data.destination.uetr

string

The UETR of this SEPA transaction, for tracing purposes.

Required string length: 36

data.destination.blockchain_memo

string

The memo to include when sending funds on chain. Only allowed for blockchains that support memos such as Stellar A message to be sent with a crypto transaction, only allowed when the payment rail is Stellar.

data.destination.deposit_id

string

A UUID that uniquely identifies a deposit

Required string length: 1 - 42

data.destination.tracking_number

string

The clave de rastreo or tracking number of a SPEI transaction

Required string length: 1 - 30

data.destination.transaction_id

string

The unique transaction identifier for a Pix transaction

Required string length: 1 - 50

data.destination.sending_institution_name

string

The name of the institution sending the funds

data.destination.to_address

string

The crypto wallet address that the customer wishes to ultimately receive funds at, in order to complete this transfer

data.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

data.receipt

object

required

Receipt information of a transfer

Show child attributes

data.receipt.initial_amount

string

required

The initial amount of the transfer, represented as a decimal string. Examples include "100.25", "0.1", "1.234567", "1.01" etc.

It's denominated in the transfer's fiat currency (see the top-level currency field for more info)

data.receipt.developer_fee

string

required

It is denominated in the transfer's fiat currency (see the top-level currency field for more info).

data.receipt.exchange_fee

string

required

The fee, expressed as a decimal string, represents the amount Bridge charges for facilitating the transfer. This is the final amount to take out of what is ultimately received by your customer, not a percentage.

It's denominated in the transfer's fiat currency (see top-level currency field for more info).

data.receipt.subtotal_amount

string

required

The initial amount of the transfer less fixed fees (including the developer_fee and exchange_fee). Examples include "100.25", "0.1", "1.234567", "1.01" etc.

It's denominated in the transfer's fiat currency (see top-level currency field for more info).

data.receipt.remaining_prefunded_balance

string

For Prefunded Accounts, this value will represent the remaining account balance after the transfer.

data.receipt.gas_fee

string

The fee, expressed as a decimal string. It's deducted from the withdrawn amount to pay for gas. Only nonzero to crypto withdrawals that cost gas (e.g. USDT or DAI), and only known when the transaction is confirmed on-chain. Will be missing if not yet known.

It's denominated in the fiat currency to which the destination currency is pegged.

data.receipt.final_amount

string

The final amount of the transfer, expressed as a decimal string, equal to the subtotal_amount minus any gas fees. If the gas fee is not known, this field will be missing. Examples include "100.25", "0.1", "1.234567", "1.01" etc.

It's denominated in the destination currency if that is a fiat currency or the fiat currency to which the destination currency is pegged.

data.receipt.source_tx_hash

any

The hash of the on-chain deposit to the source address, where applicable

data.receipt.destination_tx_hash

any

The hash of the on-chain transfer to the destination address, where applicable

data.receipt.exchange_rate

any

The effective exchange rate can be calculated by dividing the converted amount by the amount available for conversion after deducting the developer fee. This rate includes a currency conversion spread and is subject to a rounding precision loss during the calculation. Currently it's populated for SEPA onramp/offramp transfers only.

data.receipt.url

string

The URL of a user-facing copy of the receipt.

data.created_at

string<date-time>

required

Time of creation of the transfer

data.updated_at

string<date-time>

required

Time of update of the transfer

data.client_reference_id

string

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

Required string length: 1 - 256

data.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.

data.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.

Show child attributes

data.source_deposit_instructions.payment_rail

enum<string>

required

The payment rail that Bridge is expecting funds to arrive on. For a crypto based source on the transfer, this is the chain, i.e. ethereum or polygon The source payment rail

Available options:

ach,

wire,

ach_push,

ach_same_day,

arbitrum,

avalanche_c_chain,

base,

ethereum,

optimism,

polygon,

solana,

spei,

stellar

data.source_deposit_instructions.amount

string

required

Amount of the deposit, represented as a dollar denominated string. Examples include "100.25", "0.1", "1.234567", "1.01" etc. Amount of the deposit, expressed as a decimal string. It's denominated in the source currency if that is a fiat currency, or in the fiat currency to which the source currency is pegged. Examples include "100.25", "0.1", "1.234567", "1.01" etc.

data.source_deposit_instructions.currency

enum<string>

required

The source currency

Available options:

dai,

pyusd,

usd,

usdb,

usdc,

usdt

data.source_deposit_instructions.from_address

string

The crypto wallet address that the customer will send funds from, in order to kick off this transfer

data.source_deposit_instructions.to_address

string

The crypto wallet address the customer will send funds to in order to initiate the payment processing

data.source_deposit_instructions.deposit_message

string

The message that the customer MUST include in their wire memo/message or ach push description The message that the customer MUST include in their wire memo/message, ach push description, or sepa reference.

data.source_deposit_instructions.bank_name

string

The name of the bank that the customer should send the deposit to

data.source_deposit_instructions.bank_address

string

The address of the bank that the customer should send the deposit to. For SEPA, the country in this address should be used for sending the deposit

data.source_deposit_instructions.bank_routing_number

string

The routing number of the bank that the customer should send the deposit to

data.source_deposit_instructions.bank_account_number

string

The account number of the bank that the customer should send the deposit to

data.source_deposit_instructions.bank_beneficiary_name

string

The name of the beneficiary of the bank account that the customer should send the deposit to

data.source_deposit_instructions.bank_beneficiary_address

string

The address of the beneficiary of the bank account that the customer should send the deposit to

data.source_deposit_instructions.iban

string

For SEPA, the International Bank Account Number (IBAN) that the customer should use to send the deposit

data.source_deposit_instructions.bic

string

For SEPA, the Bank Identifier Code (BIC) that the customer should use to send the deposit

data.source_deposit_instructions.clabe

string

For SPEI, the CLABE (account number) that the customer should use to send the deposit

data.source_deposit_instructions.account_holder_name

string

For SEPA, the name of the bank account holder that the customer should use to send the deposit

data.source_deposit_instructions.blockchain_memo

string

If present, the message that the customer MUST include in their on chain transfer. Only used for memo-based blockchains such as Stellar and Tron

data.return_details

object

Return information, if the transfer has been returned.

Show child attributes

data.return_details.reason

string

The reason for the return, as given by the returning financial institution.

data.return_details.refund_reference_id

string

A unique identifier (such as transaction hash) for the refund transaction.

Endpoints

Authorizations

Path Parameters

Query Parameters

Response