RErevolut
Payout links

Create a payout link

Create a payout link to send money even when you don't have the full banking details of the counterparty.
After you have created the link, send it to the recipient so that they can claim the payment.

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

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

post/payout-links

Request

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

Request body

counterparty_namestring required

The name of the counterparty provided by the sender.

save_counterpartyboolean

Indicates whether 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 will still be able to retrieve this counterparty by its ID.

If you don't choose to save the counterparty on link creation, you can do it later from your transactions list in the Business app.

request_idstring required

The ID of the request, provided by the sender.

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.

referencestring required

The reference for the payout link. A piece of text or number you provide to help identify what the payment relates to. It can be used, for example, for reconciliation or tracking purposes.

You might include an invoice number, account or transaction ID, or any other reference meaningful to you or the recipient.

payout_methodsPayoutMethod[]

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

expiry_periodstring duration

The period after which the payout link expires if not claimed before, provided in ISO 8601 format.

The default and maximum value is 7 days from the link creation.

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.

Example request

{
  "counterparty_name": "John Smith",
  "request_id": "5a7fcb46-4be4-47d4-a56f-27a2e5b78dd1",
  "account_id": "85f515e4-588f-4496-a6a5-a7615a193e6b",
  "amount": 105.6,
  "payout_methods": [
    "revolut",
    "bank_account",
    "card"
  ],
  "expiry_period": "P3D",
  "transfer_reason_code": "property_rental"
}

Response

Created payout link details

idstring 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:

ValueDescription
createdThe payout link has been created, but the amount has not yet been blocked.
failedThe payout link couldn't be generated due to a failure during transaction booking.
awaitingThe payout link is awaiting approval.
activeThe payout link can be redeemed.
expiredThe payout link cannot be redeemed because it wasn't claimed before its expiry date.
cancelledThe payout link cannot be redeemed because it was cancelled.
processingThe payout link has been redeemed and is being processed.
processedThe 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.

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.