Skip to content
Docs

Portfolio Manager/Payment History V2

Download payment history

GET/external/secure/api/v2/portfolio/download/owned/payment-history
API key required
Request
curl -X GET \
  "https://figure.com/external/secure/api/v2/portfolio/download/owned/payment-history" \
  -H "apikey: $FIGURE_API_KEY"

Query parameters

  • assetTypestring

    Asset type to query assets for. Must provide originatorId if using

  • originatorIdstring<uuid>

    Originator id to query assets for. Must provide assetType if using assetType query param

  • assetGroupstring

    Name of asset group to filter assets with

  • reportDatestring<date>

    Cutoff date of requested payment history

  • ownsPaymentsboolean

    Only show payments received during ownership of loan

Headers

  • apikeystring

    Provided key used to access the application's api

Responses

200CSV of payments for owned loans by asset type and report date

Returns the file as text/plain.

Response

Returns the file itself (text/plain).