Payment Audit Service
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
railsIdstring
Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint.
remoteIdstring
The remote id of the payees.
remoteSystemIdstring
The id of the remote system that is orchestrating payments
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.
transmissionType'ACH' | 'SAME_DAY_ACH' | 'WIRE' | 'LOCAL' | 'GACHO'
Transmission Type
- ACH
- SAME_DAY_ACH
- WIRE
- GACHO
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,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": {
"withdrawnPayments": 2,
"submitting": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dbaName": "dbaName",
"payorName": "payorName"
},
"payoutType": "payoutType",
"confirmedPayments": 6,
"releasedPayments": 1,
"withdrawn": {
"principal": "principal",
"principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"payoutStatus": "payoutStatus",
"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"
},
"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"
},
"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",
"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"
}
},
"paymentScheme": "paymentScheme",
"paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"submittedDateTime": "2000-01-23T04:56:07.000+00:00",
"railsId": "asdf123",
"payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"railsRejectionInformation": "railsRejectionInformation",
"events": [
{
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"accountName": "accountName",
"sourceCurrency": "EUR",
"eventType": "eventType",
"accountNumber": "accountNumber",
"paymentAmount": 1299,
"principal": "principal",
"routingNumber": "routingNumber",
"iban": "iban",
"scheduledFor": "2000-01-23T04:56:07.000+00:00",
"sourceAmount": 1299,
"scheduledBy": "Aphra Behn",
"paymentCurrency": "EUR",
"scheduledAt": "2000-01-23T04:56:07.000+00:00"
},
{
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"accountName": "accountName",
"sourceCurrency": "EUR",
"eventType": "eventType",
"accountNumber": "accountNumber",
"paymentAmount": 1299,
"principal": "principal",
"routingNumber": "routingNumber",
"iban": "iban",
"scheduledFor": "2000-01-23T04:56:07.000+00:00",
"sourceAmount": 1299,
"scheduledBy": "Aphra Behn",
"paymentCurrency": "EUR",
"scheduledAt": "2000-01-23T04:56:07.000+00:00"
}
],
"transactionReference": "transactionReference",
"railsPaymentId": "railsPaymentId",
"payeeAddressCountryCode": "US",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"transactionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"returnCost": 1232,
"withdrawnReason": "withdrawnReason",
"iban": "DE89 3704 0044 0532 0130 00",
"paymentMetadata": "sample metadata",
"payorPaymentId": "123123asdf",
"remoteSystemId": "REMOTE_SYSTEM_ID",
"paymentCurrency": "EUR",
"rejectionReason": "rejectionReason",
"paymentTrackingReference": "paymentTrackingReference",
"status": "status",
"postInstructFxInfo": {
"fxStatus": "INITIATED",
"fxStatusUpdatedAt": "2000-01-23T04:56:07.000+00:00",
"fxTransactionReference": "AB123GHI",
"fxMode": "MANUAL"
},
"accountName": "My Account Name",
"remoteSystemPaymentId": "remoteSystemPaymentId",
"sourceCurrency": "EUR",
"paymentMemo": "Payment memo",
"railsAccountId": "railsAccountId",
"paymentAmount": 7,
"fundingStatus": "fundingStatus",
"railsBatchId": "railsBatchId",
"paymentChannelName": "My Payment Channel",
"filenameReference": "file ref",
"rate": 9.301444243932576,
"countryCode": "US",
"returnReason": "Some Reason Value",
"withdrawable": true,
"autoWithdrawnReasonCode": "autoWithdrawnReasonCode",
"isPaymentCcyBaseCcy": true,
"sourceAmount": 12345,
"transmissionType": "transmissionType",
"payorName": "payorName",
"sourceAccountName": "My Account",
"paymentChannelId": "123asdf",
"invertedRate": 3.616076749251911,
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"individualIdentificationNumber": "1231231adf",
"accountNumber": "123123232323",
"transmissionTypeRequested": "transmissionTypeRequested",
"remoteId": "aasdf123",
"routingNumber": "123123123123",
"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"
}
},
{
"traceNumber": "abodu123",
"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"
}
},
"paymentScheme": "paymentScheme",
"paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"submittedDateTime": "2000-01-23T04:56:07.000+00:00",
"railsId": "asdf123",
"payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"railsRejectionInformation": "railsRejectionInformation",
"events": [
{
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"accountName": "accountName",
"sourceCurrency": "EUR",
"eventType": "eventType",
"accountNumber": "accountNumber",
"paymentAmount": 1299,
"principal": "principal",
"routingNumber": "routingNumber",
"iban": "iban",
"scheduledFor": "2000-01-23T04:56:07.000+00:00",
"sourceAmount": 1299,
"scheduledBy": "Aphra Behn",
"paymentCurrency": "EUR",
"scheduledAt": "2000-01-23T04:56:07.000+00:00"
},
{
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"accountName": "accountName",
"sourceCurrency": "EUR",
"eventType": "eventType",
"accountNumber": "accountNumber",
"paymentAmount": 1299,
"principal": "principal",
"routingNumber": "routingNumber",
"iban": "iban",
"scheduledFor": "2000-01-23T04:56:07.000+00:00",
"sourceAmount": 1299,
"scheduledBy": "Aphra Behn",
"paymentCurrency": "EUR",
"scheduledAt": "2000-01-23T04:56:07.000+00:00"
}
],
"transactionReference": "transactionReference",
"railsPaymentId": "railsPaymentId",
"payeeAddressCountryCode": "US",
"quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"transactionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"returnCost": 1232,
"withdrawnReason": "withdrawnReason",
"iban": "DE89 3704 0044 0532 0130 00",
"paymentMetadata": "sample metadata",
"payorPaymentId": "123123asdf",
"remoteSystemId": "REMOTE_SYSTEM_ID",
"paymentCurrency": "EUR",
"rejectionReason": "rejectionReason",
"paymentTrackingReference": "paymentTrackingReference",
"status": "status",
"postInstructFxInfo": {
"fxStatus": "INITIATED",
"fxStatusUpdatedAt": "2000-01-23T04:56:07.000+00:00",
"fxTransactionReference": "AB123GHI",
"fxMode": "MANUAL"
},
"accountName": "My Account Name",
"remoteSystemPaymentId": "remoteSystemPaymentId",
"sourceCurrency": "EUR",
"paymentMemo": "Payment memo",
"railsAccountId": "railsAccountId",
"paymentAmount": 7,
"fundingStatus": "fundingStatus",
"railsBatchId": "railsBatchId",
"paymentChannelName": "My Payment Channel",
"filenameReference": "file ref",
"rate": 9.301444243932576,
"countryCode": "US",
"returnReason": "Some Reason Value",
"withdrawable": true,
"autoWithdrawnReasonCode": "autoWithdrawnReasonCode",
"isPaymentCcyBaseCcy": true,
"sourceAmount": 12345,
"transmissionType": "transmissionType",
"payorName": "payorName",
"sourceAccountName": "My Account",
"paymentChannelId": "123asdf",
"invertedRate": 3.616076749251911,
"sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"individualIdentificationNumber": "1231231adf",
"accountNumber": "123123232323",
"transmissionTypeRequested": "transmissionTypeRequested",
"remoteId": "aasdf123",
"routingNumber": "123123123123",
"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"
}
}
]
}