BRbridge
RFIs

Get an RFI

Changed on

Retrieve a single request for information (RFI) by id

get/rfis/{rfiID}

Request

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

Response

Successful RFI response

idstring required

A UUID that uniquely identifies a resource

state'on_developer' | 'on_bridge' | 'closed' required

The current state of the RFI: on_developer means Bridge is waiting on a response from you, on_bridge means Bridge is reviewing a response you submitted, closed means no further action is needed

customer_idstring

A UUID that uniquely identifies a resource

referent_idstring nullable

The id of the record (transfer, drain, deposit, card account, or customer) this RFI relates to, if any. Resolve it against the endpoint named by referent_type

referent_type'transfer' | 'drain' | 'deposit' | 'card_account' | 'customer' nullable

The type of record that referent_id refers to

bridge_action_taken'customer_paused' | 'transaction_paused' nullable

An action Bridge has already taken as a result of this RFI, if any

expected_action_on_expiry'pause_customer' nullable

The action Bridge expects to take if this RFI expires without a response, if any

deadlinestring date-time required

The time by which a response to this RFI is expected

additional_contextstring nullable

Additional free-text detail about the request, when Bridge has provided it. Not every RFI includes this field

dashboard_urlstring required

A link to view and respond to this RFI in the Bridge dashboard

state_changed_atstring date-time nullable

The time the RFI's state last changed

created_atstring date-time required

The time the RFI was created

closed_atstring date-time nullable

The time the RFI was closed, if it has been

Changes