Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Revolut Payout links API

Use payout links to send money without having to request full banking details of the recipient. The recipient must claim the money before the link expires.:::noteThis 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).

Revolut Payout links API is one of 46 APIs that Revolut publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payout links. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 21 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://b2b.revolut.com/api/1.0, https://sandbox-b2b.revolut.com/api/1.0.

5 operations 4 paths 21 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://b2b.revolut.com/api/1.0
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Revolut Payout links API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (AccessToken).

  • AccessToken — Each Business API request must contain an authorization header in the following format to make a call: Bearer . The access token will be obtained the first tim…

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Payout links 5

Use payout links to send money without having to request full banking details of the recipient. The recipient must claim the money before the link expires. :::note This feature is…

POST
/payout-links
Create a payout link
createPayoutLink body → 201400403default
GET
/payout-links
Retrieve a list of payout links
getPayoutLinks 3 params → 200403default
GET
/payout-links/{payout_link_id}
Retrieve a payout link
getPayoutLink 1 param → 200403404default
POST
/payout-links/{payout_link_id}/cancel
Cancel a payout link
cancelPayoutLink 1 param → 204403default
GET
/transfer-reasons
Get transfer reasons
getTransferReasons → 200default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are PayoutLinkInitialProps (15 properties), CreatePayoutLinkRequest (10 properties), TransferReason (4 properties), PayoutLinkAdditionalProps (3 properties). Each schema is shown below with its type and property counts.

PayoutLinkInitialProps
object
15 properties 12 required
CreatePayoutLinkRequest
object
10 properties 6 required
PayoutLinkState
string
The state that the payout link is in. Possible states are: - created: The payout link has been created, but the amount has not yet been [blocked](https://devel…
Currency
string
[ISO 4217](https://en.wikipedia.org/wiki/ISO4217) currency code in upper case.
PayoutLinkAccountId
string
The ID of the sender's account.
PayoutLinkAdditionalProps
object
3 properties
Error
object
2 properties 2 required
TransferReasons
array
PayoutLinkExpiryDate
string
The date and time after which the payout link expires in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO8601). If the recipient doesn't claim the money bef…
PayoutLinkExpiryPeriod
string
The period after which the payout link expires if not claimed before, provided in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO8601). The default and max…
PayoutLinkCounterpartyName
string
The name of the counterparty provided by the sender.
PayoutLinkRequestId
string
The ID of the request, provided by the sender.
PayoutLinks
array
A list of payout links
PayoutLinkReference
string
The reference for the payout transaction, provided by the sender.
PayoutLink
TransferReason
object
4 properties 4 required
CountryCode
string
The counterparty's bank country, provided as a 2-letter [ISO 3166](https://en.wikipedia.org/wiki/ListofISO3166countrycodes) code.
PayoutMethod
string
The payout method that the recipient can use to claim the payout.
TransferReasonCode
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 r…
PayoutLinkPayoutMethods
array
The list of payout methods that the recipient can use to claim the payout, where: - revolut: Revolut peer-to-peer (P2P) transfer - bankaccount: External bank t…
PayoutLinkAmount
number
The amount of money to be transferred. :::note The amount must be between £1 and £2,500, or equivalent in the selected currency. :::

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

revolut-payout-links-api-openapi.yml Raw ↑

Other APIs Revolut publishes across the network.

Revolut Accounting API
Revolut Accounting categories API
Revolut Accounts API
Revolut Apple Pay merchant registration API
Revolut Applications API
Revolut Balance API
Revolut Card invitations API
Revolut Cards API
Revolut Configuration API
Revolut Counterparties API
Revolut Customers API
Revolut Disputes API