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

The File Payment API from Revolut — 6 operation(s) for file payment.

Revolut File 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 File Payment. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 6 paths, and defines 28 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.

7 operations 6 paths 28 schemas 4 GET3 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 File 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 7

Across 6 paths, the API surfaces 7 operations — 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

File Payment 7
GET
/file-payment-consents/{ConsentId}
Retrieve a file payment consent
GetFilePaymentConsentsConsentId 7 params → 200400401403405406429500
POST
/file-payment-consents
Create a file payment consent
CreateFilePaymentConsents 8 params body → 201400401403405406415429
GET
/file-payment-consents/{ConsentId}/file
Retrieve an uploaded payment file
GetFilePaymentConsentsConsentIdFile 7 params → 200400401403405406429500
POST
/file-payment-consents/{ConsentId}/file
Upload a payment file
CreateFilePaymentConsentsConsentIdFile 9 params body → 200400401403405406415429
POST
/file-payments
Create a file payment
CreateFilePayments 8 params body → 201400401403405406415429
GET
/file-payments/{FilePaymentId}
Retrieve a file payment
GetFilePaymentsFilePaymentId 7 params → 200400401403405406429500
GET
/file-payments/{FilePaymentId}/report-file
Retrieve all payments of a file payment
GetFilePaymentsFilePaymentIdReportFile 7 params → 200400401403405406429500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are OBWriteDataFileResponse2 (6 properties), OBFileBase (6 properties), OBWriteDataFileConsentResponse2 (5 properties), OBCashAccountDebtorResponse (4 properties). Each schema is shown below with its type and property counts.

OBFileInitiationResponse
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…
OBWriteFileConsent2
object
1 property 1 required
OBWriteDataFileConsentResponse2
object
5 properties 5 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
OBExternalLocalInstrument1Code
string
User community specific instrument. Use this element to specify a local instrument, local clearing option and/or further qualify the service or service level.
Meta
object
Meta data relevant to the payload.
1 property
EmptyBody
object
An empty JSON object ({}).
OBExternalAccountIdentification4Code
string
The name of the identification scheme.
Currency
string
[ISO 4217](https://en.wikipedia.org/wiki/ISO4217) currency code in upper case.
Amount
string
The amount of money.
OBReportFileResponse
object
1 property 1 required
OBWriteDataFileResponse2
object
6 properties 6 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 properties 2 required
OBWriteFileConsentResponse2
object
3 properties 3 required
OBExternalConsentStatus2Code
string
The status of the consent.
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 properties 2 required
OBExternalStatus1Code
string
The status of the payment.
OBErrorResponse1
object
The detailed information about the error to help troubleshooting.
4 properties 3 required
Links
object
Links relevant to the payload.
3 properties 1 required
OBExternalFileType1Code
string
The payment file type.
OBFile2
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…
OBWriteDataFileConsent2
object
1 property 1 required
OBWriteDataFile2
object
2 properties 2 required
OBError1
object
2 properties 2 required
OBWriteFile2
object
1 property 1 required
OBWriteFileResponse2
object
3 properties 3 required
OBFileBase
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…
6 properties
PaymentStatus
string
The status of the payment.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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