Countries3

Currencies1

Funding6

Funding Manager Private2

Login4

Payee Invitation8

Payee Payment Channels7

Payees12

Payment Audit Service8

Payment Audit Service (Deprecated)8

Payor Hierarchy1

Payors6

Payors Private1

Payouts9

Source Accounts8

Tokens1

Transactions3

Users16

Webhooks5

Payment Audit Service (Deprecated)

V3 Get Payments for Payout

Changed on Aug 10, 2022

Deprecated (use /v4/paymentaudit/payouts/<payoutId> instead)

get/v3/paymentaudit/payouts/{payoutId}

Request

Base URL
https://api.sandbox.velopayments.com
Auth
OAuth 2
Client credentials
Token URL: https://api.sandbox.velopayments.com/v1/login

Path parameters

payoutIdstring uuid required

The id (UUID) of the payout.

Query parameters

remoteIdstring

The remote id of the payees.

Payment Status

sourceAmountFrominteger

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

sourceAmountTointeger

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

paymentAmountFrominteger

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

paymentAmountTointeger

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

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.

pageinteger

Page number. Default is 1.

pageSizeinteger

The number of results to return in a page

sortstring

<p>List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId</p> <p>The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status</p>

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

200 response, data found okay

Example response

{
  "summary": {
    "incompletePayments": 123,
    "confirmedPayments": 123,
    "releasedPayments": 123,
    "submittedDateTime": "2000-01-23T04:56:07.000+00:00",
    "payoutStatus": "payoutStatus",
    "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
    "totalPayments": 123,
    "instructedDateTime": "2000-01-23T04:56:07.000+00:00",
    "payoutMemo": "Payment Memo value",
    "failedPayments": 0
  },
  "links": [
    {
      "rel": "first",
      "href": "https://example.com"
    },
    {
      "rel": "first",
      "href": "https://example.com"
    }
  ],
  "page": {
    "numberOfElements": 12,
    "totalPages": 10,
    "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

Aug 10, 20221e7a1734a45c Revision changes
- info
  added the optional property // to the response with the status
- info
  removed the ACCEPTED enum value from the // response property for the response status
- info
  removed the ACCEPTED enum value from the / response property for the response status
- info
  removed the ACCEPTED_BY_RAILS enum value from the // response property for the response status
- info
  removed the ACH_PAYMENT_RETURN_CANCELLED enum value from the //// response property for the response status
- info
  removed the ACH_RETURN_RECEIVED enum value from the //// response property for the response status
- info
  removed the ACH_SUBMITTED_TO_ODFI enum value from the //// response property for the response status
- info
  removed the AWAITING_FUNDS enum value from the // response property for the response status
- info
  removed the BANK_PAYMENT_REQUESTED enum value from the //// response property for the response status
- info
  removed the BANK_PAYMENT_REQUESTED enum value from the // response property for the response status
- info
  removed the COMPLETED enum value from the / response property for the response status
- info
  removed the CONFIRMED enum value from the // response property for the response status
- info
  removed the CONFIRMED enum value from the / response property for the response status
- info
  removed the EUR enum value from the //// response property for the response status
- info
  removed the EUR enum value from the //// response property for the response status
- info
  removed the EUR enum value from the // response property for the response status
- info
  removed the EUR enum value from the // response property for the response status
- info
  removed the FAILED enum value from the // response property for the response status
- info
  removed the FUNDED enum value from the // response property for the response status
- info
  removed the FUNDED enum value from the // response property for the response status
- info
  removed the GBP enum value from the //// response property for the response status
- info
  removed the GBP enum value from the //// response property for the response status
- info
  removed the GBP enum value from the // response property for the response status
- info
  removed the GBP enum value from the // response property for the response status
- info
  removed the INCOMPLETE enum value from the / response property for the response status
- info
  removed the INSTRUCTED enum value from the // response property for the response status
- info
  removed the INSTRUCTED enum value from the / response property for the response status
- info
  removed the PAYMENT_ACCEPTED_BY_RAILS enum value from the //// response property for the response status
- info
  removed the PAYMENT_AWAITING_FUNDS enum value from the //// response property for the response status
- info
  removed the PAYMENT_CONFIRMED enum value from the //// response property for the response status
- info
  removed the PAYMENT_FAILED enum value from the //// response property for the response status
- info
  removed the PAYMENT_FUNDED enum value from the //// response property for the response status
- info
  removed the PAYMENT_SUBMITTED enum value from the //// response property for the response status
- info
  removed the PAYMENT_SUBMITTED_ACCEPTED enum value from the //// response property for the response status
- info
  removed the PAYMENT_SUBMITTED_REJECTED enum value from the //// response property for the response status
- info
  removed the PAYMENT_UNFUNDED enum value from the //// response property for the response status
- info
  removed the PAYOUT_BATCH_EXECUTED enum value from the //// response property for the response status
- info
  removed the PAYOUT_BATCH_FUNDED enum value from the //// response property for the response status
- info
  removed the PAYOUT_BATCH_FUNDS_RETURNED enum value from the //// response property for the response status
- info
  removed the PAYOUT_BATCH_FUNDS_RETURN_REQUEST enum value from the //// response property for the response status
- info
  removed the PAYOUT_BATCH_QUOTED enum value from the //// response property for the response status
- info
  removed the PAYOUT_BATCH_QUOTE_EXPIRED enum value from the //// response property for the response status
- info
  removed the PAYOUT_COMPLETED enum value from the //// response property for the response status
- info
  removed the PAYOUT_FUNDS_DENIED enum value from the //// response property for the response status
- info
  removed the PAYOUT_FUNDS_GRANTED enum value from the //// response property for the response status
- info
  removed the PAYOUT_FUNDS_REQUEST enum value from the //// response property for the response status
- info
  removed the PAYOUT_INSTRUCTED_V3 enum value from the //// response property for the response status
- info
  removed the PAYOUT_QUOTED enum value from the //// response property for the response status
- info
  removed the PAYOUT_SUBMITTED enum value from the //// response property for the response status
- info
  removed the PAYOUT_WITHDRAWN enum value from the //// response property for the response status
- info
  removed the QUOTED enum value from the / response property for the response status
- info
  removed the REJECTED enum value from the // response property for the response status
- info
  removed the REJECTED enum value from the / response property for the response status
- info
  removed the RETURN_PAYMENT_CANCELLATION_REQUESTED enum value from the //// response property for the response status
- info
  removed the RETURN_PAYMENT_FUNDING_REQUESTED enum value from the //// response property for the response status
- info
  removed the SOURCE_AMOUNT_CONFIRMED enum value from the //// response property for the response status
- info
  removed the SUBMITTED enum value from the / response property for the response status
- info
  removed the UNFUNDED enum value from the // response property for the response status
- info
  removed the UNFUNDED enum value from the // response property for the response status
- info
  removed the USD enum value from the //// response property for the response status
- info
  removed the USD enum value from the //// response property for the response status
- info
  removed the USD enum value from the // response property for the response status
- info
  removed the USD enum value from the // response property for the response status
- info
  removed the WITHDRAWN enum value from the // response property for the response status
- info
  removed the WITHDRAWN enum value from the / response property for the response status
Feb 3, 20215e4369698639 Revision changes
- info
  api operation id getPaymentsForPayout removed and replaced with getPaymentsForPayout_PA_V3
- info
  api tag Payment Audit Service (Deprecated) added
- info
  api tag Payment Audit Service removed

Operation history (10 revisions)