Business API
Create a payment draft
api
post
/payment-drafts

Create a payment draft

Create a payment draft.

When you create a payment draft, it stays a draft until you send it for processing as payment in the Revolut Business app.

Until then, you can delete the draft if you no longer wish to proceed with it.

note

If you or the payment you're making is subject to an approval process, when you send the draft for processing, the payment goes into the Pending review state. Before it can be processed, the business owner, administrator, or another team member designated as an approver must approve it in the Revolut Business app.

For more information on use cases and other details, 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​

The payment draft information

Request body
Body object

The title of the payment draft.

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

The details of the payment(s) to be made.

The ID of the account to pay from.

note

You can specify only one account ID for multiple payments in the same payment draft.

The details of the transfer recipient.

If the counterparty has multiple payment methods available (e.g. 2 accounts, or 1 account and 1 card), you must specify the account (account_id) or card (card_id) to which you want to transfer the money.

The ID of the receiving counterparty.

The ID of the receiving counterparty's account, which can be own account. Used for bank transfers.

If the counterparty has multiple payment methods available, use it to specify the account to which you want to send the money.

The ID of the receiving counterparty's card. Used for card transfers.

If the counterparty has multiple payment methods available, use it to specify the card to which you want to send the money.

The amount of the payment.

Possible values: Value must match regular expression ^[A-Z]{3}$

ISO 4217 currency code in upper case.

The reference for the payment.

Response​

The ID of the payment draft that was created

Response body
Body object

The ID of the payment draft created.

Was this page helpful?
Loading...