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

The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.

startDatestring date

Start date, inclusive. Format is YYYY-MM-DD

endDatestring date

End date, inclusive. Format is YYYY-MM-DD

include'payorOnly' | 'payorAndDescendants'

Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to 'payorOnly' or 'payorAndDescendants'. payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted. 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. 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

Response

Export Transactions response

Changes

Changed in 6 of the 50 revisions of this API.33139

Aug 15, 2023b924ba134e091See the full diff
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 2020dd71433847a61See the full diff
- ●
  removed the optional property paymentType from the response with the 200 status
  response-optional-property-removed
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 24, 2020aded220b0d7b11See the full diff
- ●
  deleted the query request parameter submittedDateFrom
  request-parameter-removed
- ○
  added the new optional query request parameter endDate
  new-optional-request-parameter
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 6, 2019fbe041e3d325131See the full diff
- ▲
  removed the success response with the status 204
  response-success-status-removed
- ○
  api operation id exportTransactionsCSV removed and replaced with exportTransactionsCSVV4
  api-operation-id-removed
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the optional property credit to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property creditCurrency to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property dateFundingRequested to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property debit to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property debitCurrency to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property fundingType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property fxApplied to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property payeeEmail to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property payeeName to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property payeeType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentAmount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentCurrency to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentMemo to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentRails to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentStatus to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property paymentType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property payorPaymentId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property rejectReason to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property remoteId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property reportTransactionType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property returnCode to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property returnDescription to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property returnFee to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property returnFeeCurrency to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property returnFeeDescription to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property sourceAccount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property transactionDate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property transactionTime to the response with the 200 status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 15, 2019696838c159e51See the full diff
- ○
  added the new optional query request parameter include
  new-optional-request-parameter
Jul 15, 2019ced8e167a97c2295See the full diff
- ▲
  the response's body type/format changed from object/ to string/ for status 200
  response-body-type-changed
- ▲
  removed the media type application/json for the response with the status 400
  response-media-type-removed
- ●
  deleted the query request parameter endDate
  request-parameter-removed
- ●
  deleted the query request parameter include
  request-parameter-removed
- ●
  removed the optional property credit from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property creditCurrency from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property dateFundingRequested from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property debit from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property debitCurrency from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property fundingType from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property fxApplied from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property payeeEmail from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property payeeName from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property payeeType from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property paymentAmount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property paymentCurrency from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property paymentMemo from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property paymentRails from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property paymentStatus from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property payorPaymentId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property rejectReason from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property remoteId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reportTransactionType from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property returnCode from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property returnDescription from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property returnFee from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property returnFeeCurrency from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property returnFeeDescription from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property sourceAccount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property transactionDate from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property transactionTime from the response with the 200 status
  response-optional-property-removed
- ○
  api operation id exportTransactionsCSVV4 removed and replaced with exportTransactionsCSV
  api-operation-id-removed
- ○
  added the new optional query request parameter submittedDateFrom
  new-optional-request-parameter
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  added the success response with the status 204
  response-success-status-added
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history