Get facility payments by UUIDs

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

payments

get_by_uuids

Get facility payments by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "paymentUuids": [
    "8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
    "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids"

payload = { "paymentUuids": ["8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b", "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    paymentUuids: ['8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b', '1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'paymentUuids' => [
        '8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b',
        '1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids"

	payload := strings.NewReader("{\n  \"paymentUuids\": [\n    \"8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b\",\n    \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paymentUuids\": [\n    \"8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b\",\n    \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paymentUuids\": [\n    \"8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b\",\n    \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "paymentUuid": "8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
    "unitRentalRecordUuid": "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
    "accountUuid": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",
    "transactionType": "PAYMENT",
    "paymentStatus": "COMPLETED",
    "tenderType": "CHECK/MONEY_ORDER",
    "paymentSource": "MANUAL",
    "amountInPennies": 30000,
    "surchargeInPennies": 0,
    "unappliedAmountInPennies": 10000,
    "paymentDate": "2026-06-01T14:05:12.000Z",
    "originalSourcePaymentUuid": null,
    "createdAt": "2026-06-01T14:05:12.000Z",
    "updatedAt": "2026-06-03T16:20:41.000Z"
  }
]

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

Body

application/json

paymentUuids

string<uuid>[]

required

Array of payment UUIDs to retrieve data for

Example:

[
  "8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
  "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8"
]

Response

Payment details retrieved successfully

paymentUuid

string<uuid>

required

UUID of the payment row. Ledger movements reference it in their paymentUuid.

Example:

"8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b"

unitRentalRecordUuid

string<uuid>

required

UUID of the rental record this payment row belongs to.

Example:

"5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"

accountUuid

string<uuid> | null

required

UUID of the account this payment row belongs to. Null when the row has no account.

Example:

"3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d"

transactionType

enum<string>

required

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.

Available options:

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"

paymentStatus

enum<string>

required

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.

Available options:

READY,

PROCESSING,

COMPLETED,

REFUNDED,

FAILURE,

REVERSED,

VOIDED,

RECONCILIATION_FAILED,

CHARGEBACK,

PARTIALLY_REFUNDED

Example:

"COMPLETED"

tenderType

enum<string>

required

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.

Available options:

ACH,

CASH,

CREDIT/DEBIT,

CHECK/MONEY_ORDER,

BAD_DEBT_WRITE_OFF,

CREDIT,

CHARGEBACK

Example:

"CHECK/MONEY_ORDER"

paymentSource

enum<string> | null

required

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.

Available options:

MANUAL,

AUTOPAY

Example:

"MANUAL"

amountInPennies

number

required

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.

Example:

30000

surchargeInPennies

number

required

Card surcharge charged with this payment, in pennies, already included in amountInPennies. 0 when there is none.

Example:

0

unappliedAmountInPennies

number

required

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.

Example:

10000

paymentDate

string<date-time>

required

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.

Example:

"2026-06-01T14:05:12.000Z"

originalSourcePaymentUuid

string<uuid> | null

required

On a row that undoes an earlier one, such as a refund, chargeback or reversal, the UUID of the payment it undoes. Null otherwise.

Example:

null

createdAt

string<date-time>

required

Date when the payment row was created

Example:

"2026-06-01T14:05:12.000Z"

updatedAt

string<date-time>

required

Date when the payment row was last updated, including when a later invoice consumes its unapplied part or the payment is refunded.

Example:

"2026-06-03T16:20:41.000Z"

Get facility payments by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "paymentUuids": [
    "8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
    "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids"

payload = { "paymentUuids": ["8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b", "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    paymentUuids: ['8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b', '1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'paymentUuids' => [
        '8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b',
        '1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids"

	payload := strings.NewReader("{\n  \"paymentUuids\": [\n    \"8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b\",\n    \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paymentUuids\": [\n    \"8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b\",\n    \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/payments/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paymentUuids\": [\n    \"8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b\",\n    \"1f2e3d4c-5b6a-7980-a1b2-c3d4e5f6a7b8\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "paymentUuid": "8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
    "unitRentalRecordUuid": "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
    "accountUuid": "3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",
    "transactionType": "PAYMENT",
    "paymentStatus": "COMPLETED",
    "tenderType": "CHECK/MONEY_ORDER",
    "paymentSource": "MANUAL",
    "amountInPennies": 30000,
    "surchargeInPennies": 0,
    "unappliedAmountInPennies": 10000,
    "paymentDate": "2026-06-01T14:05:12.000Z",
    "originalSourcePaymentUuid": null,
    "createdAt": "2026-06-01T14:05:12.000Z",
    "updatedAt": "2026-06-03T16:20:41.000Z"
  }
]

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

GL Accounts

ECRI

Journal Entries

Ledger Entries

Rent Changes

Payments

Summary

Auctions

Tenants

User Accounts

Units

Unit Groups

Physical Locks

Move Out

Leads

Tasks

People

Lead Source Options

Notes

Promotions

Webhooks

Headers

Path Parameters

Body

Response