{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bridge API Keys External Accounts API",
    "version": "1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Api-Key",
      "value": "{{Api-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "External Accounts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all External Accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/external_accounts",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "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 external account id. If this is specified, the next page that starts with an external account right AFTER the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts older than the specified external account id will be returned (shouldn't be set if ending_before is set)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "This is an external account id. If this is specified, the previous page that ends with an external account right BEFORE the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts newer than the specified external account id will be returned (shouldn't be set if starting_after is set)"
              }
            ]
          },
          "docs": "Get all External Accounts for a passed in customer."
        },
        {
          "info": {
            "name": "Create a new External Account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/external_accounts",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "_Note_: If adding US external accounts, we recommend reading through the US Beneficiary Address Validation doc ([link](https://apidocs.bridge.xyz/docs/us-beneficiary-address-validation)) to avoid issues related to incorrect addresses.\n"
        },
        {
          "info": {
            "name": "Retrieve an External Account object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/external_accounts/:externalAccountID",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "externalAccountID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve an External Account object (banks, debit cards etc) from the passed in customer ID and External Account ID"
        },
        {
          "info": {
            "name": "Update an External Account",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/external_accounts/:externalAccountID",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "externalAccountID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an External Account"
        },
        {
          "info": {
            "name": "Delete a single External Account object",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/external_accounts/:externalAccountID",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "externalAccountID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete an External Account object from the passed in External Account ID"
        },
        {
          "info": {
            "name": "Deactivate an External Account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/external_accounts/:externalAccountID/deactivate",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "externalAccountID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deactivate an active External Account. The External Account is preserved and can be reactivated later via the reactivate endpoint."
        },
        {
          "info": {
            "name": "Verify an External Account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/external_accounts/:externalAccountID/verify",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "externalAccountID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Trigger a verification check for an external account. Verifies that the `account_owner_name` matches the actual account holder at the receiving bank.\n\nSupported for `iban` (EUR) and `gb` (GBP) account types only. Does not require an Idempotency-Key header.\n\nAfter triggering, poll the external account's `account_verification` field until `completed_at` is populated.\n"
        },
        {
          "info": {
            "name": "Reactivate an External Account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/external_accounts/:externalAccountID/reactivate",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "externalAccountID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Reactivate a previously deactivated External Account"
        },
        {
          "info": {
            "name": "Get all External Accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/external_accounts",
            "params": [
              {
                "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 external account id. If this is specified, the next page that starts with an external account right AFTER the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts older than the specified external account id will be returned (shouldn't be set if ending_before is set)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "This is an external account id. If this is specified, the previous page that ends with an external account right BEFORE the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts newer than the specified external account id will be returned (shouldn't be set if starting_after is set)"
              }
            ]
          },
          "docs": "Get all External Accounts."
        }
      ]
    }
  ],
  "bundled": true
}