# Retrieve a list of payment requests by filter

Endpoint: GET /payment_requests
Version: 1.0.0
Security: Biller Access Token (Staging), Biller Access Token (Production)

## Query parameters:

  - `customerId` (string)
    The id of the customer associated to the payment request.

  - `externalCustomerId` (string)
    The id of the customer from the platform that is integrating with Adfin.

  - `statuses` (string)
    The status of the payment request.
* DRAFT: The payment request does not contain contact details for the payer or it is not yet distributed.
* UNPAID: The payment request is not yet paid.
* SCHEDULED: The payment request is scheduled to collect the payment via Direct Debit.
* SUBMITTED: The remaining due amount on the payment request is covered by submitted (but not yet confirmed) Direct debit payments.
* PAID: The payment request payment payment is captured.
* CANCELLED: The payment request is cancelled.
* SETTLED: THe payment request is paid out

  - `associationTypes` (string)
    Payment request association type.
* SINGLE - a one off payment request.
* ONE_TO_ONE - a payment request associated with a single invoice.
* PARTIAL - a payment request that is associated with an invoice that has multiple payment requests (many to one)
* BATCH - a payment request that is associated with multiple invoices (one to many)

defaults to all types if not specified.

  - `payByStartDate` (string)
    The start date after which the payment requests pay by date should be, including the start date.

  - `payByEndDate` (string)
    The end date before which the payment requests pay by date should be, including the end date.

  - `createdStartDate` (string)
    The start date after which the payment requests created date should be, including the start date.

  - `createdEndDate` (string)
    The end date before which the payment requests created date should be, including the end date.

  - `paidStartTime` (string)
    The start time after which the payment request was paid, including the paid start time.

  - `paidEndTime` (string)
    The end time after which the payment request was paid, including the paid end time.

  - `lastUpdatedStartTime` (string)
    The start time after which the payment requests last updated time should be, including the start time.

  - `lastUpdatedEndTime` (string)
    The end time before which the payment requests last updated time should be, including the end time.

  - `paymentLinkLastSeenTime` (string)
    The start time before which the payment link was seen.

  - `paymentInitiationDate` (string)

  - `searchText` (string)
    The text to search for in the payment requests.

  - `includeCount` (string)
    Whether the response should include details on total count and counts per statuses

  - `creditControlStatuses` (string)
    The credit control status of the payment request.
* AT_RISK: The payment request is at risk of not being paid.
* EXPECTED: The payment request is expected to be paid.
* CONFIRMED: The payment request is paid.

  - `cashflowStatuses` (string)
    The cashflow status of the payment request.
* UNPAID   – not yet paid.
* PROCESSING – expected to be paid.
* PAID_OUT – already paid out.

  - `cashflowPeriodStartDate` (string)
    Start of the cashflow period (inclusive)

  - `cashflowPeriodEndDate` (string)
    End of the cashflow period (inclusive)

  - `directDebitMandateStatuses` (string)
    The direct debit mandate status.
* NO_MANDATE: payment requests linked to customers without a mandate
* AWAITING_SIGNATURE: payment requests linked to customers awaiting signature
* SIGNED: payment requests linked to customers with a signed mandate, but not yet active
* ACTIVE: payment requests linked to customers with an active mandate.

  - `workflowTypes` (string)
    The workflow type.
* AUTO_COLLECT: automatic collection workflow, such as direct debit
* ON_DEMAND: on demain workflow, such as via open banking and card payments

  - `minAmount` (string)
    amount greater than or equal to

  - `maxAmount` (string)
    amount less than or equal to

  - `scheduleId` (string)
    The id of the schedule associated to the payment request.

  - `fieldValueIds` (string)
    List of field value IDs to filter payment requests by their associated field mappings.

  - `reviewSessionId` (string)
    The review session ID to filter payment requests by

  - `page` (integer)
    Zero-based page index (0..N)

  - `size` (integer)
    The size of the page to be returned

  - `sort` (array)
    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

## Response 200 fields (application/json):

  - `paymentRequests` (array)
    List of payment requests

  - `paymentRequests.id` (string)
    The internal id of the payment request

  - `paymentRequests.paymentRequestNo` (string)
    The payment request number

  - `paymentRequests.reference` (string)
    The payment request reference

  - `paymentRequests.description` (string)
    Short description of the payment request

  - `paymentRequests.totalAmount` (number)
    The payment request amount

  - `paymentRequests.paidAmount` (number)
    The total amount that is paid

  - `paymentRequests.dueAmount` (number)
    The amount that is due

  - `paymentRequests.currencyCode` (string)
    The default currency of the biller.. 
