> ## Documentation Index > Fetch the complete documentation index at: https://api.monument.io/llms.txt > Use this file to discover all available pages before exploring further. # Get facility payments by UUIDs > Retrieves payment details for the provided array of UUIDs within a specific facility, most recently updated first. ## OpenAPI ````yaml /openapi/integration-openapi.json post /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids openapi: 3.0.0 info: title: Monument Integration API description: Monument Integration API version: '1.0' contact: {} servers: - url: https://public-api.prd.monument.io description: Production - url: https://public-api.stg.monument.io description: Staging security: [] tags: - name: Portfolios description: List portfolios accessible to the API key - name: Facilities description: Facility retrieval and coverage-option configuration - name: Units description: Unit listing and MORA execution - name: Unit Groups description: Unit group listing, rate management, and unit assignment - name: Rental Records description: Rental record listing, coverage, fees, autopay, and payment links - name: Ledger Entries description: Ledger entry retrieval at facility and rental-record level - name: Rent Changes description: >- Applied rent-change history per tenancy, with the rent that preceded each period - name: Leads description: Lead listing and lease sending - name: Tasks description: Task creation and listing for integrations - name: Tenants description: Tenant listing and person updates - name: People description: Person listing - name: Notes description: Note listing and creation for tenants and leads - name: Auctions description: Auction listing - name: Coverage description: Portfolio-level coverage CRUD and coverage history - name: Summary description: Portfolio-level aggregate summaries (insurance enrollment/occupancy) - name: Promotions description: Promotion listing - name: ECRI description: Effective Current Rent Increase scheduling - name: Item Types description: Item type listing per facility - name: GL Accounts description: Chart of accounts listing per facility - name: Journal Entries description: GL journal entry feed per facility, line by line - name: Delinquencies description: Delinquency listing per facility - name: Physical Locks description: Physical lock assignment and unassignment - name: Lead Source Options description: Lead source option listing - name: Webhooks description: Webhook subscription management - name: Payments description: >- Payment, credit and refund rows per facility, and payment profile creation and removal paths: /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids: post: tags: - Payments summary: Get facility payments by UUIDs description: >- Retrieves payment details for the provided array of UUIDs within a specific facility, most recently updated first. operationId: PrivateApiPaymentsController_getFacilityPaymentsByUuids parameters: - name: facilityUuid required: true in: path schema: type: string - in: path required: true name: portfolio schema: example: abc_selfstorage - in: header required: true name: x-api-key schema: example: monument-2230012-2312321 description: >- Api key required to authenticate your request. Please reach out to monument for a key. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetPaymentsByUuidsRequestDto' responses: '200': description: Payment details retrieved successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/PaymentDetailsResponseDto' '400': description: Bad Request (e.g., Too many uuids, invalid input) components: schemas: GetPaymentsByUuidsRequestDto: type: object properties: paymentUuids: example: - 8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b - 1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8 description: Array of payment UUIDs to retrieve data for type: array items: type: string format: uuid required: - paymentUuids PaymentDetailsResponseDto: type: object properties: paymentUuid: type: string format: uuid example: 8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b description: >- UUID of the payment row. Ledger movements reference it in their paymentUuid. unitRentalRecordUuid: type: string format: uuid example: 5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f description: UUID of the rental record this payment row belongs to. accountUuid: type: string nullable: true format: uuid example: 3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d description: >- UUID of the account this payment row belongs to. Null when the row has no account. transactionType: type: string enum: - PAYMENT - CREDIT - BAD_DEBT_WRITE_OFF - REFUND - VOID - INVOICE - CREDIT_MEMO - TRANSFER_CREDIT - REVERSED_CREDIT - FAILED_PAYMENT_REVERSAL - VOID_INVOICE - VOID_CHECK - CHARGEBACK - DEBIT_MEMO - AUCTION_PAYMENT - AUCTION_PAYOUT - BALANCE_TRANSFER example: PAYMENT description: >- Type of the row. PAYMENT is money received; CREDIT is a credit issued by management, not tied to an invoice item; CREDIT_MEMO, VOID_INVOICE and DEBIT_MEMO are adjustments to specific invoice items; BAD_DEBT_WRITE_OFF settles a balance without money; REFUND, CHARGEBACK, FAILED_PAYMENT_REVERSAL, VOID_CHECK, REVERSED_CREDIT and AUCTION_PAYOUT undo an earlier row (see originalSourcePaymentUuid); TRANSFER_CREDIT and BALANCE_TRANSFER move credit between rental records as a negative and positive pair; AUCTION_PAYMENT is the auction buyer's payment. A PAYMENT row also records a declined or pending attempt; check paymentStatus before counting it as money received. paymentStatus: type: string enum: - READY - PROCESSING - COMPLETED - REFUNDED - FAILURE - REVERSED - VOIDED - RECONCILIATION_FAILED - CHARGEBACK - PARTIALLY_REFUNDED example: COMPLETED description: >- Current status of the row. COMPLETED settled; READY and PROCESSING are still with the processor; FAILURE was declined; REFUNDED, PARTIALLY_REFUNDED, CHARGEBACK, REVERSED, VOIDED and RECONCILIATION_FAILED mean the row was undone afterwards. tenderType: type: string enum: - ACH - CASH - CREDIT/DEBIT - CHECK/MONEY_ORDER - BAD_DEBT_WRITE_OFF - CREDIT - CHARGEBACK example: CHECK/MONEY_ORDER description: >- Payment method (tender type) of the row. CREDIT/DEBIT = card, CHECK/MONEY_ORDER = check. On a refund it is the method the money went back through. paymentSource: nullable: true type: string enum: - MANUAL - AUTOPAY example: MANUAL description: >- AUTOPAY for the scheduled automatic charge, MANUAL for every other payment. Null on most refund, memo and write-off rows, and on history migrated from a previous system. amountInPennies: type: number example: 30000 description: >- Amount of the row when it was recorded, in pennies. Signed: negative on rows that undo a previous one. It does not change afterwards: refunds and reversals are rows of their own, and the original row only changes status. Includes any card surcharge, reported separately in surchargeInPennies. For payments recorded before June 2025, which predate the stored original amount, it is the payment's current total instead. surchargeInPennies: type: number example: 0 description: >- Card surcharge charged with this payment, in pennies, already included in amountInPennies. 0 when there is none. unappliedAmountInPennies: type: number example: 10000 description: >- Part of the row not yet used on any invoice, in pennies, as of now. It drops when a later invoice consumes it, and updatedAt changes when that happens. On CREDIT, TRANSFER_CREDIT and BALANCE_TRANSFER rows it is unused credit, not cash; on an AUCTION_PAYMENT row it is surplus owed to the former tenant. Negative on rows that undo a previous one. paymentDate: type: string format: date-time example: '2026-06-01T14:05:12.000Z' description: >- Date and time the payment was recorded as received: the receipt date, which can differ from createdAt, the moment this row was written. For transactions entered in Monument it is the moment of entry; for history migrated from a previous system it is the date from that system. originalSourcePaymentUuid: type: string nullable: true format: uuid example: null description: >- On a row that undoes an earlier one, such as a refund, chargeback or reversal, the UUID of the payment it undoes. Null otherwise. createdAt: type: string format: date-time example: '2026-06-01T14:05:12.000Z' description: Date when the payment row was created updatedAt: type: string format: date-time example: '2026-06-03T16:20:41.000Z' description: >- Date when the payment row was last updated, including when a later invoice consumes its unapplied part or the payment is refunded. required: - paymentUuid - unitRentalRecordUuid - accountUuid - transactionType - paymentStatus - tenderType - paymentSource - amountInPennies - surchargeInPennies - unappliedAmountInPennies - paymentDate - originalSourcePaymentUuid - createdAt - updatedAt ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.