Payment Audit Service
Payout History
Get Payments for Payout
Get List of payments for Payout, allowing for RETURNED status
get/v4/paymentaudit/payouts/{payoutId}
Path parameters
payoutIdstring uuid required
The id (UUID) of the payout.
Query parameters
remoteIdstring
The remote id of the payees.
status'ACCEPTED' | 'AWAITING_FUNDS' | 'FUNDED' | 'UNFUNDED' | 'BANK_PAYMENT_REQUESTED' | 'REJECTED' | 'ACCEPTED_BY_RAILS' | 'CONFIRMED' | 'FAILED' | 'RETURNED' | 'WITHDRAWN'
Payment Status
sourceAmountFrominteger
The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
sourceAmountTointeger
The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
paymentAmountFrominteger
The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
paymentAmountTointeger
The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
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
Page size. Default is 25. Max allowable is 100.
sortstring
List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
sensitiveboolean
Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
Response
200 response, data found okay
Example response
{
"summary": {
"submitting": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dbaName": "dbaName",
"payorName": "payorName"
},
"confirmedPayments": 6,
"releasedPayments": 1,
"withdrawn": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"payoutStatus": "ACCEPTED",
"totalPayments": 0,
"payoutFrom": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dbaName": "dbaName",
"payorName": "payorName"
},
"payoutTo": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dbaName": "dbaName",
"payorName": "payorName"
},
"quoted": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"instructed": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"incompletePayments": 5,
"submittedDateTime": "2000-01-23T04:56:07.000+00:00",
"quotedDateTime": "2000-01-23T04:56:07.000+00:00",
"withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
"returnedPayments": 5,
"instructedDateTime": "2000-01-23T04:56:07.000+00:00",
"payoutMemo": "payoutMemo"
},
"links": [
{
"rel": "rel",
"href": "href"
},
{
"rel": "rel",
"href": "href"
}
],
"page": {
"numberOfElements": 0,
"totalPages": 1,
"pageSize": 5,
"page": 5,
"totalElements": 6
},
"content": [
{
"traceNumber": "abodu123",
"accountName": "My Account Name",
"payout": {
"payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payoutFrom": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dbaName": "dbaName",
"payorName": "payorName"
},
"payoutTo": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dbaName": "dbaName",
"payorName": "payorName"
}
},
"paymentMemo": "Payment memo",
"paymentAmount": 2,
"fundingStatus": "FUNDED",
"railsBatchId": "railsBatchId",
"paymentChannelName": "My Payment Channel",
"filenameReference": "file ref",
"rate": 7.061401241503109,
"paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"countryCode": "US",
"returnReason": "Some Reason Value",
"submittedDateTime": "2000-01-23T04:56:07.000+00:00",
"sourceAmount": 12345,
"railsId": "asdf123",
"payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"events": [
{
"principal": "principal",
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"routingNumber": "routingNumber",
"accountName": "accountName",
"iban": "iban",
"sourceAmount": 1299,
"eventType": "PAYOUT_SUBMITTED",
"accountNumber": "accountNumber",
"paymentAmount": 1299
},
{
"principal": "principal",
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"routingNumber": "routingNumber",
"accountName": "accountName",
"iban": "iban",
"sourceAmount": 1299,
"eventType": "PAYOUT_SUBMITTED",
"accountNumber": "accountNumber",
"paymentAmount": 1299
}
],
"payorName": "payorName",
"sourceAccountName": "My Account",
"paymentChannelId": "123asdf",
"invertedRate": 9.301444243932576,
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"individualIdentificationNumber": "1231231adf",
"railsPaymentId": "railsPaymentId",
"accountNumber": "123123232323",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"remoteId": "aasdf123",
"routingNumber": "123123123123",
"returnCost": 1232,
"iban": "DE89 3704 0044 0532 0130 00",
"payorPaymentId": "123123asdf",
"rejectionReason": "rejectionReason",
"status": "ACCEPTED"
},
{
"traceNumber": "abodu123",
"accountName": "My Account Name",
"payout": {
"payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payoutFrom": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dbaName": "dbaName",
"payorName": "payorName"
},
"payoutTo": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dbaName": "dbaName",
"payorName": "payorName"
}
},
"paymentMemo": "Payment memo",
"paymentAmount": 2,
"fundingStatus": "FUNDED",
"railsBatchId": "railsBatchId",
"paymentChannelName": "My Payment Channel",
"filenameReference": "file ref",
"rate": 7.061401241503109,
"paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"countryCode": "US",
"returnReason": "Some Reason Value",
"submittedDateTime": "2000-01-23T04:56:07.000+00:00",
"sourceAmount": 12345,
"railsId": "asdf123",
"payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"events": [
{
"principal": "principal",
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"routingNumber": "routingNumber",
"accountName": "accountName",
"iban": "iban",
"sourceAmount": 1299,
"eventType": "PAYOUT_SUBMITTED",
"accountNumber": "accountNumber",
"paymentAmount": 1299
},
{
"principal": "principal",
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"routingNumber": "routingNumber",
"accountName": "accountName",
"iban": "iban",
"sourceAmount": 1299,
"eventType": "PAYOUT_SUBMITTED",
"accountNumber": "accountNumber",
"paymentAmount": 1299
}
],
"payorName": "payorName",
"sourceAccountName": "My Account",
"paymentChannelId": "123asdf",
"invertedRate": 9.301444243932576,
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"individualIdentificationNumber": "1231231adf",
"railsPaymentId": "railsPaymentId",
"accountNumber": "123123232323",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"remoteId": "aasdf123",
"routingNumber": "123123123123",
"returnCost": 1232,
"iban": "DE89 3704 0044 0532 0130 00",
"payorPaymentId": "123123asdf",
"rejectionReason": "rejectionReason",
"status": "ACCEPTED"
}
]
}