Possible values (non-exclusive): AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SPL, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMW, ZWD

  - `paymentRequests.taxRate` (number)
    Tax rate percentage

  - `paymentRequests.payByDate` (string)
    The (optional) date until when user recommended the payer to pay

  - `paymentRequests.creationTime` (string)
    The date the payment request was created

  - `paymentRequests.distributionTime` (string)
    The time when the payment request was distributed to the customer

  - `paymentRequests.lastNotificationSentTime` (string)
    The date the payment request was last sent to the customer

  - `paymentRequests.lastUpdatedTime` (string)
    The date the payment request was last updated

  - `paymentRequests.paidTime` (string)
    The date the payment request paid

  - `paymentRequests.paymentInitiationDate` (string)
    The date when payment is initiated for this payment request (only for Direct Debit)

  - `paymentRequests.chargeDate` (string)
    The date on which the customer will have their account debited

  - `paymentRequests.payoutDate` (string)
    The date on which the biller will get paid out for the payment

  - `paymentRequests.status` (string)
    The status of the payment request.
* DRAFT: The payment request does not contain contact details for the payer or it is not yet distributed.
* UNPAID: The payment request is not yet paid.
* OVERDUE: THe payment request is not yet paid and is past the pay by date.
* SCHEDULED: The payment request is scheduled to collect the payment via Direct Debit.
* SUBMITTED: The remaining due amount on the payment request is covered by submitted (but not yet confirmed) Direct debit payments.
* PAID: The payment request payment is captured.
* VOID: The payment request is voided.
* SETTLED: The payment request is paid out.
. 
Possible values (non-exclusive): DRAFT, UNPAID, OVERDUE, SCHEDULED, SUBMITTED, PAID, VOID, SETTLED

  - `paymentRequests.statusReasonCode` (string)
    The reason why the invoice is in a certain status.
* MISSING_PAYER_CONTACT_DETAILS - The invoice is missing the contact details of payer.
* PENDING_ACTIVATION - The invoice is not yet distributed by Adfin.. 
Possible values (non-exclusive): MISSING_PAYER_CONTACT_DETAILS, PENDING_ACTIVATION, PENDING_DD_MANDATE, PENDING_DD_CAPABILITY, MARKED_AS_PAID, WORKFLOW_COMPLETED, NOTIFICATION_DELIVERY_FAILED, BULK_PRUNE, OTHER

  - `paymentRequests.statusReason` (string)
    Custom details on why the payment request is in a certain status

  - `paymentRequests.paymentRequestSource` (string)
    The source of the payment request. 
Possible values (non-exclusive): MANUAL, SCHEDULE, INVOICE, EXTERNAL, OVERPAYMENT

  - `paymentRequests.payments` (array)
    The payments made as part of this payment request

  - `paymentRequests.payments.id` (string, required)
    The internal id of the payment

  - `paymentRequests.payments.paymentRequestId` (string, required)
    The ID of the payment request

  - `paymentRequests.payments.creationTime` (string, required)
    The date when the payment was initiated

  - `paymentRequests.payments.lastUpdatedTime` (string)
    The last time when the payment was updated

  - `paymentRequests.payments.amount` (number, required)
    The paid amount

  - `paymentRequests.payments.status` (string, required)
    Statuses for payments. 
Possible values (non-exclusive): PENDING, SUBMITTED, SENT, SUCCESS, CANCELLED, FAILED, SETTLED

  - `paymentRequests.payments.paymentMethod` (string, required)
    Payment method types. 
Possible values (non-exclusive): BANK_PAYMENT, CARD, APPLE_PAY, GOOGLE_PAY, DIRECT_DEBIT, IMPORTED, MANUAL_BANK_TRANSFER, BANK_TRANSFER, AMEX

  - `paymentRequests.payments.channelPaymentId` (string, required)
    Unique identifier for the payment in the payment provider's system

  - `paymentRequests.payments.channelPaymentUrl` (string)
    The URL generated by the payment provider to perform the payment

  - `paymentRequests.payments.channelReferenceId` (string)
    The remittance reference ID for bank payments

  - `paymentRequests.payments.externalData` (array)
    References about this payment from external platforms Adfin integrates with

  - `paymentRequests.payments.externalData.connectorType` (string)
    The connector type. 
