BRbridge
Liquidation Addresses

Update a Liquidation Address

Changed on

Update a Liquidation Address for the specified liquidation address ID. Fields (external_account_id, custom_developer_fee_percent, destination) can be updated independently and are not all required.

put/customers/{customerID}/liquidation_addresses/{liquidationAddressID}

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID}
  • Auth
    API key in header Api-Key

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

liquidationAddressIDstring required

A UUID that uniquely identifies a resource

Request body

external_account_idstring

An optional identifier for the external account you wish to associate with this liquidation schedule.

Note: Only one liquidation address can be associated with an external account per (customer, chain, currency).

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_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_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_swift_referencestring

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

destination_referencestring nullable

A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow). Send null to clear an existing reference.

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.

currency'usdb' | 'usdc' | 'usdt' | 'usdl_linea' | 'pyusd' | 'eurc' | 'all_supported'
chain'arbitrum' | 'avalanche_c_chain' | 'base' | 'celo' | 'ethereum' | 'linea' | 'optimism' | 'polygon' | 'solana' | 'stellar' | 'tempo' | 'tron' | 'xdc' | 'evm'

Example request

{
  "custom_developer_fee_percent": "0.1"
}

Response

Updated Liquidation Address object

idstring required

A UUID that uniquely identifies a resource

currency'usdb' | 'usdc' | 'usdt' | 'usdl_linea' | 'pyusd' | 'eurc' | 'all_supported' required
chain'arbitrum' | 'avalanche_c_chain' | 'base' | 'celo' | 'ethereum' | 'linea' | 'optimism' | 'polygon' | 'solana' | 'stellar' | 'tempo' | 'tron' | 'xdc' | 'evm' required
supported_currenciesobject

The currencies this Liquidation Address accepts on each chain. Keys are LiquidationAddressSourceChain values (e.g. ethereum, polygon, base). For a single-chain, single-currency address this is just that one chain and currency; for a multi-chain (chain is evm) or multi-currency (currency is all_supported) address it lists every currency actually accepted on each chain.

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_swift_referencestring

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

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' | 'linea' | 'optimism' | 'pix' | 'polygon' | 'sepa' | 'solana' | 'spei' | 'stellar' | 'swift' | 'tempo' | 'tron' | 'xdc' required
destination_currency'brl' | 'cop' | 'eur' | 'eurc' | 'gbp' | 'mxn' | 'ousd' | 'path_usd' | 'pyusd' | 'usd' | 'usdb' | 'usdc' | 'usdt' | 'usdl_linea' 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

{
  "supported_currencies": {
    "ethereum": [
      "usdc",
      "eurc"
    ],
    "polygon": [
      "usdc"
    ]
  },
  "custom_developer_fee_percent": "0.1",
  "global_developer_fee_percent": {
    "percent": "0.2"
  }
}

Changes

  • a390532e9fc6Revision changes
    • warning

      added the new all_supported enum value to the response property for the response status

    • warning

      added the new linea enum value to the response property for the response status

    • warning

      added the new linea enum value to the response property for the response status

    • warning

      added the new ousd enum value to the response property for the response status

    • warning

      added the new path_usd enum value to the response property for the response status

    • warning

      added the new usdl_linea enum value to the response property for the response status

    • warning

      added the new usdl_linea enum value to the response property for the response status

    • warning

      added the new xdc enum value to the response property for the response status

    • warning

      added the new xdc enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status