*International scheduled payments*, which you can use for international SWIFT payments in all currencies that Revolut supports.As a regulated third party provider, you can use the provided endpoints to initiate a payment in the following high-level workflow:- Create a consent.- Get the consent.- Create a payment.- Get the payment.Before you begin, ensure that you've registered your application with the `payments` scope.For more information, see [Tutorials: Initiate your first payment](https://developer.revolut.com/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment).:::tipSee also: [International payments](https://developer.revolut.com/docs/api/open-banking#tag-international-payment) and [International standing orders](https://developer.revolut.com/docs/api/open-banking#tag-international-standing-order) .:::
Revolut International scheduled payment API is one of 46 APIs that Revolut publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include International scheduled payment. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
5 operations
across 5 paths,
and defines 39 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 operations5 paths39 schemas3 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 International scheduled payment 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 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
International scheduled payment 5
International scheduled payments, which you can use for international SWIFT payments in all currencies that Revolut supports. As a regulated third party provider, you can use the…
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are OBInternationalScheduledBase (11 properties), OBPostalAddress6 (9 properties), OBWriteDataInternationalScheduledResponse2 (8 properties), OBWriteDataInternationalScheduledConsentResponse2 (7 properties). Each schema is shown below with its type and property counts.
OBExternalConsentStatus1Code
string
The status of the consent.
OBExchangeRate1
object
The details on the currency exchange rate and contract.
4 properties2 required
OBRemittanceInformation1
object
The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable syste…
2 properties
OBWriteDataFundsConfirmationResponse1
object
1 property
OBBranchAndFinancialInstitutionIdentification6
object
The party that manages the account on behalf of the account owner by: - Managing the registration and booking of entries on the account. - Calculating balances…
4 properties
Meta
object
Meta data relevant to the payload.
1 property
OBExternalAccountIdentification4Code
string
The name of the identification scheme.
OBExternalMerchantCategoryCode
string
The merchant category code.
OBChargeBearerType1Code
string
The party or parties bear the charges associated with the processing of the payment transaction.
OBPartyIdentification43
object
The party that an amount of money is due to.
2 properties
OBInternationalScheduledBase
object
The initiation payload that the initiating party sends to the [ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/glossary), which is used to…
11 properties
OBWriteInternationalScheduledConsent2
object
2 properties2 required
OBExchangeRate2
object
Further detailed information on the exchange rate that is used in the payment transaction.
5 properties3 required
OBCashAccountDebtorResponse
object
The details to identify the account which was used to approve the payment consent. This information can be used as a refund address.
4 properties2 required
OBActiveCurrencyAndAmount_SimpleType
string
The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO4217).
OBCashAccountDebtor4
object
The details to identify the account from which the payment consent can be approved. If provided in the consent, the [PSU](https://developer.revolut.com/docs/gu…
4 properties2 required
OBExternalFinancialInstitutionIdentification4Code
array
The name of the identification scheme, which is published in an external list.
OBExternalPermissions2Code
string
The Open Banking service request type.
OBWriteInternationalScheduledConsentResponse2
object
4 properties4 required
OBWriteFundsConfirmationResponse1
object
3 properties3 required
OBExternalStatus1Code
string
The status of the payment.
OBInternationalScheduled2
object
The initiation payload that the initiating party sends to the [ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/glossary), which is used to…
OBErrorResponse1
object
The detailed information about the error to help troubleshooting.
4 properties3 required
OBWriteDataInternationalScheduledConsent2
object
2 properties2 required
Links
object
Links relevant to the payload.
3 properties1 required
OBInternationalScheduledInitiationResponse
object
The initiation payload that the initiating party sends to the [ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/glossary), which is used to…
OBExchangeRateType2Code
string
The type used to complete the currency exchange.
OBExternalMerchantCustomerIdentification
string
The merchant customer identification.
OBWriteDataInternationalScheduledConsentResponse2
object
7 properties6 required
OBWriteInternationalScheduledResponse2
object
3 properties3 required
OBWriteInternationalScheduled2
object
2 properties2 required
OBWriteDataInternationalScheduledResponse2
object
8 properties6 required
OBError1
object
2 properties2 required
OBWriteDataInternationalScheduled2
object
2 properties2 required
OBExternalPaymentContext1Code
string
The payment context.
OBRisk1
object
The Risk section contains the risk indicators that the initiating party sends to the [ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/gloss…
4 properties
OBFundsAvailableResult1
object
The results of the funds availability check.
2 properties2 required
OBPostalAddress6
object
The postal address of the creditor, as defined by postal services.
9 properties
OBCashAccountCreditor3
object
The details to identify the account.
4 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
