Get List of Payments
Get payments for the given payor Id
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.
The id of the remote system that is orchestrating payments
Payment Status
Transmission Type
- ACH
- SAME_DAY_ACH
- WIRE
- GACHO
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.
Payor's Id of the Payment
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.
Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
Payout Schedule Status
The status of the post instruct FX step if one was required for the payment
Query for all payments associated with a specific transaction reference
Query for all payments associated with a specific transaction id
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 submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
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",
"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"
}
}
]
}Changes
Changed in 16 of the 50 revisions of this API.1597128
- ○
added the new optional
queryrequest parameterpayorPaymentIdnew-optional-request-parameter
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the new optional
queryrequest parametertransactionIdnew-optional-request-parameter
- ○
added the new optional
queryrequest parametertransactionReferencenew-optional-request-parameter
- ○
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
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the new optional
queryrequest parameterpostInstructFxStatusnew-optional-request-parameter
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
- ○
added the new enum value
GACHOto thequeryrequest parametertransmissionTyperequest-parameter-enum-value-added
- ○
- ○
added the new optional
queryrequest parameterrailsIdnew-optional-request-parameter
- ○
added the new enum value
LOCALto thequeryrequest parametertransmissionTyperequest-parameter-enum-value-added
- ○
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
EXECUTEDenum 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
ORCHESTRATED_PAYMENT_BATCH_CONFIRMEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ORCHESTRATED_PAYMENT_BATCH_REQUESTEDenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ORCHESTRATED_PAYMENT_REQUESTEDenum 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
RETURNEDenum 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
SCHEDULEDenum 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
- ○
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
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
This revision also has 76 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the new optional
queryrequest parameterscheduleStatusnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterscheduledForDateFromnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterscheduledForDateTonew-optional-request-parameter
- ○
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 new
ORCHESTRATED_PAYMENT_BATCH_CONFIRMEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
ORCHESTRATED_PAYMENT_BATCH_REQUESTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
ORCHESTRATED_PAYMENT_REQUESTEDenum value to the////response property for the response statusresponse-property-enum-value-added
- ○
added the new optional
queryrequest parameterremoteSystemIdnew-optional-request-parameter
- ○
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
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 new optional
queryrequest parametertransmissionTypenew-optional-request-parameter
- ○
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
- ○
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
- ▲