Get the application fee breakdown

Works out what an applicant would be charged for the calling company today, how much of that is card processing, what TransUnion costs the company, and what is left over. Company-wide — it takes no application id. Requires the rental_applications: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.

Response

200 · The fee breakdown. Every figure is a decimal amount.

applicationFeenumber

The fee the company charges an applicant, before processing costs.

processingFeesnumber

The card processor's cut on that amount. Whether the applicant or the company absorbs this is decided by propertyManagerPaysProcessingFees.

totalAmountnumber

What the applicant is actually charged, processing included where the applicant pays it.

transUnionCostnumber

What the company pays TransUnion for a credit report on this applicant.

netAmountnumber

What the company keeps once processing costs and the TransUnion credit-report cost are taken off. Can be negative.

propertyManagerPaysProcessingFeesboolean

true when the company absorbs the processing cost, false when it is added to what the applicant pays.

401 · The access token is missing, expired, or not valid.

403 · The caller is authenticated but does not hold the `rental_applications:read` permission.

All zeroes means the company does not charge

When the company has application-fee collection turned off, every amount comes back as 0 and only propertyManagerPaysProcessingFees carries a real value.