Sign in
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

status'ACCEPTED' | 'REJECTED' | 'SUBMITTED' | 'QUOTED' | 'INSTRUCTED' | 'COMPLETED' | 'INCOMPLETE' | 'CONFIRMED' | 'WITHDRAWN'

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.

pageinteger

Page number. Default is 1.

pageSizeinteger

Page size. Default is 25. Max allowable is 100.

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

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",
          "totalCost": 3344
        },
        {
          "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 3344
        }
      ],
      "totalReturnedPayments": 1,
      "fxSummaries": [
        {
          "invertedRate": 123.23,
          "rate": 123.23,
          "totalPaymentAmount": 34235,
          "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 5,
          "fundingStatus": "FUNDED",
          "creationDateTime": "2000-01-23T04:56:07.000+00:00",
          "status": "UNQUOTED"
        },
        {
          "invertedRate": 123.23,
          "rate": 123.23,
          "totalPaymentAmount": 34235,
          "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 5,
          "fundingStatus": "FUNDED",
          "creationDateTime": "2000-01-23T04:56:07.000+00:00",
          "status": "UNQUOTED"
        }
      ],
      "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalPayments": 0,
      "submittedDateTime": "submittedDateTime",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalIncompletePayments": 6,
      "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
      "instructedDateTime": "instructedDateTime",
      "payoutMemo": "payoutMemo",
      "payorName": "payorName"
    },
    {
      "dateTime": "2000-01-23T04:56:07.000+00:00",
      "sourceAccountSummary": [
        {
          "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 3344
        },
        {
          "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 3344
        }
      ],
      "totalReturnedPayments": 1,
      "fxSummaries": [
        {
          "invertedRate": 123.23,
          "rate": 123.23,
          "totalPaymentAmount": 34235,
          "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 5,
          "fundingStatus": "FUNDED",
          "creationDateTime": "2000-01-23T04:56:07.000+00:00",
          "status": "UNQUOTED"
        },
        {
          "invertedRate": 123.23,
          "rate": 123.23,
          "totalPaymentAmount": 34235,
          "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "totalCost": 5,
          "fundingStatus": "FUNDED",
          "creationDateTime": "2000-01-23T04:56:07.000+00:00",
          "status": "UNQUOTED"
        }
      ],
      "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalPayments": 0,
      "submittedDateTime": "submittedDateTime",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "totalIncompletePayments": 6,
      "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
      "instructedDateTime": "instructedDateTime",
      "payoutMemo": "payoutMemo",
      "payorName": "payorName"
    }
  ]
}

Changes