GET
/
transfers
/
static_templates
Get all static templates
curl --request GET \
  --url https://api.bridge.xyz/v0/transfers/static_templates \
  --header 'Api-Key: <api-key>'
{
  "count": 2,
  "data": [
    {
      "summary": "A successful offramp transfer object",
      "value": {
        "id": "transfer_456",
        "client_reference_id": "client_transfer_id_456",
        "state": "funds_received",
        "on_behalf_of": "cust_123",
        "amount": "500.25",
        "developer_fee": "0.0",
        "source": {
          "payment_rail": "ach",
          "currency": "usd",
          "external_account_id": "ext_123"
        },
        "destination": {
          "payment_rail": "ethereum",
          "currency": "usdc",
          "to_address": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
        },
        "receipt": {
          "initial_amount": "500.25",
          "developer_fee": "0.0",
          "exchange_fee": "0.0",
          "subtotal_amount": "500.25",
          "gas_fee": "0.0",
          "final_amount": "500.25",
          "destination_tx_hash": "0xdeadbeef",
          "url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"
        },
        "created_at": "2020-01-02T00:00:00.000Z",
        "updated_at": "2020-01-03T00:00:00.000Z"
      }
    },
    {
      "summary": "A successful offramp transfer object",
      "value": {
        "id": "transfer_123",
        "client_reference_id": "client_transfer_id_123",
        "state": "awaiting_funds",
        "on_behalf_of": "cust_123",
        "amount": "75.0",
        "developer_fee": "0.0",
        "source": {
          "payment_rail": "ethereum",
          "currency": "usdc",
          "from_address": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
        },
        "destination": {
          "payment_rail": "ach",
          "currency": "usd",
          "external_account_id": "ext_123"
        },
        "source_deposit_instructions": {
          "payment_rail": "ethereum",
          "amount": "75.0",
          "currency": "usdc",
          "from_address": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
          "to_address": "0xb794f5ea0ba39494ce839613fffba74279579268"
        },
        "receipt": {
          "initial_amount": "75.0",
          "developer_fee": "0.0",
          "exchange_fee": "0.0",
          "subtotal_amount": "75.0",
          "gas_fe": "0.0",
          "final_amount": "75.0",
          "url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"
        },
        "created_at": "2020-01-01T00:00:00.000Z",
        "updated_at": "2020-01-02T00: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 transfer id. If this is specified, the next page that starts with a transfer right AFTER the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers older than the specified transfer id will be returned (shouldn't be set if ending_before is set)

​
ending_before
string

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

Response

200
application/json

List of static templates (the returned list is empty if none found). Static templates are transfers that are used as templates for other transfers and can be created using the static_templates feature flag.

The response is of type object.