Bank accounts (Portal)

Get connection options for a bank account

Reports, for both payment providers MagicDoor supports, whether this bank account may be connected to them, how far any existing connection has got, the balance the provider is holding, and — for Plaid — the transfer limits that apply.

GET

https://api.portal.magicdoor.com/company-app/bank-accounts/{bankAccountId}/connections

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

bankAccountIdstringrequired

The bank account to report on. A Snowflake id sent as a decimal string.

example: 1801556677120004096

Response

200 · The Plaid and Stripe connection state for the account.

plaidobject

The Plaid connection.

stripeobject

The Stripe connection. Same shape as plaid without limits.

401 · The access token is missing, expired, or does not belong to a property manager.

404 · No bank account with that id exists for the caller's company. One belonging to another company reads the same way.

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/bank-accounts/1801556677120004096/connections' \
  --header 'Authorization: Bearer <token>'

Response

{
  "plaid": {
    "eligible": true,
    "status": "approved",
    "balance": {
      "available": 24310.55,
      "pending": 1200
    },
    "externalAccountId": "plaid_acc_7d31c9",
    "limits": {
      "isoCurrencyCode": "USD",
      "maxSingleTransferCreditAmount": 25000,
      "maxSingleTransferDebitAmount": 25000,
      "maxDailyCreditAmount": 50000,
      "maxDailyDebitAmount": 50000
    }
  },
  "stripe": {
    "eligible": false,
    "notEligibleReason": "A Plaid connection is already approved for this account"
  }
}