Get a connected account

Fetches one connected account, including every document held against it and, when MagicDoor denied the request, the reason. Requires the connected_accounts:read permission.

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

connectedAccountIdstringrequired

The connected account to fetch. A Snowflake id, sent as a decimal string.

example: 1841002938475610112

Response

200 · The connected account.

idstringrequired

The connected account. Send this value wherever a connectedAccountId is asked for. A Snowflake id, sent as a decimal string.

companyIdstringrequired

The company that owns the connected account. Always the calling company.

bankAccountIdstringrequired

The company bank account, held in the Accounting service, that this connected account settles to.

statusenum<string>required

Where the account stands. requested means MagicDoor has the request and has not boarded it yet, pending that boarding started but nothing was submitted, underReview that the processor is reviewing it, approved that the processor said yes but the account is not live, activated that it can process payments, rejected and suspended that the processor turned it down or stopped it, exception that it needs attention, and denied that MagicDoor turned it down.

requestedpendingunderReviewapprovedactivatedrejectedsuspendedexceptiondenied

companyBusinessInfoIdstringrequired

The company business information record submitted with the request.

documentsobject[]required

The files held against the account. The signed agreement acceptance is added by MagicDoor and is always among them; the rest are the ones sent with the request.

denyReasonstring

Why MagicDoor denied the request. Present only while status is denied.

401 · The request carried no valid access token.

403 · The token is not a property manager token, or it lacks the `connected_accounts:read` permission.

404 · No such connected account, or it belongs to another company, or it was deleted, or it is held with a payment processor other than the one MagicDoor currently runs.