Skip to main content
POST
Charge a rental record's current balance to a saved payment profile

Headers

x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid
string
required
unitRentalRecordUuid
string
required
portfolio
string
required

Body

application/json
paymentProfileUuid
string<uuid>
required

Stored payment profile (saved card / ACH) to charge. Must belong to the rental record account and not be archived.

expectedAmountInPennies
integer

Optional stale-balance guard, in cents. When provided, it must equal the rental record's current outstanding balance computed server-side at charge time; otherwise the request is rejected with 409 and nothing is charged. It never sets the charged amount — the server always charges the full current balance.

Required range: x >= 1

Response

Payment charged successfully

paymentUuid
string<uuid> | null
required

UUID of the payment recorded in Monument for this charge.

status
enum<string>
required

Final status of the payment (COMPLETED on a successful charge).

Available options:
READY,
PROCESSING,
COMPLETED,
REFUNDED,
FAILURE,
REVERSED,
VOIDED,
RECONCILIATION_FAILED,
CHARGEBACK,
PARTIALLY_REFUNDED
amountChargedInPennies
integer
required

Total amount charged to the card/account, in cents, including any credit-card surcharge added by the processor.

lastFour
string | null
required

Last four digits of the charged card/account, when available.

paymentType
enum<string>
required
Available options:
CREDIT/DEBIT,
ACH