Payment Audit Service
Export Transactions
Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
get/v4/paymentaudit/transactions
Query parameters
payorIdstring uuid
<p>The Payor ID for whom you wish to run the report.</p>
<p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
startDatestring date
Start date, inclusive. Format is YYYY-MM-DD
endDatestring date
End date, inclusive. Format is YYYY-MM-DD
include'payorOnly' | 'payorAndDescendants'
<p>Mode to determine whether to include other Payor's data in the results.</p>
<p>May only be used if payorId is specified.</p>
<p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p>
<p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p>
<p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p>
<p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p>
Response
Export Transactions response