--- title: "Get Payments for Payout" method: GET path: "/v4/paymentaudit/payouts/{payoutId}" tags: ["Payment Audit Service", "Payout History"] --- # Get Payments for Payout `GET /v4/paymentaudit/payouts/{payoutId}` Get List of payments for Payout, allowing for RETURNED status ## Path parameters - `payoutId` string, uuid, required ## Query parameters - `remoteId` string - `status` 'ACCEPTED' | 'AWAITING_FUNDS' | 'FUNDED' | 'UNFUNDED' | 'BANK_PAYMENT_REQUESTED' | 'REJECTED' | 'ACCEPTED_BY_RAILS' | 'CONFIRMED' | 'FAILED' | 'RETURNED' | 'WITHDRAWN' - `sourceAmountFrom` integer - `sourceAmountTo` integer - `paymentAmountFrom` integer - `paymentAmountTo` integer - `submittedDateFrom` string, date - `submittedDateTo` string, date - `page` integer - `pageSize` integer - `sort` string - `sensitive` boolean ## Response `200` 200 response, data found okay - GetPaymentsForPayoutResponseV4 — List Payments for payout - `summary` GetPaymentsForPayoutResponseV4Summary - `payoutStatus` 'ACCEPTED' | 'REJECTED' | 'SUBMITTED' | 'QUOTED' | 'INSTRUCTED' | 'COMPLETED' | 'INCOMPLETE' | 'CONFIRMED' | 'WITHDRAWN' — The current status of the payout. - `submittedDateTime` string, date-time — The date/time at which the payout was submitted. - `instructedDateTime` string, date-time — The date/time at which the payout was instructed. - `withdrawnDateTime` string, date-time - `quotedDateTime` string, date-time — The date/time at which the payout was quoted. - `payoutMemo` string — The memo attached to the payout. - `totalPayments` integer — The count of payments within the payout. - `confirmedPayments` integer — The count of payments within the payout which have been confirmed. - `releasedPayments` integer — The count of payments within the payout which have been released. - `incompletePayments` integer — The count of payments within the payout which are incomplete. - `returnedPayments` integer — The count of payments within the payout which have been returned. - `payoutType` 'STANDARD' | 'AS' | 'ON_BEHALF_OF' — The type of payout. - `submitting` PayoutPayorV4 — Details of payor and principal participating in a payout. - `payorId` string, uuid, required — The id of the payor. - `payorName` string, required — The name of the payor. - `dbaName` string, required — The alternate name of the payor. - `principal` string, required — Email address if principal is a user or ID if application. - `principalId` string, uuid, required — The id of the principal. - `payoutFrom` PayoutPayorV4 — Details of payor and principal participating in a payout. - `payorId` string, uuid, required — The id of the payor. - `payorName` string, required — The name of the payor. - `dbaName` string, required — The alternate name of the payor. - `principal` string, required — Email address if principal is a user or ID if application. - `principalId` string, uuid, required — The id of the principal. - `payoutTo` PayoutPayorV4 — Details of payor and principal participating in a payout. - `payorId` string, uuid, required — The id of the payor. - `payorName` string, required — The name of the payor. - `dbaName` string, required — The alternate name of the payor. - `principal` string, required — Email address if principal is a user or ID if application. - `principalId` string, uuid, required — The id of the principal. - `quoted` PayoutPrincipalV4 — Details of principal participating in a payout. - `principal` string, required — Email address if principal is a user or ID if application. - `principalId` string, uuid, required — The id of the principal. - `instructed` PayoutPrincipalV4 — Details of principal participating in a payout. - `principal` string, required — Email address if principal is a user or ID if application. - `principalId` string, uuid, required — The id of the principal. - `withdrawn` PayoutPrincipalV4 — Details of principal participating in a payout. - `principal` string, required — Email address if principal is a user or ID if application. - `principalId` string, uuid, required — The id of the principal. - `page` PagedPayeeInvitationStatusResponsePage - `numberOfElements` integer - `totalElements` integer - `totalPages` integer - `page` integer - `pageSize` integer - `links` PagedPayeeResponseLinks[] - `rel` string - `href` string - `content` PaymentResponseV4[] - `paymentId` string, uuid, required — The id of the payment - `payeeId` string, uuid, required — The id of the paymeee - `payorId` string, uuid, required — The id of the payor - `payorName` string — The name of the payor - `quoteId` string, uuid, required — The quote Id used for the FX - `sourceAccountId` string, uuid, required — The id of the source account from which the payment was taken - `sourceAccountName` string — The name of the source account from which the payment was taken - `remoteId` string — The remote id by which the payor refers to the payee. Only populated once payment is confirmed - `sourceAmount` integer — The source amount for the payment (amount debited to make the payment) - `sourceCurrency` 'USD' | 'GBP' | 'EUR' — ISO 3 character currency code - `paymentAmount` integer, required — The amount which the payee will receive - `paymentCurrency` 'USD' | 'GBP' | 'EUR' — ISO 3 character currency code - `rate` number, double — The FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed - `invertedRate` number, double — The inverted FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed - `submittedDateTime` string, date-time, required - `status` 'ACCEPTED' | 'AWAITING_FUNDS' | 'FUNDED' | 'UNFUNDED' | 'BANK_PAYMENT_REQUESTED' | 'REJECTED' | 'ACCEPTED_BY_RAILS' | 'CONFIRMED' | 'RETURNED' | 'WITHDRAWN', required - `fundingStatus` 'FUNDED' | 'INSTRUCTED' | 'UNFUNDED', required — The funding status of the payment - `routingNumber` string — The routing number for the payment. - `accountNumber` string — The account number for the account which will receive the payment. - `iban` string — The iban for the payment. - `paymentMemo` string — The payment memo set by the payor - `filenameReference` string — ACH file payment was submitted in, if applicable - `individualIdentificationNumber` string — Individual Identification Number assigned to the payment in the ACH file, if applicable - `traceNumber` string — Trace Number assigned to the payment in the ACH file, if applicable - `payorPaymentId` string - `paymentChannelId` string - `paymentChannelName` string - `accountName` string - `railsId` string, required — The rails ID. Default value is RAILS ID UNAVAILABLE when not populated. - `countryCode` string — The country code of the payment channel. - `events` PaymentEventResponseV4[], required - `eventId` string, uuid, required — The id of the event. - `eventDateTime` string, date-time, required — The date/time at which the event occurred. - `eventType` 'PAYOUT_SUBMITTED' | 'PAYOUT_COMPLETED' | 'PAYOUT_INSTRUCTED_V3' | 'BANK_PAYMENT_REQUESTED' | 'SOURCE_AMOUNT_CONFIRMED' | 'PAYMENT_SUBMITTED' | 'PAYMENT_SUBMITTED_ACCEPTED' | 'PAYMENT_SUBMITTED_REJECTED' | 'PAYMENT_CONFIRMED' | 'PAYMENT_AWAITING_FUNDS' | 'PAYMENT_FUNDED' | 'PAYMENT_UNFUNDED' | 'PAYMENT_FAILED' | 'ACH_SUBMITTED_TO_ODFI' | 'PAYMENT_ACCEPTED_BY_RAILS' | 'ACH_RETURN_RECEIVED' | 'RETURN_PAYMENT_FUNDING_REQUESTED' | 'PAYOUT_BATCH_EXECUTED' | 'PAYOUT_BATCH_QUOTE_EXPIRED' | 'PAYOUT_BATCH_FUNDED' | 'PAYOUT_BATCH_FUNDS_RETURN_REQUEST' | 'PAYOUT_BATCH_FUNDS_RETURNED' | 'PAYOUT_FUNDS_REQUEST' | 'PAYOUT_FUNDS_GRANTED' | 'PAYOUT_FUNDS_DENIED' | 'PAYOUT_BATCH_QUOTED' | 'PAYOUT_QUOTED' | 'ACH_PAYMENT_RETURN_CANCELLED' | 'RETURN_PAYMENT_CANCELLATION_REQUESTED' | 'PAYOUT_WITHDRAWN', required — The type of the event. - `sourceCurrency` 'USD' | 'GBP' | 'EUR' — ISO 3 character currency code - `sourceAmount` integer — The source amount exposed by the event. - `paymentCurrency` 'USD' | 'GBP' | 'EUR' — ISO 3 character currency code - `paymentAmount` integer — The destination amount exposed by the event. - `accountNumber` string — The account number attached to the event. - `routingNumber` string — The routing number attached to the event. - `iban` string - `accountName` string - `principal` string - `returnCost` integer — The return cost if a returned payment. - `returnReason` string - `railsPaymentId` string - `railsBatchId` string - `rejectionReason` string - `payout` PaymentResponseV4Payout - `payoutId` string, uuid - `payoutFrom` PayoutPayorV4 — Details of payor and principal participating in a payout. - `payorId` string, uuid, required — The id of the payor. - `payorName` string, required — The name of the payor. - `dbaName` string, required — The alternate name of the payor. - `principal` string, required — Email address if principal is a user or ID if application. - `principalId` string, uuid, required — The id of the principal. - `payoutTo` PayoutPayorV4 — Details of payor and principal participating in a payout. - `payorId` string, uuid, required — The id of the payor. - `payorName` string, required — The name of the payor. - `dbaName` string, required — The alternate name of the payor. - `principal` string, required — Email address if principal is a user or ID if application. - `principalId` string, uuid, required — The id of the principal. ## Other responses - `400` — Invalid Request Parameter - `401` — Not Authorized - `403` — Forbidden - `404` — Payout Id Not Found ## Changes - **2019-12-11** `a0b19fa311c0` — 3 breaking, 1 info - the response property `content/items/payout/payoutFrom` became optional for the status `200` - the response property `content/items/payout/payoutTo` became optional for the status `200` - the `content/items/payout` response's property type changed from `object` to no type for status `200` - added the optional property `content/items/payout/payoutId` to the response with the `200` status - **2019-12-06** `fbe041e3d325` — 1 breaking, 10 info - the `content/items/payout` response's property type changed from no type to `object` for status `200` - added the non-success response with the status `401` - added the non-success response with the status `403` - added the optional property `content/items/railsBatchId` to the response with the `200` status - …7 more - **2019-10-17** `f27462c28e5f` — 10 info - added the optional property `content/items/payout` to the response with the `200` status - added the optional property `summary/instructed` to the response with the `200` status - added the optional property `summary/payoutFrom` to the response with the `200` status - added the optional property `summary/payoutTo` to the response with the `200` status - …6 more - …earlier changes not shown [Full history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v4/paymentaudit/payouts/:payoutId/get.md) --- [API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/1b2abf26b5d6?raw)