Possible values (non-exclusive): XERO, QUICKBOOKS, BRIDGE, STRIPE, PLATFORM

  - `paymentRequests.payments.externalData.id` (string)
    ID of the payment in the external platform

  - `paymentRequests.payments.metadata` (object)

  - `paymentRequests.discounts` (array)
    The discounts applied to this payment request

  - `paymentRequests.discounts.totalAmount` (number)
    The discounted amount

  - `paymentRequests.discounts.expirationDate` (string)
    The date until when the discount is valid

  - `paymentRequests.paymentLink` (object)
    Payment link details.

  - `paymentRequests.paymentLink.url` (string)
    The payment URL.

  - `paymentRequests.paymentLink.lastSeenTime` (string)
    The date when the payment link was seen for the last time

  - `paymentRequests.redirectUrl` (string)
    The (optional) redirect URL to redirect the user after they complete the payment

  - `paymentRequests.invoices` (array)
    The invoices associated to this payment request

  - `paymentRequests.invoices.id` (string)
    The internal id of the invoice

  - `paymentRequests.invoices.invoiceNo` (string)
    The number of the invoice. Unique value that can be used as idempotency key

  - `paymentRequests.invoices.description` (string)
    Short description of the invoice

  - `paymentRequests.invoices.totalAmount` (string)
    The invoice total amount. Includes tax amount, amount paid or reduced with credit notes)

  - `paymentRequests.invoices.taxAmount` (string)
    The invoice tax amount.

  - `paymentRequests.invoices.dueAmount` (string)
    The invoice amount due (remaining to be paid).

  - `paymentRequests.invoices.creditNotesAmount` (string)
    The total amount that is credited.

  - `paymentRequests.invoices.dueDate` (string)
    The due date of the invoice

  - `paymentRequests.invoices.issueDate` (string)
    The issue date date of the invoice

  - `paymentRequests.invoices.creationTime` (string)
    The date the invoice was created

  - `paymentRequests.invoices.lastUpdatedTime` (string)
    The date the invoice was last updated

  - `paymentRequests.invoices.paidTime` (string)
    The date the invoice was paid

  - `paymentRequests.invoices.status` (string)
    The status of the invoice.
* DRAFT: The invoice is created, but not yet activated (sent)
* UNPAID: The invoice is not yet paid.
* SCHEDULED: The invoice is scheduled to collect the payment via Direct Debit.
* SUBMITTED: The remaining due amount on the invoice is covered by submitted (but not yet confirmed) Direct Debit payments.
* OVERDUE: The invoice is not yet paid and it is passed the due date.
* PAID: The invoice payment has been captured.
* SETTLED: The invoice is paid out.
* VOID: The invoice was voided.. 
Possible values (non-exclusive): DRAFT, UNPAID, OVERDUE, SCHEDULED, SUBMITTED, PAID, VOID, SETTLED

  - `paymentRequests.invoices.statusReason` (string)
    Custom details on why the invoice is in a certain status

  - `paymentRequests.invoices.itemsTaxType` (string)
    Specifies how tax is applied to line items in an invoice.
