{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bridge API Keys Virtual Accounts API",
    "version": "1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Api-Key",
      "value": "{{Api-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Virtual Accounts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Virtual Accounts by Customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/virtual_accounts",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "status",
                "value": "activated",
                "type": "query",
                "description": "Limit results to those with the given activation status"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "This is a virtual account id. If this is specified, the next page that starts with a virtual account right AFTER the specified virtual account id on the virtual account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that virtual account older than the specified virtual account id will be returned (shouldn't be set if ending_before is set)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "This is a virtual account id. If this is specified, the previous page that ends with a virtual account right BEFORE the specified virtual account id on the virtual account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that virtual account newer than the specified virtual account id will be returned (shouldn't be set if starting_after is set)"
              }
            ]
          },
          "docs": "List all Virtual Account objects for a customer"
        },
        {
          "info": {
            "name": "Create a Virtual Account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/virtual_accounts",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Virtual Account or Virtual IBAN for the specified customer"
        },
        {
          "info": {
            "name": "Get a Virtual Account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/virtual_accounts/:virtualAccountID",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "virtualAccountID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the Virtual Account object from the passed ID"
        },
        {
          "info": {
            "name": "Update a Virtual Account",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/virtual_accounts/:virtualAccountID",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "virtualAccountID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update instructions for an existing Virtual Account"
        },
        {
          "info": {
            "name": "Deactivate a Virtual Account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/virtual_accounts/:virtualAccountID/deactivate",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "virtualAccountID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deactivate a Virtual Account to prevent it from acceping new incoming transactions"
        },
        {
          "info": {
            "name": "Reactivate a Virtual Account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/virtual_accounts/:virtualAccountID/reactivate",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "virtualAccountID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Reactivate a previously deactivated Virtual Account"
        },
        {
          "info": {
            "name": "Virtual Account Activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/virtual_accounts/:virtualAccountID/history",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "virtualAccountID",
                "value": "",
                "type": "path"
              },
              {
                "name": "deposit_id",
                "value": "",
                "type": "query",
                "description": "The deposit id associated with the events. Cannot be passed if deposit_ids is also passed"
              },
              {
                "name": "deposit_ids",
                "value": "",
                "type": "query",
                "description": "The deposit ids associated with the events. Pass a list of deposit ids like \"deposit_ids[]=id1&deposit_ids[]=id2\". Cannot be passed if deposit_id is also passed"
              },
              {
                "name": "tx_hash",
                "value": "",
                "type": "query",
                "description": "The hash of the transaction"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "This is an event id. If this is specified, the next page that starts with an event right AFTER the specified event id on the event timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that events older than the specified event id will be returned (shouldn't be set if ending_before is set)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "This is an event id. If this is specified, the previous page that ends with an event right BEFORE the specified event id on the event timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that events newer than the specified event id will be returned (shouldn't be set if starting_after is set)"
              },
              {
                "name": "event_type",
                "value": "",
                "type": "query",
                "description": "Filter history by event type"
              }
            ]
          },
          "docs": "History of activity for a Virtual Account"
        },
        {
          "info": {
            "name": "List Virtual Accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/virtual_accounts",
            "params": [
              {
                "name": "status",
                "value": "activated",
                "type": "query",
                "description": "Limit results to those with the given activation status"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "This is a virtual account id. If this is specified, the next page that starts with a virtual account right AFTER the specified virtual account id on the virtual account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that virtual account older than the specified virtual account id will be returned (shouldn't be set if ending_before is set)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "This is a virtual account id. If this is specified, the previous page that ends with a virtual account right BEFORE the specified virtual account id on the virtual account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that virtual account newer than the specified virtual account id will be returned (shouldn't be set if starting_after is set)"
              }
            ]
          },
          "docs": "List all Virtual Account objects"
        },
        {
          "info": {
            "name": "Virtual Account Activity Across All Customers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/virtual_accounts/history",
            "params": [
              {
                "name": "deposit_id",
                "value": "",
                "type": "query",
                "description": "The deposit id associated with the events. Cannot be passed if deposit_ids is also passed"
              },
              {
                "name": "deposit_ids",
                "value": "",
                "type": "query",
                "description": "The deposit ids associated with the events. Pass a list of deposit ids like \"deposit_ids[]=id1&deposit_ids[]=id2\". Cannot be passed if deposit_id is also passed"
              },
              {
                "name": "tx_hash",
                "value": "",
                "type": "query",
                "description": "The hash of the transaction"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "This is an event id. If this is specified, the next page that starts with an event right AFTER the specified event id on the event timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that events older than the specified event id will be returned (shouldn't be set if ending_before is set)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "This is an event id. If this is specified, the previous page that ends with an event right BEFORE the specified event id on the event timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that events newer than the specified event id will be returned (shouldn't be set if starting_after is set)"
              },
              {
                "name": "event_type",
                "value": "",
                "type": "query",
                "description": "Filter history by event type"
              },
              {
                "name": "updated_after_ms",
                "value": "",
                "type": "query",
                "description": "This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned"
              },
              {
                "name": "updated_before_ms",
                "value": "",
                "type": "query",
                "description": "This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned"
              }
            ]
          },
          "docs": "History of activity across all customers and Virtual Accounts"
        }
      ]
    }
  ],
  "bundled": true
}