Skip to main content
POST
Charge a reservation deposit for a lead

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

leadUuid
string
required
portfolio
string
required

Response

201 - application/json

Result of the deposit charge attempt

leadUuid
string<uuid>
required
leadStatus
string
required

DEPOSIT_RESERVED on a successful charge, RESERVED on decline

unitUuid
string<uuid> | null
required

The unit assigned and held, only present on a successful charge

depositAmountInPennies
number | null
required

The deposit amount charged, in pennies

declined
boolean
required

True when the gateway declined the charge

errorMessage
string | null
required