--- title: "Get Payout Summary" method: GET path: "/v3/payouts/{payoutId}" tags: ["Payouts"] --- # Get Payout Summary `GET /v3/payouts/{payoutId}` Get payout summary - returns the current state of the payout. ## Path parameters - `payoutId` string, uuid, required ## Response `200` Details of Payout - PayoutSummaryResponseV3 - `payoutId` string, uuid — The id of the payout - `status` string — The status of the payout (one of SUBMITTED, ACCEPTED, REJECTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, WITHDRAWN) - `paymentsSubmitted` integer — The number of payments that were submitted in the payout - `paymentsAccepted` integer — The number of payments that were accepted in the payout - `paymentsRejected` integer — The number of payments that were rejected in the payout - `paymentsWithdrawn` integer, required — The number of payments that were withdrawn in the payout - `fxSummaries` QuoteFxSummaryV3[], required - `rate` number, float, required — The conversion rate (from the source currency to the payment currency) - `invertedRate` number, float — The inverse conversion rate (from paymnent currency to source currency) - `creationTime` string, date-time, required — Timestamp of when the quote was created - `expiryTime` string, date-time — The timestamp for when the quote will expire - `quoteId` string, uuid, required — The id of the created quote - `totalSourceAmount` integer, required — The amount (in minor units) that will be paid from the source account - `totalPaymentAmount` integer, required — The amount (in minor units) that the payee will receive - `sourceCurrency` string, required — Valid ISO 4217 3 letter currency code. See the ISO specification for details. - `paymentCurrency` string, required — Valid ISO 4217 3 letter currency code. See the ISO specification for details. - `fundingStatus` string, required — Current status of the funding associated with this quote. One of the following values: UNFUNDED, INSTRUCTED, FUNDED - `status` string, required — Current status of the fx quote. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED, REJECTED - `accounts` SourceAccountV3[], required - `sourceAccountName` string, required — The name of the source account as referencec in the payout - `sourceAccountId` string, uuid, required — The id of the payout - `currency` string, required — Valid ISO 4217 3 letter currency code. See the ISO specification for details. - `totalPayoutCost` integer, required — The total amount (in mnor units) that will be debited from the source account for the payout - `acceptedPayments` AcceptedPaymentV3[], required - `remoteId` string, required — Your identifier for the payee - `currencyType` string, required — Valid ISO 4217 3 letter currency code. See the ISO specification for details. - `amount` integer, required — The amount of the payment in minor units - `sourceAccountName` string, required — The identifier of the source account to debit the payment from - `payorPaymentId` string, required — A reference identifier for the payor for the given payee payment - `paymentMemo` string —

Any value here will override the memo value in the parent payout

This should be the reference field on the statement seen by the payee (but not via ACH)

- `remoteSystemId` string —

The identifier for the remote payments system if not Velo

- `paymentMetadata` string —

Metadata about the payment that may be relevant to the specific rails or remote system making the payout

The structure of the data will be dictated by the requirements of the payment rails

- `railsId` string, required — Indicates the 3rd party system involved in making this payment - `rejectedPayments` RejectedPaymentV3[], required - `remoteId` string, required — The remoteId supplied by the payor that identifies the payee - `currencyType` string, required — Valid ISO 4217 3 letter currency code. See the ISO specification for details. - `amount` integer, required — The amount of the payment in minor units - `sourceAccountName` string, required — The identifier of the source account to debit the payment from - `payorPaymentId` string, required — A reference identifier for the payor for the given payee payment - `remoteSystemId` string —

The identifier for the remote payments system if not Velo

- `paymentMetadata` string —

Metadata about the payment that may be relevant to the specific rails or remote system making the payout

The structure of the data will be dictated by the requirements of the payment rails

- `reason` string, required — The reason for the payment being rejected - `reasonCode` string — The reason code as determined by Velo - `lineNumber` integer — If the payment was submitted in a csv payout then this will be the line number of the payment in the file - `message` string — A more general rejection message than the reason property - `schedule` PayoutScheduleV3 — Details relating to a payout that was executed via a schedule or is still waiting to be executed - `scheduleStatus` string, required — The 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 ## Other responses - `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 --- [API](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/revisions/05c3f09fc50a/schema)