* EXCLUSIVE: Line items are exclusive of tax.
* INCLUSIVE: Line items are inclusive tax.
* NONE: Line items have no tax.. 
Possible values (non-exclusive): EXCLUSIVE, INCLUSIVE, NONE

  - `paymentRequests.invoices.items` (array)
    The list of items from the invoice

  - `paymentRequests.invoices.items.id` (string)
    The ID of the line item to update.

  - `paymentRequests.invoices.items.description` (string)
    The description of the item.

  - `paymentRequests.invoices.items.quantity` (number)
    The quantity of items.

  - `paymentRequests.invoices.items.unitAmount` (number)
    The price per unit of the item.

  - `paymentRequests.invoices.items.taxRate` (number)
    The tax rate percentage applied on the line item amount (quantity * unit amount).

  - `paymentRequests.invoices.items.taxAmount` (number)
    The tax amount added on top of the line item amount.

  - `paymentRequests.invoices.items.totalAmount` (number)
    The total price of the item.

  - `paymentRequests.invoices.items.taxDetails` (object)
    The tax details response.

  - `paymentRequests.invoices.items.taxDetails.id` (string)
    The ID of the tax rate.

  - `paymentRequests.invoices.items.taxDetails.rate` (number)
    The actual rate value.

  - `paymentRequests.invoices.items.accountDetails` (object)
    The account details response.

  - `paymentRequests.invoices.items.accountDetails.id` (string)
    The ID of the account code.

  - `paymentRequests.invoices.items.accountDetails.code` (string)
    The account code value.

  - `paymentRequests.invoices.items.productDetails` (object)
    The product details response.

  - `paymentRequests.invoices.items.productDetails.id` (string)
    The ID of the product.

  - `paymentRequests.invoices.items.productDetails.code` (string)
    The product code value.

  - `paymentRequests.invoices.items.trackingGroupIds` (array)
    Tracking groups attached to this line item.

  - `paymentRequests.invoices.items.trackingGroupIds.groupId` (string)
    Tracking group id.

  - `paymentRequests.invoices.items.trackingGroupIds.itemId` (string)
    Tracking group selection option id.

  - `paymentRequests.invoices.items.externalData` (array)
    Information about this line item captured from external systems

  - `paymentRequests.invoices.items.externalData.id` (string)
    The ID from the external platform

  - `paymentRequests.invoices.items.externalData.templateId` (string)
    The template ID from external platform from which this line item is created. Cannot use both the template ID and the account code.

  - `paymentRequests.invoices.items.externalData.accountCode` (string)
    The account code from external platform from which this line item is created. Cannot use both the template ID and the account code.

  - `paymentRequests.invoices.creditNotes` (array)
    The list of credit notes from the invoice

  - `paymentRequests.invoices.creditNotes.id` (string)
    Credit note id.

  - `paymentRequests.invoices.creditNotes.number` (string)
    Credit note number.

  - `paymentRequests.invoices.creditNotes.amount` (number)
    Credit note amount.

  - `paymentRequests.invoices.creditNotes.valueDate` (string)
    Date when credit note was applied.

  - `paymentRequests.invoices.creditNotes.externalData` (array)
    References about this credit note from external platforms Adfin integrates with. Such as ID etc

  - `paymentRequests.invoices.creditNotes.externalData.id` (string)
    ID of the Credit Note in the external platform

  - `paymentRequests.invoices.fileSource` (string)
    The source of the file currently being served. 
Possible values (non-exclusive): NONE, FILE_UPLOAD, EXTERNAL, ADFIN, PENDING_ADFIN

  - `paymentRequests.invoices.invoiceSource` (string)
    The source of the invoice. 
Possible values (non-exclusive): FILE_UPLOAD, MANUAL, PR, EXTERNAL, SCHEDULE, PLATFORM

  - `paymentRequests.invoices.externalData` (array)
    References about this invoice from external platforms Adfin integrates with. Such as ID etc

  - `paymentRequests.invoices.externalData.id` (string)
    ID of the Invoice in the external platform

  - `paymentRequests.customer` (object)
    The customer details.

  - `paymentRequests.customer.id` (string)
    The Adfin id of the customer.

  - `paymentRequests.customer.externalId` (string)
    The id of the customer from the platform that is integrating with Adfin.

  - `paymentRequests.customer.name` (string)
    The full name of the customer.

  - `paymentRequests.customer.creationTime` (string)
    The time the customer was created.

  - `paymentRequests.customer.lastUpdatedTime` (string)
    The last time when the customer was updated.

  - `paymentRequests.customer.people` (array)
    The list of people assigned to the customer.

  - `paymentRequests.customer.people.id` (string)
    The internal id of the person.

  - `paymentRequests.customer.people.firstName` (string)
    The first name of the person.

  - `paymentRequests.customer.people.lastName` (string)
    The last name of the person.

  - `paymentRequests.customer.people.email` (string)
    The email of the person.

  - `paymentRequests.customer.people.phoneNo` (string)
    The phone number of the person.

  - `paymentRequests.customer.people.isPrimaryContact` (boolean)
    True if this person is a primary contact.

  - `paymentRequests.customer.people.isIncludedInCommunications` (boolean)
    True if this person is included in the customers communications.

  - `paymentRequests.customer.addresses` (array)
    The list of the addresses for the customer.

  - `paymentRequests.customer.addresses.id` (string)
    The internal id of the address.

  - `paymentRequests.customer.addresses.city` (string)
    The name of the city.

  - `paymentRequests.customer.addresses.postalCode` (string)
    The postal code.

  - `paymentRequests.customer.addresses.country` (string)
    The name of the biller country.

  - `paymentRequests.customer.addresses.addressLine1` (string)
    The name of the street, and the house or building number.

  - `paymentRequests.customer.directDebitMandate` (object)
    Direct Debit details.

  - `paymentRequests.customer.directDebitMandate.id` (string)
    The id of the direct debit mandate.

  - `paymentRequests.customer.directDebitMandate.status` (string)
    The status of the Direct Debit Mandate, if any present.
