Skip to main content
GET
/
funds_requests
Get all funds requests
curl --request GET \
  --url https://api.bridge.xyz/v0/funds_requests \
  --header 'Api-Key: <api-key>'
{
  "count": 3,
  "data": [
    {
      "summary": "A successful wire funds request",
      "value": {
        "id": "fr_123",
        "deposit_id": "dep_123",
        "customer_id": "cust_123",
        "amount": "120.0",
        "currency": "usd",
        "payment_rail": "wire",
        "fraud": true,
        "notice_date": "2020-02-01",
        "imad": "123456",
        "created_at": "2020-02-01T00:00:00.000Z",
        "deposit_created-at": "2020-01-01T00:00:00.000Z"
      }
    },
    {
      "summary": "A successful ACH funds request",
      "value": {
        "id": "fr_123",
        "deposit_id": "dep_123",
        "customer_id": "cust_123",
        "amount": "120.0",
        "currency": "usd",
        "payment_rail": "ach_push",
        "fraud": true,
        "notice_date": "2020-02-01",
        "trace_number": "123456",
        "created_at": "2020-02-01T00:00:00.000Z",
        "deposit_created-at": "2020-01-01T00:00:00.000Z"
      }
    },
    {
      "summary": "A successful SEPA funds request",
      "value": {
        "id": "fr_123",
        "deposit_id": "dep_123",
        "customer_id": "cust_123",
        "amount": "120.0",
        "currency": "eur",
        "payment_rail": "sepa",
        "fraud": true,
        "notice_date": "2020-02-01",
        "bank_transaction_number": "123456",
        "created_at": "2020-02-01T00:00:00.000Z",
        "deposit_created-at": "2020-01-01T00:00:00.000Z"
      }
    }
  ]
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
limit
integer

The number of items to return (default of 10, max of 100)

​
starting_after
string

This is a funds request id. If this is specified, the next page that starts with a funds request right AFTER the specified id on the timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that funds request older than the specified funds request id will be returned (shouldn't be set if ending_before is set)

​
ending_before
string

This is a funds request id. If this is specified, the previous page that ends with a funds request right BEFORE the specified id on the timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that funds request newer than the specified funds request id will be returned (shouldn't be set if starting_after is set)

​
customer_id
string

If specified, results will be filtered to the given customer_id only

​
fraud
boolean

If this is specified as either "true" or "false", then only fraudulent or non-fraudulent entries will be returned, respectively

​
notice_date_starting_on
string

A date in the format YYYY-MM-DD. If specified, then only entries with a notice date on or after the provided date, inclusive, will be returned

​
notice_date_ending_on
string

A date in the format YYYY-MM-DD. If specified, then only entries with a notice date on or before the provided date, inclusive, will be returned

Response

200 - application/json

List of funds requests

​
count
integer
required

The number of items returned

​
data
object[]
required