---
title: "View a payout"
method: GET
path: "/payout/v3/{payoutId}"
tags: ["Payouts"]
---

# View a payout

`GET /payout/v3/{payoutId}`

Searches for payouts with the given `payoutId`.

<!-- theme: info -->
> 📘 Note
> 
> The `payoutId` parameter is not the same as the `payoutRef`, `payoutProviderRef`, or `payoutProviderAdditionalRef`. To view a payout using one of these other reference values, use the [View payouts](https://docs.nexiopay.com/reference/viewpayouts) endpoint.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).<br/><br/>Include the payout ID in the path parameter of the request.


<div style="display:none;">

## Request parameters
- payoutId

## Response parameters
- batchRef
- id
- recipientRef
- recipientId
- payoutAccountId
- payoutRef
- providerId
- providerType
- payoutProviderRef
- payoutProviderAdditionalRef
- providerRecipientRef
- amount
- currency
- description
- payoutDate
- transferStatus
- payoutStatus
- providerResponse
- firstName
- lastName
- addressLine1
- addressLine2
- city
- region
- postalCode
- country
- email
- phoneNumber
- mobileNumber
- createdAt
- updatedAt

</div>

## Response `200`

OK

- object — Payout and recipient parameters.
  - `batchRef` BatchRef — unresolved $ref
  - `id` Id — unresolved $ref
  - `recipientRef` RecipientRef — unresolved $ref
  - `recipientId` RecipientId — unresolved $ref
  - `payoutAccountId` PayoutAccountId — unresolved $ref
  - `payoutRef` PayoutRef — unresolved $ref
  - `providerId` ProviderId — unresolved $ref
  - `providerType` ProviderType — unresolved $ref
  - `payoutProviderRef` string — Reference value for the payout from the payout provider.
  - `payoutProviderAdditionalRef` string — Additional reference value for the payout that may be provided by the payout provider.
  - `providerRecipientRef` ProviderRecipientRef — unresolved $ref
  - `amount` Amount — unresolved $ref
  - `currency` Currency — unresolved $ref
  - `description` string — Payer's description information for the payout to the specified recipient.
  - `payoutDate` string, date — The date the payout request was sent to the provider, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `transferStatus` 10 | 20 | 90 — The status of the transfer, returned as an integer. For information about possible values, see the [transferStatus](https://docs.nexiopay.com/docs/constant-payouts-values#transfer-status-transferstatus) table.
  - `payoutStatus` 10 | 11 | 12 | 20 | 30 | 40 | 50 | 90 — The status of the payout, returned as an integer. For more information about possible values, see the [payoutStatus](https://docs.nexiopay.com/docs/constant-payouts-values#payout-status-payoutstatus) table.
  - `providerResponse` string — Error message from the provider in case of a failed payout.
  - `firstName` FirstName — unresolved $ref
  - `lastName` LastName — unresolved $ref
  - `addressLine1` AddressLine1 — unresolved $ref
  - `addressLine2` AddressLine2 — unresolved $ref
  - `city` City — unresolved $ref
  - `region` Region — unresolved $ref
  - `postalCode` PostalCode — unresolved $ref
  - `country` Country — unresolved $ref
  - `email` Email — unresolved $ref
  - `phoneNumber` PhoneNumber — unresolved $ref
  - `mobileNumber` MobileNumber — unresolved $ref
  - `createdAt` CreatedAt — unresolved $ref
  - `updatedAt` UpdatedAt — unresolved $ref

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)