Payment methods

Deactivate a payment method for an entity

Takes a payment method belonging to a named tenant, owner, vendor, applicant, or the company itself out of use without removing it. The method stays on file with its deactivated timestamp and the reason you give. A method that is already deactivated is returned unchanged. Requires the payment_methods:write permission.

POST

https://services.magicdoor.com/payments/company-portal/methods/{entityType}/{entityId}/{methodId}/deactivate

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

methodIdstringrequired

The payment method to deactivate. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Body

application/json

Why the method is being taken out of use.

reasonstringrequired

The reason, 1 to 500 characters. It is stored and returned as deactivationReason.

Response

200 · The payment method after being deactivated.

idstringrequired

The payment method. Send this value wherever a methodId is asked for. A Snowflake id, sent as a decimal string.

typeenum<string>required

What kind of funding source this is. ach is a US bank account reached by Automated Clearing House transfer.

cardachdigitalWallet

brandstring

The card network or bank brand the processor reported, for example "Visa". Absent when the processor reported none.

holderstring

The name on the card or bank account, as the processor reported it. Absent when the processor reported none.

last4string

The last four digits of the card or account number. The full number is never returned. Absent when the processor reported none.

expiresobject

The card expiry, month and year only. Absent for bank accounts, and for cards whose expiry the processor did not report.

cardTypeenum<string>

Whether the card draws on a bank balance or a credit line. Absent for bank accounts, and when the processor did not report it.

debitcredit

accountTypeenum<string>

The kind of bank account. Absent for cards, and when the processor did not report it.

checkingsavings

descriptionstring

The free-text label supplied when the method was added. Absent when none was given.

deactivatedstring · date-time

When the method was deactivated, in the company's timezone and without an offset. Absent while the method is usable.

isDeactivatedbooleanrequired

True when deactivated is present. A deactivated method stays on file but cannot be charged.

deactivationReasonstring

The reason given when the method was deactivated. Absent while the method is usable.

createdstring · date-timerequired

When the method was added, in the company's timezone and without an offset.

capabilitiesenum<string>[]required

What the method may be used for. collect takes money in, payout sends money out. Bank accounts normally get both; cards get collect only. The array is empty when the method has no capability with the processor MagicDoor currently runs.

collectpayout

400 · `reason` is missing, empty, or longer than 500 characters.

401 · The request carried no valid access token.

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

404 · No such payment method, or it belongs to another company, or it was deleted, or it belongs to a different party than the one named in the path.

422 · The path names your own company and this is its last usable payment method, so it cannot be deactivated.

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.

The company must keep one usable method

This guard applies only when entityType is company and entityId is your own company: MagicDoor collects the company's own fees from those methods, so the last usable one cannot be deactivated, and the call refuses with 422. Methods belonging to tenants, owners, vendors, and applicants are not protected.