BRbridge
Transfers

Update a transfer

Changed on

Update a transfer that was previously created. Must be in the awaiting_funds state, except that return_instructions can still be updated after funds are received until the transfer begins processing.

put/transfers/{transferID}

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/transfers/{transferID}
  • Auth
    API key in header Api-Key

Request body

amountstring

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.

developer_feestring

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.

developer_fee_percentstring

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.

Response

Transfer object created

idstring required

A UUID that uniquely identifies a resource

client_reference_idstring

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

amountstring 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'usd' | 'eur' | 'mxn' | 'brl' | 'cop' | 'gbp' required
on_behalf_ofstring required

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

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

developer_fee_percentstring

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.

state'awaiting_funds' | 'in_review' | 'funds_received' | 'payment_submitted' | 'payment_processed' | 'canceled' | 'undeliverable' | 'returned' | 'refund_in_flight' | 'refund_failed' | 'refunded' required
created_atstring date-time required

Time of creation of the transfer

updated_atstring date-time required

Time of update of the transfer

template_idstring

A UUID that uniquely identifies a resource

first_confirmed_atstring date-time

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.

Example response

{
  "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": {
    "risk_rejection_reason": "Exceeds Transaction Limits"
  }
}

Changes

  • a390532e9fc6Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      added to the response property oneOf list for the response status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      added the new fednow 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 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 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 ousd 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 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 path_usd 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 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 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

    • 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

    • warning

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      the response optional property / became read-only for the status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status