V3 Get List of Payments
Deprecated (use /v4/paymentaudit/payments instead)
Query parameters
The UUID of the payee.
The account owner Payor Id. Required for external users.
The payor’s name. This filters via a case insensitive substring match.
The remote id of the payees.
Payment Status
The source account name filter. This filters via a case insensitive substring match.
The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
The source currency filter. Filters based on an exact match on the currency.
The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
The payment currency filter. Filters based on an exact match on the currency.
The submitted date from range filter. Format is yyyy-MM-dd.
The submitted date to range filter. Format is yyyy-MM-dd.
The payment memo filter. This filters via a case insensitive substring match.
Page number. Default is 1.
The number of results to return in a page
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
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
Paginated list of payments
Example response
{
"links": [
{
"rel": "first",
"href": "https://example.com"
},
{
"rel": "first",
"href": "https://example.com"
}
],
"page": {
"numberOfElements": 12,
"totalPages": 12,
"pageSize": 25,
"page": 1,
"totalElements": 12
},
"content": [
{
"traceNumber": "abodu123",
"accountName": "My Account Name",
"sourceCurrency": "sourceCurrency",
"paymentMemo": "Payment memo",
"paymentAmount": 0,
"fundingStatus": "fundingStatus",
"railsBatchId": "railsBatchId",
"paymentChannelName": "My Payment Channel",
"paymentScheme": "paymentScheme",
"filenameReference": "file ref",
"rate": 6.0274563,
"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": "Prinicple example",
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"routingNumber": "123123123",
"accountName": "My account",
"iban": "DE89 3704 0044 0532 0130 00",
"sourceCurrency": "sourceCurrency",
"sourceAmount": 1299,
"eventType": "eventType",
"paymentCurrency": "paymentCurrency",
"accountNumber": "123123123",
"paymentAmount": 1299
},
{
"principal": "Prinicple example",
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"routingNumber": "123123123",
"accountName": "My account",
"iban": "DE89 3704 0044 0532 0130 00",
"sourceCurrency": "sourceCurrency",
"sourceAmount": 1299,
"eventType": "eventType",
"paymentCurrency": "paymentCurrency",
"accountNumber": "123123123",
"paymentAmount": 1299
}
],
"payorName": "payorName",
"sourceAccountName": "My Account",
"paymentChannelId": "123asdf",
"invertedRate": 1.4658129,
"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",
"paymentCurrency": "paymentCurrency",
"rejectionReason": "rejectionReason",
"status": "status"
},
{
"traceNumber": "abodu123",
"accountName": "My Account Name",
"sourceCurrency": "sourceCurrency",
"paymentMemo": "Payment memo",
"paymentAmount": 0,
"fundingStatus": "fundingStatus",
"railsBatchId": "railsBatchId",
"paymentChannelName": "My Payment Channel",
"paymentScheme": "paymentScheme",
"filenameReference": "file ref",
"rate": 6.0274563,
"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": "Prinicple example",
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"routingNumber": "123123123",
"accountName": "My account",
"iban": "DE89 3704 0044 0532 0130 00",
"sourceCurrency": "sourceCurrency",
"sourceAmount": 1299,
"eventType": "eventType",
"paymentCurrency": "paymentCurrency",
"accountNumber": "123123123",
"paymentAmount": 1299
},
{
"principal": "Prinicple example",
"eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"eventDateTime": "2000-01-23T04:56:07.000+00:00",
"routingNumber": "123123123",
"accountName": "My account",
"iban": "DE89 3704 0044 0532 0130 00",
"sourceCurrency": "sourceCurrency",
"sourceAmount": 1299,
"eventType": "eventType",
"paymentCurrency": "paymentCurrency",
"accountNumber": "123123123",
"paymentAmount": 1299
}
],
"payorName": "payorName",
"sourceAccountName": "My Account",
"paymentChannelId": "123asdf",
"invertedRate": 1.4658129,
"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",
"paymentCurrency": "paymentCurrency",
"rejectionReason": "rejectionReason",
"status": "status"
}
]
}