idstring
The internal id of the payment request
paymentRequestNostring
The payment request number
referencestring
The payment request reference
descriptionstring
Short description of the payment request
totalAmountnumber
The payment request amount
principalAmountnumber
The principal amount of the payment request, excluding fees
paidAmountnumber
The total amount that is paid
currencyCode'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'
The currency in which the payment request is raised
payByDatestring date-time
The (optional) date until when user recommended the payer to pay
creationTimestring date-time
The date the payment request was created
distributionTimestring date-time
The time when the payment request was distributed to the customer
lastNotificationSentTimestring date-time
The date the payment request was last sent to the customer
lastUpdatedTimestring date-time
The date the payment request was last updated
paidTimestring date-time
The date the payment request paid
paymentInitiationDatestring date-time
The date when payment is initiated for this payment request (only for Direct Debit)
chargeDatestring date-time
The date on which the customer will have their account debited
payoutDatestring date-time
The date on which the biller will get paid out for the payment
status'DRAFT' | 'UNPAID' | 'OVERDUE' | 'SCHEDULED' | 'SUBMITTED' | 'PAID' | 'VOID' | 'SETTLED'
The payment request status
statusReasonCode'MISSING_PAYER_CONTACT_DETAILS' | 'PENDING_ACTIVATION' | 'PENDING_DD_MANDATE' | 'PENDING_DD_CAPABILITY' | 'MARKED_AS_PAID' | 'WORKFLOW_COMPLETED' | 'NOTIFICATION_DELIVERY_FAILED' | 'BULK_PRUNE' | 'STALE_DRAFT_CLEANUP' | 'OTHER' | 'DIRECT_DEBIT_MANDATE_BANK_ACCOUNT_CHANGED'
The reason as predefined code why the payment request is in a certain status
statusReasonstring
Custom details on why the payment request is in a certain status
paymentRequestSource'MANUAL' | 'SCHEDULE' | 'INVOICE' | 'EXTERNAL' | 'OVERPAYMENT' | 'GENERIC_PAYMENT_LINK' | 'PAYMENT_ALLOCATION' | 'PAYMENT_OVER_PHONE'
The source of the payment request
redirectUrlstring
The (optional) redirect URL to redirect the user after they complete the payment
associationType'SINGLE' | 'ONE_TO_ONE' | 'PARTIAL' | 'BATCH'
The payment request association type
creditControlStatus'AT_RISK' | 'EXPECTED' | 'CONFIRMED'
The credit control status of the payment request
workflowType'AUTO_COLLECT' | 'ON_DEMAND' | 'NONE'
The workflow type of the payment request
tagsstring[]
The list of tag ids that are applied to the payment request
createdBystring
The creator of the payment request