---
title: "View payouts"
method: GET
path: "/payout/v3"
tags: ["Payouts"]
---

# View payouts

`GET /payout/v3`

Returns all payouts that meet the specified parameters (if any) and that are associated with the Nexio account used to [authenticate](https://docs.nexiopay.com/docs/authentication).

This is the only endpoint where you can use `payoutRef` in the request to view a specific payout based on that value.

You may also request to return additional parameters and/or filter results using one or more [query parameters](https://docs.nexiopay.com/docs/filtering-using-query-parameters).

<!-- theme: info -->
> 📘 Notes
> 
> By way of example, to return (filter) all payouts where the currency is EUR and also (request to include) the `recipientIdNumbers` object in the response, the request would look like this:
> <code>/payout/v3?recipientIdNumbers.&currency=EUR</code><br/><br/>To return (filter) only the payout with the specified `payoutRef` parameter, the request would look like this:
> <code>/payout/v3?payoutRef=dfbb8efc-6e85-4973-8f2e-69baf8624ae6</code><br/><br/>For a more detailed tutorial, see the [query parameters](https://docs.nexiopay.com/docs/filtering-using-query-parameters) section of Guides.

<!-- 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).


<div style="display:none;">

## Request parameters
- addressLine1
- addressLine2
- addressType
- amount
- batchRef
- birthDate
- city
- country
- countryOfBirth
- countryOfNationality
- currency
- description
- email
- endDate
- firstName
- gender
- governmentIdType
- id
- limit
- mobileNumberCountry
- offset
- payoutAccountId
- payoutProviderAdditionalRef
- payoutProviderRef
- payoutRef
- payoutStatus
- phoneNumber
- phoneNumberCountry
- postalCode
- providerId
- providerRecipientRef
- providerResponse
- providerType
- recipientId
- recipientIdNumbers
- recipientIdNumbers.governmentId
- recipientIdNumbers.passportId
- recipientIdNumbers.employerId
- recipientIdNumbers.driversLicenseId
- recipientRef
- region
- startDate
- transferStatus
- updatedAt
- userType
- createdAt
- lastName
- mobileNumber
- payoutDate

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

</div>

## Query parameters

- `limit` integer
- `offset` integer
- `startDate` string
- `endDate` string
- `id` integer
- `payoutStatus` '10' | '20' | '90'
- `transferStatus` 10 | 20 | 90
- `recipientRef` string
- `providerRecipientRef` string
- `batchRef` string
- `amount` number
- `currency` string
- `description` string
- `payoutDate` string
- `payoutRef` string
- `payoutProviderRef` string
- `payoutProviderAdditionalRef` string
- `email` string
- `firstName` string
- `lastName` string
- `phoneNumber` string
- `mobileNumber` string
- `addressLine1` string
- `addressLine2` string
- `city` string
- `region` string
- `postalCode` string
- `country` string
- `countryOfBirth` string
- `countryOfNationality` string
- `providerResponse` string
- `recipientId` integer
- `providerId` integer
- `payoutAccountId` integer
- `providerType` 10 | 20 | 30 | 40
- `userType` 'BUSINESS' | 'INDIVIDUAL'
- `birthDate` string
- `gender` 'FEMALE' | 'MALE'
- `addressType` 'BUSINESS' | 'RESIDENTIAL'
- `phoneNumberCountry` string
- `mobileNumberCountry` string
- `governmentIdType` string
- `recipientIdNumbers.` string
- `recipientIdNumbers.governmentId` string
- `recipientIdNumbers.passportId` string
- `recipientIdNumbers.driversLicenseId` string
- `recipientIdNumbers.employerId` string
- `createdAt` string
- `updatedAt` string

## Response `200`

OK

- object
  - `offset` integer — The offset indicates how many payout records were skipped before beginning to return payouts in a response. If both `offset` and `limit` were used together, the offset payouts were skipped before starting to count the payouts to limit.
  - `limit` integer — The maximum number of payout records returned in a response (starting from the default or specified `offset` query parameter).
  - `rows` Schema[] — The `rows` array contains one or more sets of payout and recipient parameters. — unresolved $ref
  - `hasMore` boolean — Will be `true` if there are more records not included in the current paged response

## 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)