Sign in

v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Transfers

Get a transfer

Retrieve a transfer object from the passed in transfer ID

get/transfers/{transferID}

Response

Successful transfer object response

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