MagicDoorAPI
SupportOpen MagicDoor
Payment methods

List payment methods

Returns a page of the company's own payment methods, newest first — the cards and bank accounts the company pays MagicDoor with. Methods belonging to tenants, owners, vendors, and applicants are not included; list those with List payment methods for an entity. Each method's capabilities are limited to the payment processor MagicDoor currently runs. Requires the payment_methods:read permission.

GET
https://services.magicdoor.com/payments/company-portal/methods

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.

Query parameters

pageinteger

Which page to return. The first page is 1.

default: 1
pageSizeinteger

How many items to return per page. Between 1 and 100.

default: 50
idsstring[]

Return only these payment methods. Repeat the parameter once per id.

typesenum<string>[]

Return only methods of these kinds. Repeat the parameter once per value.

cardachdigitalWallet
deactivatedboolean

true returns only deactivated methods, false only usable ones. Omit to get both.

created.startstring · date-time

Only methods added at or after this moment, read in the company's timezone and written without an offset.

created.endstring · date-time

Only methods added at or before this moment, read in the company's timezone and written without an offset.

created.startInclusiveboolean

Set to false to exclude methods added exactly at created.start.

default: true
created.endInclusiveboolean

Set to false to exclude methods added exactly at created.end.

default: true

Response

200 · A page of the company's own payment methods. Deleted methods are never returned.

itemsPaymentMethod[]required

This page of results, newest first.

totalCountintegerrequired

How many items match the filter across every page.

totalPagesintegerrequired

How many pages the result set has at this page size.

pageintegerrequired

The page that was returned.

pageSizeintegerrequired

How many items were asked for per page.

401 · The request carried no valid access token.

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