Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
paymentProfiles
/
get_by_uuids
Get payment profiles by UUIDs for a facility
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/paymentProfiles/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "paymentProfileUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'
[
  {
    "accountType": "ACH",
    "creditCardBrand": "Visa",
    "lastFour": "4444",
    "expirationDate": "01/2025",
    "lastPaymentStatus": "SUCCESS"
  }
]

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
​
paymentProfileUuids
string<uuid>[]
required

Array of payment profile UUIDs to retrieve data for

Example:
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "3fa85f64-5717-4562-b3fc-2c963f66afa7"
]

Response

200 - application/json

Successfully retrieved payment profile data

​
accountType
enum<string>
required

Payment profile type

Available options:
CREDIT/DEBIT,
ACH
Example:

"ACH"

​
creditCardBrand
string
required

Credit card brand

Example:

"Visa"

​
lastFour
string
required

Last four digits of the credit card

Example:

"4444"

​
expirationDate
string<MM/YY>
required

Expiration date of the credit card

Example:

"01/2025"

​
lastPaymentStatus
string
required

Status of the last payment attempt

Example:

"SUCCESS"