Business API
Retrieve a list of payment drafts
api
get
/payment-drafts

Retrieve a list of payment drafts

Get the list of payment drafts created with the API that haven't been sent for processing.

note

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.

danger

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 for GET 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.

    caution

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

    1. Go to the Revolut Business web app settings -> APIs -> Business API.
    2. Select the corresponding API certificate.
    3. 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:

  1. Sign up for a Revolut Business account
  2. Prepare your Sandbox environment
  3. Make your first API request

Request

Response

List of payment drafts

Response body
Body object

The list of payment drafts that haven't been sent for processing.

The ID of the payment draft.

The scheduled date of the payment draft in ISO 8601 format.

The title of the payment draft.

The number of payments in the payment draft.

Was this page helpful?
Loading...