Payout links

Retrieve a payout link

Get the information about a specific link by its ID.

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

For more information, see the guides: Send money via payout link.

get/payout-links/{payout_link_id}

Request

Base URL
https://b2b.revolut.com/api/1.0
Auth
HTTP bearer

Path parameters

payout_link_idstring uuid required

The ID of the link to retrieve.

Response

The information about a specific link

idstring uuid required

The ID of the payout link.

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.
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_atstring date-time required

The date and time the payout link was created in ISO 8601 format.

updated_atstring date-time required

The date and time the payout link was last updated in ISO 8601 format.

counterparty_namestring required

The name of the counterparty provided by the sender.

save_counterpartyboolean 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. However, you can still retrieve this counterparty by its ID.

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_idstring required

The ID of the request, provided by the sender.

expiry_datestring date-time

The date and time after which the payout link expires in ISO 8601 format. 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_methodsPayoutMethod[] required

The list of payout methods that the recipient can use to claim the payout.

account_idstring uuid required

The ID of the sender's account.

amountnumber 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. :::

currencystring required

ISO 4217 currency code in upper case.

urlstring uri

The URL of the payout link. Returned only for active payout links.

referencestring required

The reference for the payout transaction, provided by the sender.

transfer_reason_codestring

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.

If a transfer reason is not required for the given currency and country, this field is ignored.

counterparty_idstring 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_idstring 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.

Example response

{
  "counterparty_name": "John Smith",
  "request_id": "5a7fcb46-4be4-47d4-a56f-27a2e5b78dd1",
  "expiry_date": "2023‐07‐20T15:09:24Z",
  "payout_methods": [
    "revolut",
    "bank_account",
    "card"
  ],
  "account_id": "85f515e4-588f-4496-a6a5-a7615a193e6b",
  "amount": 105.6,
  "reference": "Rent",
  "transfer_reason_code": "property_rental"
}

Changes

No recorded changes to this operation across all 1 revision of this API.