List and monitor payment jobs by status and type.
List Payment Jobs
Returns a paginated list of payment jobs filtered by payment status and optionally by payment types.
query Parameters
paymentStatusFilters results by payment status.
0 (Unknown), 1 (InProcessing), 2 (ReadyForApproval), 3 (Received), 4 (Approved), 5 (Partial), 6 (Paid), 8 (Stopped), 11 (Failed).
paymentsTypeFilters results by one or more payment types.
pageThe page number to retrieve. Defaults to 1.
sizeThe number of results per page. Defaults to 10,000.
List Payment Jobs โบ Responses
Success
paymentIdtransactionStatuspaymentPostedisPostedpaymentsType0 (Unknown), 10 (Pti), 20 (Invoice), 30 (Banktransaction).
paymentStatus0 (Unknown), 1 (InProcessing), 2 (ReadyForApproval), 3 (Received), 4 (Approved), 5 (Partial), 6 (Paid), 8 (Stopped), 11 (Failed).
paymentStatusTimematchedAgreedbatchIdreferencereferenceNamebankAccountIdbankAccountBicdueDaycountTotal number of invoices
amountTotal amount
currenyamountToBePaidPayable amount
countToBePaidpayable number of invoices
countResetNumber of invoices that as been reverted
amountResetReverted amount
countFailedNumber of invoices that has failed. Failed can be reverted.
amountFailedFailed amount
message
