---
api: 'Business API'
---

# Retrieve a list of payout links

Get all the links that you have created, or use the query parameters to filter the results.

The links are sorted by the `created_at` date in reverse chronological order.

The returned links are **paginated**. 
The maximum number of payout links returned per page is specified by the `limit` parameter.
To get to the next page, make a new request and use the `created_at` date of the last payout link returned in the previous response.

:::note
This feature is available in the UK, the EEA, AU, and SG.
:::        

For more information, see the guides: [Send money via payout link](/docs/guides/manage-accounts/transfers/payout-links).

## Endpoint

GET `/payout-links`

## Parameters

### query parameters

- `state` (array of enum, optional)
  Retrieves links in the specified state(s). Possible states are:
  - `created`: The payout link has been created, but the amount has not yet been [blocked](/docs/guides/manage-accounts/transfers/payout-links#sender-link-generation).
  - `failed`: The payout link couldn't be generated due to a failure during transaction booking.
  - `awaiting`: The payout link is awaiting approval.
  - `active`: The payout link can be redeemed.
  - `expired`: The payout link cannot be redeemed because it wasn't claimed before its expiry date.
  - `cancelled`: The payout link cannot be redeemed because it was cancelled.
  - `processing`: The payout link has been redeemed and is being processed.
  - `processed`: The payout link has been redeemed and the money has been transferred to the recipient.
  
  Use for filtering to retrieve only links in specified states.
  To specify multiple values, follow this pattern: `state={VALUE1}&state={VALUE2}`.

- `created_before` (string, optional)
  Retrieves links with `created_at` < `created_before`.
  The default value is the current date and time at which you are calling the endpoint.
  
  Provided in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

- `limit` (integer, optional)
  The maximum number of links returned per page.
  
  To get to the next page, make a new request and use the `created_at` date of the last payout link returned in the previous response as the value for `created_before`.

## Returns

### 200

List of your payout links

#### Response attributes


## Error responses

| HTTP status code | Description |
| --- | --- |
| 403 | Forbidden |