Payment Audit Service (Deprecated)

V3 Get List of Payments

Deprecated (use /v4/paymentaudit/payments instead)

get/v3/paymentaudit/payments

Query parameters

payeeIdstring uuid

The UUID of the payee.

payorIdstring uuid

The account owner Payor Id. Required for external users.

payorNamestring

The payor’s name. This filters via a case insensitive substring match.

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

sourceAccountNamestring

The source account name filter. This filters via a case insensitive substring match.

sourceAmountFrominteger

The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom

sourceAmountTointeger

The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo

sourceCurrencystring

The source currency filter. Filters based on an exact match on the currency.

paymentAmountFrominteger

The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom

paymentAmountTointeger

The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo

paymentCurrencystring

The payment currency filter. Filters based on an exact match on the currency.

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.

paymentMemostring

The payment memo filter. This filters via a case insensitive substring match.

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

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 status

      response-optional-property-added

    • removed the ACCEPTED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the ACCEPTED_BY_RAILS enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the ACH_PAYMENT_RETURN_CANCELLED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the ACH_RETURN_RECEIVED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the ACH_SUBMITTED_TO_ODFI enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the AWAITING_FUNDS enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the BANK_PAYMENT_REQUESTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the BANK_PAYMENT_REQUESTED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the CONFIRMED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the EUR enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the EUR enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the EUR enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the EUR enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the FAILED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the FUNDED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the FUNDED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the GBP enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the GBP enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the GBP enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the GBP enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the INSTRUCTED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_ACCEPTED_BY_RAILS enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_AWAITING_FUNDS enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_CONFIRMED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_FAILED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_FUNDED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_SUBMITTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_SUBMITTED_ACCEPTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_SUBMITTED_REJECTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYMENT_UNFUNDED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_BATCH_EXECUTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_BATCH_FUNDED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_BATCH_FUNDS_RETURNED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_BATCH_FUNDS_RETURN_REQUEST enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_BATCH_QUOTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_BATCH_QUOTE_EXPIRED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_COMPLETED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_FUNDS_DENIED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_FUNDS_GRANTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_FUNDS_REQUEST enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_INSTRUCTED_V3 enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_QUOTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_SUBMITTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the PAYOUT_WITHDRAWN enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the REJECTED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the RETURN_PAYMENT_CANCELLATION_REQUESTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the RETURN_PAYMENT_FUNDING_REQUESTED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the SOURCE_AMOUNT_CONFIRMED enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the UNFUNDED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the UNFUNDED enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the USD enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the USD enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the USD enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the USD enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the WITHDRAWN enum value from the // response property for the response status

      response-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 listPaymentsAudit removed and replaced with listPaymentsAuditV3

      api-operation-id-removed

    • api tag Payment Audit Service (Deprecated) added

      api-tag-added

    • api tag Payment Audit Service removed

      api-tag-removed

    This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dd71433847a6318See the full diff
    • the / response's property type changed from no type to object for status

      response-property-type-changed

    • the / response's property type changed from no type to object for status

      response-property-type-changed

    • the / response's property type changed from no type to object for status

      response-property-type-changed

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • aded220b0d7b23See the full diff
    • for the query request parameter pageSize, the max was set to 100.00

      request-parameter-max-set

    • for the query request parameter pageSize, the min was set to 1.00

      request-parameter-min-set

    • added the media type application/json for the response with the status

      response-media-type-added

    • added the media type application/json for the response with the status

      response-media-type-added

    • added the media type application/json for the response with the status

      response-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 status

      response-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 status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • the response's property default value RAILS ID UNAVAILABLE was added for the status

      response-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 from int32 to int64 for status

      response-property-type-changed

    • the //// response's property format changed from int32 to int64 for status

      response-property-type-changed

    • the // response's property format changed from decimal to float for status

      response-property-type-changed

    • the // response's property format changed from decimal to float for status

      response-property-type-changed

  • ced8e167a97c3597See the full diff
    • removed the media type application/json for the response with the status

      response-media-type-removed

    • the // response's property format changed from float to decimal for status

      response-property-type-changed

    • the // response's property format changed from float to decimal for status

      response-property-type-changed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • added the new ACCEPTED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new ACCEPTED_BY_RAILS enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new ACH_PAYMENT_RETURN_CANCELLED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new ACH_RETURN_RECEIVED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new ACH_SUBMITTED_TO_ODFI enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new AWAITING_FUNDS enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new BANK_PAYMENT_REQUESTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BANK_PAYMENT_REQUESTED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new CONFIRMED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new EUR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new EUR enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new EUR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new EUR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new FAILED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new FUNDED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new FUNDED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new GBP enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new GBP enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new GBP enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new GBP enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new INSTRUCTED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_ACCEPTED_BY_RAILS enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_AWAITING_FUNDS enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_CONFIRMED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_FAILED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_FUNDED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_SUBMITTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_SUBMITTED_ACCEPTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_SUBMITTED_REJECTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYMENT_UNFUNDED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_BATCH_EXECUTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_BATCH_FUNDED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_BATCH_FUNDS_RETURNED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_BATCH_FUNDS_RETURN_REQUEST enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_BATCH_QUOTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_BATCH_QUOTE_EXPIRED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_COMPLETED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_FUNDS_DENIED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_FUNDS_GRANTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_FUNDS_REQUEST enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_INSTRUCTED_V3 enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_QUOTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_SUBMITTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PAYOUT_WITHDRAWN enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new REJECTED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new RETURN_PAYMENT_CANCELLATION_REQUESTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new RETURN_PAYMENT_FUNDING_REQUESTED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new SOURCE_AMOUNT_CONFIRMED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new UNFUNDED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new UNFUNDED enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new USD enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new USD enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new USD enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new USD enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new WITHDRAWN enum value to the // response property for the response status

      response-property-enum-value-added

    • api operation id listPaymentsAuditV3 removed and replaced with listPaymentsAudit

      api-operation-id-removed

    • api tag Payment Audit Service added

      api-tag-added

    • api tag Payment Audit Service (Deprecated) removed

      api-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 status

      response-optional-property-added

    • the response's property default value RAILS ID UNAVAILABLE was removed for the status

      response-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