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"
}
]
}Changes
Changed in 7 of the 50 revisions of this API.106293
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
removed the
ACCEPTEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ACCEPTED_BY_RAILSenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ACH_PAYMENT_RETURN_CANCELLEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ACH_RETURN_RECEIVEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ACH_SUBMITTED_TO_ODFIenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
AWAITING_FUNDSenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
BANK_PAYMENT_REQUESTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
BANK_PAYMENT_REQUESTEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
CONFIRMEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
EURenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
EURenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
EURenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
EURenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
FAILEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
FUNDEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
FUNDEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
GBPenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
GBPenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
GBPenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
GBPenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
INSTRUCTEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_ACCEPTED_BY_RAILSenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_AWAITING_FUNDSenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_CONFIRMEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_FAILEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_FUNDEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_SUBMITTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_SUBMITTED_ACCEPTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_SUBMITTED_REJECTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYMENT_UNFUNDEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_BATCH_EXECUTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_BATCH_FUNDEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_BATCH_FUNDS_RETURNEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_BATCH_FUNDS_RETURN_REQUESTenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_BATCH_QUOTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_BATCH_QUOTE_EXPIREDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_COMPLETEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_FUNDS_DENIEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_FUNDS_GRANTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_FUNDS_REQUESTenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_INSTRUCTED_V3enum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_QUOTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_SUBMITTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
PAYOUT_WITHDRAWNenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
REJECTEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
RETURN_PAYMENT_CANCELLATION_REQUESTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
RETURN_PAYMENT_FUNDING_REQUESTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
SOURCE_AMOUNT_CONFIRMEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
UNFUNDEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
UNFUNDEDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
USDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
USDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
USDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
USDenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
WITHDRAWNenum value from the//response property for the response statusresponse-property-enum-value-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
api operation id
listPaymentsAuditremoved and replaced withlistPaymentsAuditV3api-operation-id-removed
- ○
api tag
Payment Audit Service (Deprecated)addedapi-tag-added
- ○
api tag
Payment Audit Serviceremovedapi-tag-removed
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ▲
the
/response's property type changed from no type toobjectfor statusresponse-property-type-changed
- ▲
the
/response's property type changed from no type toobjectfor statusresponse-property-type-changed
- ▲
the
/response's property type changed from no type toobjectfor statusresponse-property-type-changed
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
response property
errors/items/locationTypedeprecatedresponse-property-deprecated
- ○
response property
errors/items/locationTypedeprecatedresponse-property-deprecated
- ○
response property
errors/items/locationTypedeprecatedresponse-property-deprecated
- ○
response property
errors/items/reasonCodedeprecatedresponse-property-deprecated
- ○
response property
errors/items/reasonCodedeprecatedresponse-property-deprecated
- ○
response property
errors/items/reasonCodedeprecatedresponse-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ●
for the
queryrequest parameterpageSize, the max was set to100.00request-parameter-max-set
- ●
for the
queryrequest parameterpageSize, the min was set to1.00request-parameter-min-set
- ○
added the media type
application/jsonfor the response with the statusresponse-media-type-added
- ○
added the media type
application/jsonfor the response with the statusresponse-media-type-added
- ○
added the media type
application/jsonfor the response with the statusresponse-media-type-added
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
removed the optional property
from the response with the statusresponse-optional-property-removed
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
the
response's property default valueRAILS ID UNAVAILABLEwas added for the statusresponse-property-default-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
the
////response's property format changed fromint32toint64for statusresponse-property-type-changed
- ▲
the
////response's property format changed fromint32toint64for statusresponse-property-type-changed
- ▲
the
//response's property format changed fromdecimaltofloatfor statusresponse-property-type-changed
- ▲
the
//response's property format changed fromdecimaltofloatfor statusresponse-property-type-changed
- ▲
- ▲
removed the media type
application/jsonfor the response with the statusresponse-media-type-removed
- ▲
the
//response's property format changed fromfloattodecimalfor statusresponse-property-type-changed
- ▲
the
//response's property format changed fromfloattodecimalfor statusresponse-property-type-changed
- ●
removed the optional property
//from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
//from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
//from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
//from the response with the statusresponse-optional-property-removed
- ●
added the new
ACCEPTEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
ACCEPTED_BY_RAILSenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
ACH_PAYMENT_RETURN_CANCELLEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
ACH_RETURN_RECEIVEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
ACH_SUBMITTED_TO_ODFIenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
AWAITING_FUNDSenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
BANK_PAYMENT_REQUESTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
BANK_PAYMENT_REQUESTEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
CONFIRMEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
EURenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
EURenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
EURenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
EURenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
FAILEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
FUNDEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
FUNDEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
GBPenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
GBPenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
GBPenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
GBPenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
INSTRUCTEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_ACCEPTED_BY_RAILSenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_AWAITING_FUNDSenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_CONFIRMEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_FAILEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_FUNDEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_SUBMITTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_SUBMITTED_ACCEPTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_SUBMITTED_REJECTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYMENT_UNFUNDEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_BATCH_EXECUTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_BATCH_FUNDEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_BATCH_FUNDS_RETURNEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_BATCH_FUNDS_RETURN_REQUESTenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_BATCH_QUOTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_BATCH_QUOTE_EXPIREDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_COMPLETEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_FUNDS_DENIEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_FUNDS_GRANTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_FUNDS_REQUESTenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_INSTRUCTED_V3enum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_QUOTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_SUBMITTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
PAYOUT_WITHDRAWNenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
REJECTEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
RETURN_PAYMENT_CANCELLATION_REQUESTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
RETURN_PAYMENT_FUNDING_REQUESTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
SOURCE_AMOUNT_CONFIRMEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
UNFUNDEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
UNFUNDEDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
USDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
USDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
USDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
USDenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
WITHDRAWNenum value to the//response property for the response statusresponse-property-enum-value-added
- ○
api operation id
listPaymentsAuditV3removed and replaced withlistPaymentsAuditapi-operation-id-removed
- ○
api tag
Payment Audit Serviceaddedapi-tag-added
- ○
api tag
Payment Audit Service (Deprecated)removedapi-tag-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
the
response's property default valueRAILS ID UNAVAILABLEwas removed for the statusresponse-property-default-value-removed
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