Payment Audit Service (Deprecated)
V3 Get Payouts for Payor
Deprecated (use /v4/paymentaudit/payouts instead)
get/v3/paymentaudit/payouts
Query parameters
payorIdstring uuid required
The account owner Payor ID
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.
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.
Response
Payor data found
Example response
{
"links": [
{
"rel": "first",
"href": "https://example.com"
},
{
"rel": "first",
"href": "https://example.com"
}
],
"page": {
"numberOfElements": 12,
"totalPages": 123,
"pageSize": 25,
"page": 1,
"totalElements": 123
},
"content": [
{
"sourceAccountSummary": [
{
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currency": "currency",
"totalCost": 3434
},
{
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currency": "currency",
"totalCost": 3434
}
],
"submittedDateTime": "submittedDateTime",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalIncompletePayments": 123,
"fxSummaries": [
{
"invertedRate": 1.12,
"rate": 1.12,
"sourceCurrency": "sourceCurrency",
"totalPaymentAmount": 1234,
"paymentCurrency": "paymentCurrency",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalCost": 1234,
"fundingStatus": "fundingStatus",
"creationDateTime": "2000-01-23T04:56:07.000+00:00",
"status": "status"
},
{
"invertedRate": 1.12,
"rate": 1.12,
"sourceCurrency": "sourceCurrency",
"totalPaymentAmount": 1234,
"paymentCurrency": "paymentCurrency",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalCost": 1234,
"fundingStatus": "fundingStatus",
"creationDateTime": "2000-01-23T04:56:07.000+00:00",
"status": "status"
}
],
"payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"withdrawnDateTime": "withdrawnDateTime",
"totalPayments": 123,
"instructedDateTime": "instructedDateTime",
"totalFailedPayments": 123,
"status": "status",
"payoutMemo": "payoutMemo"
},
{
"sourceAccountSummary": [
{
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currency": "currency",
"totalCost": 3434
},
{
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"currency": "currency",
"totalCost": 3434
}
],
"submittedDateTime": "submittedDateTime",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalIncompletePayments": 123,
"fxSummaries": [
{
"invertedRate": 1.12,
"rate": 1.12,
"sourceCurrency": "sourceCurrency",
"totalPaymentAmount": 1234,
"paymentCurrency": "paymentCurrency",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalCost": 1234,
"fundingStatus": "fundingStatus",
"creationDateTime": "2000-01-23T04:56:07.000+00:00",
"status": "status"
},
{
"invertedRate": 1.12,
"rate": 1.12,
"sourceCurrency": "sourceCurrency",
"totalPaymentAmount": 1234,
"paymentCurrency": "paymentCurrency",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"totalCost": 1234,
"fundingStatus": "fundingStatus",
"creationDateTime": "2000-01-23T04:56:07.000+00:00",
"status": "status"
}
],
"payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"withdrawnDateTime": "withdrawnDateTime",
"totalPayments": 123,
"instructedDateTime": "instructedDateTime",
"totalFailedPayments": 123,
"status": "status",
"payoutMemo": "payoutMemo"
}
]
}