--- title: "Get Payments for Payout" method: GET path: "/v4/paymentaudit/payouts/{payoutId}" tags: ["Payment Audit Service"] --- # Get Payments for Payout `GET /v4/paymentaudit/payouts/{payoutId}` ## Request - Base URL: `https://api.sandbox.velopayments.com` - URL: `https://api.sandbox.velopayments.com/v4/paymentaudit/payouts/{payoutId}` - Auth: OAuth 2 - Client credentials - Token URL: `https://api.sandbox.velopayments.com/v1/login` Get List of payments for Payout, allowing for RETURNED status ## Path parameters - `payoutId` string, uuid, required ## Query parameters - `railsId` string - `remoteId` string - `remoteSystemId` 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 - `transmissionType` 'ACH' | 'SAME_DAY_ACH' | 'WIRE' | 'LOCAL' | 'GACHO' - `page` integer - `pageSize` integer - `sort` string - `sensitive` boolean ## Response `200` 200 response, data found okay - GetPaymentsForPayoutResponseV4: List Payments for payout - `summary` GetPaymentsForPayoutResponseV4Summary - `payoutStatus` string: Current status of the Payout. One of the following values: ACCEPTED, REJECTED, SUBMITTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, CONFIRMED, WITHDRAWN - `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. - `withdrawnPayments` integer: The count of payments within the payout which have been withdrawn. - `payoutType` string: The type of payout. One of the following values: STANDARD, AS, ON_BEHALF_OF - `submitting` PayoutPayor: 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` PayoutPayor: 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` PayoutPayor: 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` PayoutPrincipal: 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` PayoutPrincipal: 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` PayoutPrincipal: 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. - `schedule` PayoutSchedule: Details relating to a payout that was executed via a schedule or is still waiting to be executed - `scheduleStatus` string, required: Current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED - `scheduledAt` string, date-time, required - `scheduledFor` string, date-time, required - `scheduledByPrincipalId` string, required: ID of the user or application that scheduled the payout - `notificationsEnabled` boolean, required - `scheduledBy` string: Optional display name as a hint for who scheduled the payout. Not populated if payout was scheduled by an application. - `page` PagedPayeeInvitationStatusResponseV3Page - `numberOfElements` integer - `totalElements` integer - `totalPages` integer - `page` integer - `pageSize` integer - `links` PagedPayeeResponseV3Links[] - `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 - `remoteSystemId` string: The velo id of the remote system orchestrating the payment. Not populated for normal Velo payments. - `remoteSystemPaymentId` string: The id of the payment in the remote system. Not populated for normal Velo payments. - `sourceAmount` integer: The source amount for the payment (amount debited to make the payment) - `sourceCurrency` string: ISO-4217 3 character currency code - `paymentAmount` integer, required: The amount which the payee will receive - `paymentCurrency` string: ISO-4217 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 - `isPaymentCcyBaseCcy` boolean - `submittedDateTime` string, date-time, required - `status` string, required: Current status of the payment. One of the following values: ACCEPTED, AWAITING_FUNDS, FUNDED, UNFUNDED, BANK_PAYMENT_REQUESTED, REJECTED, ACCEPTED_BY_RAILS, CONFIRMED, RETURNED, WITHDRAWN - `fundingStatus` string, required: Current funding status of the payment. One of the following values: FUNDED, INSTRUCTED, UNFUNDED - `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. - `payeeAddressCountryCode` string: The country code of the payee's address. - `events` PaymentEventResponse[], required - `eventId` string, uuid, required: The id of the event. - `eventDateTime` string, date-time, required: The date/time at which the event occurred. - `eventType` string, required: One of the following values: 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, PAYMENT_TRACKING_DETAILS_UPDATED, 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, ORCHESTRATED_PAYMENT_BATCH_REQUESTED, ORCHESTRATED_PAYMENT_BATCH_CONFIRMED, ORCHESTRATED_PAYMENT_REQUESTED - `sourceCurrency` string: ISO-4217 3 character currency code - `sourceAmount` integer: The source amount exposed by the event. - `paymentCurrency` string: ISO-4217 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 - `scheduledAt` string, date-time - `scheduledFor` string, date-time - `scheduledBy` string: Optional display name as a hint for who scheduled the payout. Not populated if payout was scheduled by an application. - `returnCost` integer: The return cost if a returned payment. - `returnReason` string - `railsPaymentId` string - `railsBatchId` string - `railsAccountId` string - `paymentScheme` string - `rejectionReason` string - `railsRejectionInformation` string: The original reason that the payment was rejected. This can be third party rails specific if rejected by the underlying third party rails logic. - `withdrawnReason` string - `withdrawable` boolean - `autoWithdrawnReasonCode` string: Populated with rejection reason code if the payment was withdrawn automatically at instruct time - `transmissionType` string: The transmission type of the payment, e.g. ACH, SAME_DAY_ACH, WIRE, GACHO - `transmissionTypeRequested` string: The transmission type of the payment requested by the payor - `paymentTrackingReference` string - `paymentMetadata` string: Metadata for the payment - `transactionId` string, uuid - `transactionReference` string - `schedule` PayoutSchedule: Details relating to a payout that was executed via a schedule or is still waiting to be executed - `scheduleStatus` string, required: Current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED - `scheduledAt` string, date-time, required - `scheduledFor` string, date-time, required - `scheduledByPrincipalId` string, required: ID of the user or application that scheduled the payout - `notificationsEnabled` boolean, required - `scheduledBy` string: Optional display name as a hint for who scheduled the payout. Not populated if payout was scheduled by an application. - `postInstructFxInfo` PostInstructFxInfo: FX details relating to a payout that was executed or is still waiting to be executed - `fxMode` string, required: The mode by which the FX rate is to be determined (MANUAL or AUTO) - `fxStatus` string, required: The state to which the Post-Instruct FX process has reached (INITIATED or COMPLETED) - `fxStatusUpdatedAt` string, date-time, required: The date-time at which the most recent fxStatus was determined. - `fxTransactionReference` string: The reference assigned to the FX funding that will fulfil this payment. - `payout` PaymentResponseV4Payout - `payoutId` string, uuid - `payoutFrom` PayoutPayor: 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` PayoutPayor: 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. See Error message payload for details of failure - `401`: Invalid access token. May be expired or invalid - `403`: The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions - `404`: The resource was not found or is no longer available ## Changes - **2026-07-13** `05c3f09fc50a`: 1 info - added the optional property `content/items/transmissionTypeRequested` to the response with the `200` status - **2023-10-10** `b924ba134e09`: 4 info - added the optional property `content/items/railsAccountId` to the response with the `200` status - added the optional property `content/items/railsRejectionInformation` to the response with the `200` status - added the optional property `content/items/transactionId` to the response with the `200` status - added the optional property `content/items/transactionReference` to the response with the `200` status - **2023-03-06** `c9570437d66c`: 1 info - added the new optional `query` request parameter `railsId` - **2022-12-02** `3149678b757e`: 1 info - added the optional property `content/items/postInstructFxInfo` to the response with the `200` status - **2022-10-03** `a733cc8527b9`: 1 info - added the new enum value `GACHO` to the `query` request parameter `transmissionType` [Operation 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/05c3f09fc50a?raw)