Payment methods

List payment methods for an entity

Returns a page of the payment methods belonging to one tenant, owner, vendor, applicant, or the company itself, newest first. 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/{entityType}/{entityId}

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

entityTypeenum<string>required

Who owns the payment method. company is the property management company itself, applicant is a rental applicant. Matching is case-insensitive.

example: tenantapplicanttenantownervendorcompany

entityIdstringrequired

The tenant, owner, vendor, applicant, or company that owns the payment method. A Snowflake id, sent as a decimal string.

example: 1812345678901234560

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 that party's payment methods. Deleted methods are never returned. An entity with none — including one that does not exist — gives an empty page rather than a 404.

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.

Which methods this reaches

entityType and entityId name the party the payment method belongs to — a tenant, an owner, a vendor, a rental applicant, or the company itself. Whatever you name, the method must still belong to the calling company; one company can never reach another's. Passing company with your own company id reaches exactly the same methods as the endpoints without an entity in the path.