Sign in
External Accounts

List platform external accounts

Retrieve a list of all external accounts that belong to the platform, as opposed to an individual customer.

These accounts are used for platform-wide operations such as receiving funds from external sources or managing platform-level payment destinations.

get/platform/external-accounts

Query parameters

currencystring

Filter by currency code

Response

Successful operation

Example response

{
  "data": [
    {
      "id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
      "customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
      "platformAccountId": "acc_123456789",
      "currency": "USD",
      "accountInfo": {
        "accountType": "US_ACCOUNT",
        "accountNumber": "123456789",
        "routingNumber": "987654321",
        "accountCategory": "CHECKING",
        "bankName": "Chase Bank",
        "beneficiary": {
          "beneficiaryType": "INDIVIDUAL",
          "address": {
            "line1": "123 Main Street",
            "line2": "Apt 4B",
            "city": "San Francisco",
            "state": "CA",
            "postalCode": "94105",
            "country": "US"
          },
          "fullName": "John Michael Doe",
          "birthDate": "1990-01-15",
          "nationality": "US"
        }
      }
    }
  ]
}

Changes