* CREATED: The Direct Debit Mandate was created with success.
* PENDING: The Direct Debit Mandate was signed and accepted by the customer and it is in the Payment Provider's accepted timeframe.
* ACTIVE: The Direct Debit Mandate was confirmed by the Payment Provider.
* CANCELLED: The Direct Debit Mandate was cancelled directly by the customer.
* MIGRATING: The Direct Debit Mandate is in process of migrating from one payment provider to another.. 
Possible values (non-exclusive): CREATED, PENDING, ACTIVE, CANCELLED, MIGRATING

  - `paymentRequests.customer.directDebitMandate.statusReasonCode` (string)
    The reason why the direct debit mandate is in a certain status.
* PENDING_DD_CAPABILITY - The direct debit mandate was signed, but not yet submitted to the payment provider as the biller onboarding is still in progress.
* PENDING_ACTIVATION - The direct debit mandate was signed, but not yet activated by the payment provider.
* MIGRATED - The direct debit mandate was migrated to a new payment provider.
* BANK_ACCOUNT_CHANGED - The direct debit mandate was created due to a bank account change (bank switching).
* INCORRECT_BANK_DETAILS - The direct debit mandate has incorrect bank account details.
* OTHER - Unknown reason. 
Possible values (non-exclusive): PENDING_DD_CAPABILITY, PENDING_ACTIVATION, MIGRATED, BANK_ACCOUNT_CHANGED, INCORRECT_BANK_DETAILS, OTHER

  - `paymentRequests.customer.directDebitMandate.statusReason` (string)
    Reason explaining the current status of the direct debit mandate, especially useful for failure cases.

  - `paymentRequests.customer.directDebitMandate.creationTime` (string)
    The time when the mandate was created

  - `paymentRequests.customer.directDebitMandate.lastUpdatedTime` (string)
    The last time when the mandate was updated

  - `paymentRequests.customer.directDebitMandate.authorisationTime` (string)
    The time when the mandate was signed by the customer

  - `paymentRequests.customer.directDebitMandate.submissionTime` (string)
    The time when the mandate was submitted to the payment provider

  - `paymentRequests.customer.directDebitMandate.url` (string)
    The URL where the customer can sign the direct debit mandate.

  - `paymentRequests.customer.timezone` (string)
    The timezone of the customer.

  - `paymentRequests.customer.discount` (object)
    The customer discount details.

  - `paymentRequests.customer.discount.percentage` (number)
    The discount as a percentage to be applied for the invoices.

  - `paymentRequests.customer.discount.period` (integer)
    The period in hours until the discount expires.

  - `paymentRequests.customer.externalData` (array)
    References about this customer from external platforms Adfin integrates with, such as ID, etc.

  - `paymentRequests.customer.externalData.connectorType` (string, required)
    The customer connector type. 
Possible values (non-exclusive): XERO, QUICKBOOKS

  - `paymentRequests.customer.externalData.id` (string, required)
    The ID of the Customer in the external platform.

  - `paymentRequests.customer.externalData.name` (string)
    The name of the Customer in the external platform.

  - `paymentRequests.customer.tags` (array)
    The tag ids associated with the customer.

  - `paymentRequests.distribution` (object)
    Information about how a payment request is distributed and collected.

  - `paymentRequests.distribution.collectionMethod` (string)
    How the payment is expected to be collected for this payment request.. 
Possible values (non-exclusive): ONE_TIME_PAYMENT, DIRECT_DEBIT_PAYMENT, NONE

  - `paymentRequests.distribution.customMessage` (string)
    An optional message that will be sent to the customer when the payment request is distributed.

  - `paymentRequests.distribution.templateId` (string)
    The schedule template id used for sending the payment request to customer.

  - `paymentRequests.associationType` (string)
    Payment request association type.
