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

# View payouts pending

`GET /payout/v3/pending`

## Request

- Base URL: `https://api.nexiopaysandbox.com`
- URL: `https://api.nexiopaysandbox.com/payout/v3/pending`
- Auth: HTTP basic

Allows merchants to view all payouts to recipients that are in a pending status.

Returns all payouts that meet the specified parameters (if any) and that are associated with the Nexio account used to [authenticate](doc: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](doc:filtering-using-query-parameters).

<!-- theme: info -->
> 📘 Notes
> 
> For 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](doc: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](doc:sandbox-environments).


<div style="display:none;">

## Response parameters
- offset
- limit
- rows
- rows.id
- rows.providerId
- rows.batchRef
- rows.recipientRef
- rows.firstName
- rows.lastName
- rows.email
- rows.currency
- rows.amount
- rows.country

</div>

## Response `200`

OK

- object
  - `offset` Offset (unresolved $ref)
  - `limit` Limit (unresolved $ref)
  - `rows` object
    - `id` Id (unresolved $ref)
    - `providerId` ProviderId (unresolved $ref)
    - `batchRef` BatchRef (unresolved $ref)
    - `recipientRef` RecipientRef (unresolved $ref)
    - `firstName` FirstName (unresolved $ref)
    - `lastName` LastName (unresolved $ref)
    - `email` Email (unresolved $ref)
    - `currency` Currency (unresolved $ref)
    - `amount` Amount (unresolved $ref)
    - `country` Country (unresolved $ref)

## Other responses

- `401`: Unauthorized. For help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payouts-api-reference.md) - [All operations](https://skmtc.dev/nexiopay/apis/payouts-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/nexiopay/apis/payouts-api-reference/revisions/36c088967d63?raw)