--- title: "Retrieve a list of payout links" method: GET path: "/payout-links" tags: ["Payout links"] --- # Retrieve a list of payout links `GET /payout-links` ## Request - Base URL: `https://b2b.revolut.com/api/1.0` - URL: `https://b2b.revolut.com/api/1.0/payout-links` - Auth: HTTP bearer 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](https://developer.revolut.com/docs/guides/manage-accounts/transfers/payout-links). ## Query parameters - `state` PayoutLinkState[] - `created_before` string, date-time - `limit` integer ## Response `200` List of your payout links - PayoutLink[]: A list of payout links - `id` string, uuid, required: The ID of the payout link. - `state` 'created' | 'failed' | 'awaiting' | 'active' | 'expired' | 'cancelled' | 'processing' | 'processed', required: The state that the payout link is in. Possible states are: | Value | Description | | --- | --- | | **`created`** | The payout link has been created, but the amount has not yet been [blocked](https://developer.revolut.com/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. | - `created_at` string, date-time, required: The date and time the payout link was created in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). - `updated_at` string, date-time, required: The date and time the payout link was last updated in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). - `counterparty_name` string, required: The name of the counterparty provided by the sender. - `save_counterparty` boolean, required: Indicates whether you chose to save the recipient as your counterparty upon link claim. If `false` then the counterparty will not show up on your counterparties list, for example, when you [retrieve your counterparties](https://developer.revolut.com/docs/api/business#get-counterparties). However, you can still [retrieve this counterparty by its ID](https://developer.revolut.com/docs/api/business#get-counterparty). If you didn't choose to save the counterparty on link creation, you can still do it from your transactions list in the Business app. - `request_id` string, required: The ID of the request, provided by the sender. - `expiry_date` string, date-time: The date and time after which the payout link expires in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). If the recipient doesn't claim the money before then, the payout link expires and is no longer available. The default and maximum value is the date and time of creating the link + 7 days. - `payout_methods` PayoutMethod[], required: The list of payout methods that the recipient can use to claim the payout. - `account_id` string, uuid, required: The ID of the sender's account. - `amount` number, double, required: The amount of money to be transferred. :::note The amount must be between £1 and £2,500, or equivalent in the selected currency. ::: - `currency` string, required: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case. - `url` string, uri: The URL of the payout link. Returned only for active payout links. - `reference` string, required: The reference for the payout transaction, provided by the sender. - `transfer_reason_code` string: The reason code for the transaction. Transactions to certain countries and currencies might require you to provide a transfer reason. You can check available reason codes with the [`GET /transfer-reasons` operation](https://developer.revolut.com/docs/api/business#get-transfer-reasons). If a transfer reason is not required for the given currency and country, this field is ignored. - `counterparty_id` string, uuid: The ID of the counterparty created based on the recipient's details. :::note By default, the newly created counterparty is hidden from your counterparties list. To automatically save it when the link is claimed, pass the `save_counterparty` parameter set to `true`. Alternatively, you can add the recipient to your counterparties later from the list of transactions in the Business app. ::: - `transaction_id` string, uuid: The ID of the created transaction. Returned only if the payout has been claimed. - `cancellation_reason` 'too_many_name_check_attempts': The reason for which the payout link was cancelled. ## Other responses - `403`: Forbidden - `default`: Unexpected error --- [API](https://skmtc.dev/revolut/apis/business-api.md) - [All operations](https://skmtc.dev/revolut/apis/business-api/llms.txt) - [OpenAPI document](https://skmtc.dev/revolut/apis/business-api/revisions/be089d9fa8b4?raw)