Sign in

v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Liquidation Addresses

Get a Liquidation Address

Retrieve a Liquidation Address for the specified Liquidation Address ID

get/customers/{customerID}/liquidation_addresses/{liquidationAddressID}

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

liquidationAddressIDstring required

A UUID that uniquely identifies a resource

Response

A Liquidation Address object response

idstring required

A UUID that uniquely identifies a resource

currency'usdb' | 'usdc' | 'usdt' | 'pyusd' | 'eurc' required
chain'arbitrum' | 'avalanche_c_chain' | 'base' | 'celo' | 'ethereum' | 'optimism' | 'polygon' | 'solana' | 'stellar' | 'tempo' | 'tron' | 'evm' required
customer_idstring required

A UUID that uniquely identifies a resource

external_account_idstring required

A UUID that uniquely identifies a resource

prefunded_account_idstring

A UUID that uniquely identifies a resource

custom_developer_fee_percentstring number nullable

The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.

destination_wire_messagestring

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.

destination_sepa_referencestring

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}".

destination_spei_referencestring

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

destination_ach_referencestring

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.

destination_payment_rail'ach' | 'wire' | 'ach_push' | 'ach_same_day' | 'arbitrum' | 'avalanche_c_chain' | 'base' | 'bre_b' | 'co_bank_transfer' | 'celo' | 'ethereum' | 'faster_payments' | 'fiat_deposit_return' | 'optimism' | 'pix' | 'polygon' | 'sepa' | 'solana' | 'spei' | 'stellar' | 'swift' | 'tempo' | 'tron' required
destination_currency'brl' | 'cop' | 'eur' | 'eurc' | 'gbp' | 'mxn' | 'pyusd' | 'usd' | 'usdb' | 'usdc' | 'usdt' required
addressstring required

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

memoless_addressstring

An alternative crypto wallet address that encodes the memo, allowing the customer to send funds without needing to include a separate memo. Currently only available for Stellar deposits.

blockchain_memostring

The memo that must be included with the deposit transaction when sending funds to the deposit address. Only present for blockchains that require memos (such as Stellar).

destination_addressstring

The crypto wallet address that Bridge will use to send funds to the customer.

destination_blockchain_memostring

The memo to include in the transaction, for blockchains that support memos only

return_addressstring nullable

Deprecated: use return_instructions instead.

The crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction. Must be on the same chain as the liquidation address. Cannot be used on Stellar — use return_instructions with a memo instead.

return_memostring nullable

The memo included with return transactions. Present when return_instructions was set with a memo (e.g. required for Stellar to route funds to the correct end-customer).

statestring

The state of the liquidation address. It could be "active" or "deactivated"

created_atstring date-time required

Time of creation of the Liquidation Address

updated_atstring date-time required

Time of last update of the Liquidation Address

Example response

{
  "custom_developer_fee_percent": "0.1",
  "global_developer_fee_percent": {
    "percent": "0.2"
  }
}