Company payment accounts

Start a Stripe checkout for a company payment account

Opens a Stripe checkout session so the payer can enter card or bank details at Stripe rather than sending them here. Embed the returned client secret in Stripe's checkout component, then pass the session id to the add-payment-account endpoint once the payer has finished.

POST

https://api.portal.magicdoor.com/company-app/payment-accounts/checkout

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.

Response

200 · The checkout session.

sessionIdstring

The Stripe checkout session. Pass it back as stripeSessionId when adding the payment account. An opaque Stripe token — do not parse it.

clientSecretstring

The secret Stripe's embedded checkout component needs. Treat it as a secret and do not parse it.

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

Request

curl --request POST \
  --url 'https://api.portal.magicdoor.com/company-app/payment-accounts/checkout' \
  --header 'Authorization: Bearer <token>'

Response

{
  "sessionId": "cs_test_opaque_stripe_session",
  "clientSecret": "cs_test_opaque_stripe_session_secret"
}