--- title: "V3 Get Payments for Payout" method: GET path: "/v3/paymentaudit/payouts/{payoutId}" tags: ["Payment Audit Service (Deprecated)"] deprecated: true --- # V3 Get Payments for Payout `GET /v3/paymentaudit/payouts/{payoutId}` ## Request - Base URL: `https://api.sandbox.velopayments.com` - URL: `https://api.sandbox.velopayments.com/v3/paymentaudit/payouts/{payoutId}` - Auth: OAuth 2 - Client credentials - Token URL: `https://api.sandbox.velopayments.com/v1/login` > **Deprecated.** Deprecated (use /v4/paymentaudit/payouts/ instead) ## 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 - GetPaymentsForPayoutResponseV3: List Payments for payout - `summary` GetPaymentsForPayoutResponseV3Summary - `payoutStatus` string: The 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: The date/time at which the payout was withdrawn. - `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. - `failedPayments` integer: The count of payments within the payout which have failed or been returned. - `page` GetPaymentsForPayoutResponseV3Page - `numberOfElements` integer - `totalElements` integer - `totalPages` integer - `page` integer - `pageSize` integer - `links` GetPayoutsResponseV3Links[] - `rel` string - `href` string - `content` PaymentResponseV3[] - `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` string: ISO 3 character currency code - `paymentAmount` integer, required: The amount which the payee will receive - `paymentCurrency` string: ISO 3 character currency code - `rate` number, float: 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, float: 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` 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, FAILED, WITHDRAWN - `fundingStatus` string, required: The 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. - `events` PaymentEventResponseV3[], 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: The type of the event. 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, 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 - `sourceCurrency` string: ISO 3 character currency code - `sourceAmount` integer: The source amount exposed by the event. - `paymentCurrency` string: 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 - `paymentScheme` string - `rejectionReason` string ## 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 - **2022-08-10** `1e7a1734a45c`: 65 info - added the optional property `content/items/paymentScheme` to the response with the `200` status - removed the `ACCEPTED` enum value from the `content/items/status` response property for the response status `200` - removed the `ACCEPTED` enum value from the `summary/payoutStatus` response property for the response status `200` - removed the `ACCEPTED_BY_RAILS` enum value from the `content/items/status` response property for the response status `200` - …61 more - **2021-02-03** `5e4369698639`: 3 info - api operation id `getPaymentsForPayout` removed and replaced with `getPaymentsForPayout_PA_V3` - api tag `Payment Audit Service (Deprecated)` added - api tag `Payment Audit Service` removed - **2020-10-30** `dd71433847a6`: 4 breaking, 24 info - the `errors/items/` response's property type changed from no type to `object` for status `400` - the `errors/items/` response's property type changed from no type to `object` for status `401` - the `errors/items/` response's property type changed from no type to `object` for status `403` - the `errors/items/` response's property type changed from no type to `object` for status `404` - …24 more - …earlier changes not shown [Operation history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v3/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)