* SINGLE - a one off payment request.
* ONE_TO_ONE - a payment request associated with a single invoice.
* PARTIAL - a payment request that is associated with an invoice that has multiple payment requests (many to one)
* BATCH - a payment request that is associated with multiple invoices (one to many). 
Possible values (non-exclusive): SINGLE, ONE_TO_ONE, PARTIAL, BATCH

  - `paymentRequests.creditControlStatus` (string)
    The credit control status of the payment request. 
Possible values (non-exclusive): AT_RISK, EXPECTED, CONFIRMED

  - `paymentRequests.workflowType` (string)
    The workflow type of the payment request. 
Possible values (non-exclusive): AUTO_COLLECT, ON_DEMAND, NONE

  - `paymentRequests.scheduleDetails` (object)
    The details about the schedule associated with a payment request

  - `paymentRequests.scheduleDetails.scheduleId` (string, required)
    The internal id of the schedule

  - `paymentRequests.scheduleDetails.scheduleNo` (string, required)
    The schedule number

  - `paymentRequests.scheduleDetails.type` (string)
    The type of schedule.
* RECURRING: Recurring Payment Request.
. 
Possible values (non-exclusive): RECURRING

  - `paymentRequests.instalmentDetails` (object)
    Instalment details

  - `paymentRequests.instalmentDetails.index` (integer)
    The index of the instalment within the instalment plan (1-based)

  - `paymentRequests.instalmentDetails.cadence` (object, required)
    The cadence of the schedule

  - `paymentRequests.instalmentDetails.cadence.type` (string, required)
    The type of cadence.
* INTERVAL: Interval. Based on a startDate and an (optional) endDate
* INTERVAL_COUNT: Interval based on a startDate and a count
* DAY_OF_MONTH: Day of month. Based on a specific day of the month
* CUSTOM: Custom. Specific list of dates
. 
Possible values (non-exclusive): INTERVAL, INTERVAL_COUNT, DAY_OF_MONTH, CUSTOM

  - `paymentRequests.instalmentDetails.cadence.timeUnit` (string)
    Required if type is INTERVAL.
Defines the time unit (e.g., DAYS, MONTHS, etc.).
. 
Possible values (non-exclusive): SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR

  - `paymentRequests.instalmentDetails.cadence.frequency` (integer)
    Required if type is INTERVAL.
Frequency of recurrence (e.g., every N time units).

  - `paymentRequests.instalmentDetails.cadence.dayOfMonth` (integer)
    Required if type is DAY_OF_MONTH.
Specifies the day of the month the schedule applies.

  - `paymentRequests.instalmentDetails.cadence.dates` (array)
    Required if type is CUSTOM.
A list of exact custom dates for the cadence.

  - `paymentRequests.instalmentDetails.cadence.startDate` (string, required)
    The start date of the schedule

  - `paymentRequests.instalmentDetails.cadence.endDate` (string)
    The (optional) end date of the schedule

  - `paymentRequests.instalmentDetails.cadence.count` (integer)
    The total number of items. Required for INTERVAL_COUNT type

  - `paymentRequests.customFields` (array)
    The list of custom fields that are applied to the payment request

  - `paymentRequests.customFields.fieldId` (string)
    The ID of the field definition.

  - `paymentRequests.customFields.fieldValueId` (string)
    The ID of the specific field value.

  - `paymentRequests.tags` (array)
    The list of tag ids that are applied to the payment request

  - `paymentRequests.createdBy` (string)
    The creator of the payment request

  - `count` (object)
    Payment request count details

  - `count.total` (integer)

  - `count.statusCounts` (array)

  - `count.statusCounts.count` (integer)

  - `pagination` (object)
    Contains pagination information for a set of results

  - `pagination.page` (integer)
    The current page number One-based page index (1..N).

  - `pagination.size` (integer)
    The size of the page, i.e., the number of elements per page.

  - `pagination.totalPages` (integer)
    The total number of pages available.

  - `pagination.totalElements` (integer)
    The total number of elements across all pages.

  - `pagination.numberOfElements` (integer)
    The number of elements in the current page.

  - `pagination.sort` (string)
    Sorting criteria in the format: property,(asc|desc).


## Response 400 fields

## Response 401 fields

## Response 422 fields

## Response 500 fields