Payment Audit Service
Get Payouts for Payor
Get List of payouts for payor
get/v4/paymentaudit/payouts
Query parameters
payorIdstring uuid
The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
payoutMemostring
Payout Memo filter - case insensitive sub-string match
status'ACCEPTED' | 'REJECTED' | 'SUBMITTED' | 'QUOTED' | 'INSTRUCTED' | 'COMPLETED' | 'INCOMPLETE' | 'CONFIRMED' | 'WITHDRAWN'
Payout Status
submittedDateFromstring date
The submitted date from range filter. Format is yyyy-MM-dd.
submittedDateTostring date
The submitted date to range filter. Format is yyyy-MM-dd.
fromPayorNamestring
The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
scheduledForDateFromstring date
Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
scheduledForDateTostring date
Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
scheduleStatus'ANY' | 'SCHEDULED' | 'EXECUTED' | 'FAILED'
Payout Schedule Status
pageinteger
Page number. Default is 1.
pageSizeinteger
The number of results to return in a page
sortstring
List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId, scheduledFor
Response
Payor data found
Example response
{
"links": [
{
"rel": "rel",
"href": "href"
},
{
"rel": "rel",
"href": "href"
}
],
"page": {
"numberOfElements": 0,
"totalPages": 1,
"pageSize": 5,
"page": 5,
"totalElements": 6
},
"content": [
{
"dateTime": "2000-01-23T04:56:07.000+00:00",
"sourceAccountSummary": [
{
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currency": "EUR",
"totalCost": 3344
},
{
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currency": "EUR",
"totalCost": 3344
}
],
"payoutType": "payoutType",
"totalReturnedPayments": 1,
"fxSummaries": [
{
"invertedRate": 123.23,
"rate": 123.23,
"sourceCurrency": "EUR",
"totalPaymentAmount": 34235,
"paymentCurrency": "EUR",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalCost": 5,
"fundingStatus": "fundingStatus",
"creationDateTime": "2000-01-23T04:56:07.000+00:00",
"status": "status"
},
{
"invertedRate": 123.23,
"rate": 123.23,
"sourceCurrency": "EUR",
"totalPaymentAmount": 34235,
"paymentCurrency": "EUR",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalCost": 5,
"fundingStatus": "fundingStatus",
"creationDateTime": "2000-01-23T04:56:07.000+00:00",
"status": "status"
}
],
"payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalPayments": 0,
"schedule": {
"scheduledFor": "2000-01-23T04:56:07.000+00:00",
"scheduleStatus": "SCHEDULED",
"notificationsEnabled": true,
"scheduledBy": "Aphra Behn",
"scheduledByPrincipalId": "8946953b-1e3b-49cf-9da4-b704cbb78f3e",
"scheduledAt": "2000-01-23T04:56:07.000+00:00"
},
"submittedDateTime": "submittedDateTime",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalIncompletePayments": 6,
"withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
"totalWithdrawnPayments": 5,
"instructedDateTime": "instructedDateTime",
"status": "status",
"payoutMemo": "payoutMemo",
"payorName": "payorName"
},
{
"dateTime": "2000-01-23T04:56:07.000+00:00",
"sourceAccountSummary": [
{
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currency": "EUR",
"totalCost": 3344
},
{
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currency": "EUR",
"totalCost": 3344
}
],
"payoutType": "payoutType",
"totalReturnedPayments": 1,
"fxSummaries": [
{
"invertedRate": 123.23,
"rate": 123.23,
"sourceCurrency": "EUR",
"totalPaymentAmount": 34235,
"paymentCurrency": "EUR",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalCost": 5,
"fundingStatus": "fundingStatus",
"creationDateTime": "2000-01-23T04:56:07.000+00:00",
"status": "status"
},
{
"invertedRate": 123.23,
"rate": 123.23,
"sourceCurrency": "EUR",
"totalPaymentAmount": 34235,
"paymentCurrency": "EUR",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalCost": 5,
"fundingStatus": "fundingStatus",
"creationDateTime": "2000-01-23T04:56:07.000+00:00",
"status": "status"
}
],
"payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalPayments": 0,
"schedule": {
"scheduledFor": "2000-01-23T04:56:07.000+00:00",
"scheduleStatus": "SCHEDULED",
"notificationsEnabled": true,
"scheduledBy": "Aphra Behn",
"scheduledByPrincipalId": "8946953b-1e3b-49cf-9da4-b704cbb78f3e",
"scheduledAt": "2000-01-23T04:56:07.000+00:00"
},
"submittedDateTime": "submittedDateTime",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalIncompletePayments": 6,
"withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
"totalWithdrawnPayments": 5,
"instructedDateTime": "instructedDateTime",
"status": "status",
"payoutMemo": "payoutMemo",
"payorName": "payorName"
}
]
}