Retrieve a list of payment drafts
Get the list of payment drafts created with the API that haven't been sent for processing.
Payment drafts created through the Revolut Business app are not retrieved by the API.
The response lists the drafts with their details, such as the number of payments included in the draft, but not the payment details.
For more information, see the guides: Payment drafts.
Access Token
Each Business API request must contain an authorization header in the following format to make a call: Bearer <your_access_token>
.
The access token will be obtained the first time you set up your application and has an expiration of 40 minutes.
During setup, a refresh_token
will also be obtained which allows to obtain a new access_token
.
Never share your client-assertion JWT (JSON web token), access_token
and refresh_token
with anyone, as these can be used to access your banking data and initiate transactions.
Access tokens can be issued with four security scopes and require a JWT (JSON Web Token) signature to be obtained:
READ
: Permissions forGET
operations.WRITE
: Permissions to update counterparties, webhooks, and issue payment drafts.PAY
: Permissions to initiate or cancel transactions and currency exchanges.READ_SENSITIVE_CARD_DATA
: Permissions to retrieve sensitive card details.cautionIf you enable the
READ_SENSITIVE_CARD_DATA
scope for your access token, you must set up IP whitelisting. Failing to do so will prevent you from accessing any Business API endpoint.IP whitelisting means that you must specify an IP or a set of IPs which will be the only IPs from which requests to the API will be accepted. To do so:
- Go to the Revolut Business web app settings -> APIs -> Business API.
- Select the corresponding API certificate.
- In Production IP whitelist, provide the IP(s) which should be whitelisted, and save.
To configure your JWT and obtain the refresh and first access tokens, complete the following steps:
Request
Response
List of payment drafts