Payment Audit Service

Get Payouts for Payor

Get List of payouts for payor

get/v4/paymentaudit/payouts

Query parameters

payorIdstring uuid

The id (UUID) of the payor funding the payout or the payor whose payees are being paid.

payoutMemostring

Payout Memo filter - case insensitive sub-string match

Payout Status

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.

fromPayorNamestring

The name of the payor whose payees are being paid. This filters via a case insensitive substring match.

scheduledForDateFromstring date

Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.

scheduledForDateTostring date

Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.

scheduleStatus'ANY' | 'SCHEDULED' | 'EXECUTED' | 'FAILED'

Payout Schedule Status

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,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId, scheduledFor

Response

Payor data found

Example response

{
  "links": [
    {
      "rel": "rel",
      "href": "href"
    },
    {
      "rel": "rel",
      "href": "href"
    }
  ],
  "page": {
    "numberOfElements": 0,
    "totalPages": 1,
    "pageSize": 5,
    "page": 5,
    "totalElements": 6
  },
  "content": [
    {
      "dateTime": "2000-01-23T04:56:07.000+00:00",
      "sourceAccountSummary": [
        {
          "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "currency": "EUR",
          "totalCost": 3344
        },
        {
          "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "currency": "EUR",
          "totalCost": 3344
        }
      ],
      "payoutType": "payoutType",
      "totalReturnedPayments": 1,
      "fxSummaries": [
        {
          "invertedRate": 123.23,
          "rate": 123.23,
          "sourceCurrency": "EUR",
          "totalPaymentAmount": 34235,
          "paymentCurrency": "EUR",
          "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 5,
          "fundingStatus": "fundingStatus",
          "creationDateTime": "2000-01-23T04:56:07.000+00:00",
          "status": "status"
        },
        {
          "invertedRate": 123.23,
          "rate": 123.23,
          "sourceCurrency": "EUR",
          "totalPaymentAmount": 34235,
          "paymentCurrency": "EUR",
          "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 5,
          "fundingStatus": "fundingStatus",
          "creationDateTime": "2000-01-23T04:56:07.000+00:00",
          "status": "status"
        }
      ],
      "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalPayments": 0,
      "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"
      },
      "submittedDateTime": "submittedDateTime",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalIncompletePayments": 6,
      "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
      "totalWithdrawnPayments": 5,
      "instructedDateTime": "instructedDateTime",
      "status": "status",
      "payoutMemo": "payoutMemo",
      "payorName": "payorName"
    },
    {
      "dateTime": "2000-01-23T04:56:07.000+00:00",
      "sourceAccountSummary": [
        {
          "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "currency": "EUR",
          "totalCost": 3344
        },
        {
          "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "currency": "EUR",
          "totalCost": 3344
        }
      ],
      "payoutType": "payoutType",
      "totalReturnedPayments": 1,
      "fxSummaries": [
        {
          "invertedRate": 123.23,
          "rate": 123.23,
          "sourceCurrency": "EUR",
          "totalPaymentAmount": 34235,
          "paymentCurrency": "EUR",
          "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 5,
          "fundingStatus": "fundingStatus",
          "creationDateTime": "2000-01-23T04:56:07.000+00:00",
          "status": "status"
        },
        {
          "invertedRate": 123.23,
          "rate": 123.23,
          "sourceCurrency": "EUR",
          "totalPaymentAmount": 34235,
          "paymentCurrency": "EUR",
          "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 5,
          "fundingStatus": "fundingStatus",
          "creationDateTime": "2000-01-23T04:56:07.000+00:00",
          "status": "status"
        }
      ],
      "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalPayments": 0,
      "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"
      },
      "submittedDateTime": "submittedDateTime",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalIncompletePayments": 6,
      "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
      "totalWithdrawnPayments": 5,
      "instructedDateTime": "instructedDateTime",
      "status": "status",
      "payoutMemo": "payoutMemo",
      "payorName": "payorName"
    }
  ]
}

Changes

Changed in 10 of the 50 revisions of this API.113577

Jun 27, 20221e7a1734a45c31See the full diff
- ○
  removed the ACCEPTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the AS enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the COMPLETED 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 EXECUTED enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the EXECUTED enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the EXPIRED 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 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 INCOMPLETE 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 INSTRUCTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the ON_BEHALF_OF enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the QUOTED enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the QUOTED 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 SCHEDULED enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the STANDARD enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the SUBMITTED 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 UNQUOTED 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
Nov 3, 2021f3f98769e28f4See the full diff
- ○
  added the new optional query request parameter scheduleStatus
  new-optional-request-parameter
- ○
  added the new optional query request parameter scheduledForDateFrom
  new-optional-request-parameter
- ○
  added the new optional query request parameter scheduledForDateTo
  new-optional-request-parameter
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Sep 25, 2020dd71433847a6424See 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
- ▲
  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
- ○
  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/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
- ○
  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
Jun 24, 2020aded220b0d7b24See 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
- ○
  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
Mar 19, 202010644a139f811See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Dec 11, 2019a0b19fa311c014See the full diff
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ○
  added the new optional query request parameter fromPayorName
  new-optional-request-parameter
- ○
  the query request parameter payorId became optional
  request-parameter-became-optional
- ○
  response property content/items/payorId reactivated
  response-property-reactivated
- ○
  added the required property // to the response with the status
  response-required-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 6, 2019fbe041e3d32512See the full diff
- ●
  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
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 17, 2019f27462c28e5f2See the full diff
- ○
  response property content/items/payorId deprecated
  response-property-deprecated
- ○
  added the required property // to the response with the status
  response-required-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 25, 20196febece3adc11See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jul 15, 2019ced8e167a97c6324See the full diff
- ▲
  the query request parameter payorId became required
  request-parameter-became-required
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  the //// response's property type changed from integer to number, and format from int64 to int32 for status
  response-property-type-changed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ●
  deleted the query request parameter fromPayorName
  request-parameter-removed
- ●
  deleted the query request parameter scheduleStatus
  request-parameter-removed
- ●
  deleted the query request parameter scheduledForDateFrom
  request-parameter-removed
- ●
  deleted the query request parameter scheduledForDateTo
  request-parameter-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 COMPLETED 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 EXECUTED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new EXPIRED 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 INCOMPLETE 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 INSTRUCTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new QUOTED enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new QUOTED 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 SUBMITTED 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 UNQUOTED 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
- ○
  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 property // became required for the status
  response-property-became-required
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history