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 Payment drafts API

Payment drafts let you prepare payments for future processing, prepare payments that require an approval, or prepare bulk or scheduled payments.Simply create a draft, and when you're ready, [send it for processing as payment](https://developer.revolut.com/docs/guides/manage-accounts/transfers/payment-drafts#send-drafts-for-processing).If you or the payment you're making is subject to an [approval process](https://help.revolut.com/business/help/managing-my-business/users-and-employees/how-can-i-set-payment-approval-rules/), another team member designated as an approver must approve it in the [Revolut Business app](https://business.revolut.com/) before the payment can be processed.You can also retrieve or delete the drafts created with the API.For more information on use cases and other details, see the guides: [Payment drafts](https://developer.revolut.com/docs/guides/manage-accounts/transfers/payment-drafts).

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

Tagged areas include Payment drafts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 4 paths, and defines 16 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.

8 operations 4 paths 16 schemas 2 DELETE2 GET2 PATCH2 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 Payment drafts 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 8

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

Payment drafts 8

Payment drafts let you prepare payments for future processing, prepare payments that require an approval, or prepare bulk or scheduled payments. Simply create a draft, and when yo…

GET
/payment-drafts
Retrieve a list of payment drafts
getPaymentDrafts 1 param → 200default
POST
/payment-drafts
Create a payment draft
createPaymentDraft body → 201204400default
GET
/payment-drafts/{payment_draft_id}
Retrieve a payment draft
getPaymentDraft 1 param → 200default
DELETE
/payment-drafts/{payment_draft_id}
Delete a payment draft
deletePaymentDraft 1 param → 204default
PATCH
/payment-drafts/{payment_draft_id}
Update a payment draft
updatePaymentDraft 1 param body → 204400404422default
POST
/payment-drafts/{payment_draft_id}/payments
Add a payment to a payment draft
addPaymentDraftPayment 1 param body → 201400404422default
PATCH
/payment-drafts/{payment_draft_id}/payments/{payment_id}
Update a payment in a payment draft
updatePaymentDraftPayment 2 params body → 204400404422default
DELETE
/payment-drafts/{payment_draft_id}/payments/{payment_id}
Delete a payment from a payment draft
deletePaymentDraftPayment 2 params → 204404422default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are PaymentInfo (11 properties), PaymentRequest (7 properties), UpdateDraftPaymentRequest (6 properties), PaymentOrderInfo (5 properties). Each schema is shown below with its type and property counts.

Currency
string
[ISO 4217](https://en.wikipedia.org/wiki/ISO4217) currency code in upper case.
PaymentReceiver
object
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…
3 properties 1 required
CreatePaymentDraftResponse
object
1 property 1 required
PaymentOrderInfo
object
A list of payments.
5 properties 2 required
PaymentInfo
object
The details of the payment draft.
11 properties 6 required
ErrorWithId
object
3 properties 3 required
CreatePaymentDraftPaymentResponse
object
1 property 1 required
PaymentDraftResponse
object
4 properties 1 required
CreatePaymentDraftRequest
object
3 properties 1 required
UpdateDraftPaymentRequest
object
The updated details of a single payment in a payment draft.
6 properties
PaymentRequest
object
The details of the draft payment.
7 properties 5 required
PaymentDraftsResponse
object
1 property 1 required
UpdatePaymentDraftRequest
object
The updated metadata of a payment draft.
2 properties
AmountWithCurrency
object
2 properties
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…
PaymentState
string
Indicates the state of the transaction.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

revolut-payment-drafts-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