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 Customers API

The Customers resource in the Merchant API is a pivotal tool for tracking and managing customer-related transactions within your e-commerce or retail platform. This resource provides a structured approach to customer management, enabling you to maintain a consistent record of customer transactions.A `Customer` object can be created using the [Create a customer](https://developer.revolut.com/docs/api/merchant#create-customer) endpoint and you can then retrieve, update and delete a customer using its `id`. `Customer` objects enable you to track multiple transactions in your system associated with the same customer in the Merchant API.You can save and store payment methods of a customer in the `payment_method` object, for more information, see: [Charge a customer's saved payment method](https://developer.revolut.com/docs/guides/merchant/optimise-checkout/save-payment-methods/charge-saved-payment-method). A merchant can store the details of the payment securely and group transactions from the same payment method in their system.A payment method is unique for each customer. For example, if the same card is used for a transaction by two different customers, two payment method objects are created linked to each customer.Similar principle applies when saving payment methods via Revolut Pay for merchant initiated transaction (MIT - useful for recurring payments). If a customer saves their details through Revolut Pay for MIT in separate sessions, each session will create a new payment method object linked to the customer.:::noteYou cannot create a payment method explicitly because they are generated as part of a payment. You can only retrieve, update or delete a payment method, or you can retrieve all payment methods of a customer.:::

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

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

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

9 operations 4 paths 37 schemas 2 DELETE4 GET2 PATCH1 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 Customers 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 9

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

Customers 9

The Customers resource in the Merchant API is a pivotal tool for tracking and managing customer-related transactions within your e-commerce or retail platform. This resource provi…

POST
/api/customers
Create a customer
createCustomer 2 params body → 201400401
GET
/api/customers
Retrieve a customer list
retrieveCustomerList 6 params → 200401
GET
/api/customers/{customer_id}
Retrieve a customer
retrieveCustomer 3 params → 200401404
PATCH
/api/customers/{customer_id}
Update a customer
updateCustomer 3 params body → 200400401404
DELETE
/api/customers/{customer_id}
Delete a customer
deleteCustomer 3 params → 204401404
GET
/api/customers/{customer_id}/payment-methods
Retrieve payment method list of a customer
retrievePaymentMethodList 4 params → 200401404
GET
/api/customers/{customer_id}/payment-methods/{payment_method_id}
Retrieve a customer's payment method
retrievePaymentMethod 4 params → 200401404
PATCH
/api/customers/{customer_id}/payment-methods/{payment_method_id}
Update a customer's payment method
updatePaymentMethod 4 params body → 200401404
DELETE
/api/customers/{customer_id}/payment-methods/{payment_method_id}
Delete a customer's payment method
deletePaymentMethod 4 params → 204401404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Card-v2 (15 properties), Sepa-Direct-Debit-v2 (8 properties), Customer-v3 (7 properties), Customer-Simplified (6 properties). Each schema is shown below with its type and property counts.

Full-Name
string
The full name of the customer.
Sepa-Direct-Debit-Debtor-Name
string
The full name of the debtor as provided in the mandate.
Saved-For
string
Indicates in which case this saved payment method can be used for payments. | Value | Description | | ----- | ----------- | | customer | This payment method ca…
Card-v2
object
A saved card payment method. :::info The checks object (3DS, CVV, address verification) is not included as it is specific to the transactional payment context.…
15 properties 3 required
Cardholder-Name
string
The name of the cardholder as it appears on the card.
Payment-Method-Created-At
string
The date and time the payment method was added.
Sepa-Direct-Debit-Debtor-Iban-Last-Four
string
The last four digits of the debtor's IBAN.
Card-Last-Four
string
The last four digits of the payment card number.
Payment-Method-v4
A saved payment method on a customer profile. Use the type field to determine the specific payment method variant. :::note This schema represents a stored cred…
Card-Expiry-Year
integer
The expiry year of the payment card.
Billing-Address
object
The billing address associated with the payment method.
6 properties 2 required
Error-v2
object
3 properties
Payment-Method-Type-v2
string
The type of the payment method.
Revolut-Pay-v2
object
A saved Revolut Pay payment method on a customer profile. Both Revolut Pay card-backed and account-to-account (A2A) variants are represented by this single typ…
4 properties 3 required
Payment-Method-Update
object
Fields to update on a saved payment method.
1 property
Email
string
The email address of the customer.
Customer-Payment-Methods-v2
object
1 property 1 required
Customer-Created
object
A customer object.
6 properties 4 required
Customer-v3
object
A customer object.
7 properties 5 required
Card-Expiry-Month
integer
The expiry month of the payment card.
Card-Funding-v2
string
The funding type of the payment card.
Customer-Id
string
Unique identifier for the customer.
Card-Bin
string
The BIN (Bank Identification Number) of the payment card, typically the first 6-8 digits.
Customers
object
2 properties 1 required
Customer-Update-v2
object
The request body for updating a customer. All fields are optional. Only the fields provided in the request will be updated. :::note businessname is not support…
4 properties
Next-Page-Token
string
Token for retrieving the next page of results. Use this token as the value of the pagetoken query parameter in your next request to retrieve the next page. If…
Sepa-Direct-Debit-v2
object
A saved SEPA Direct Debit payment method on a customer profile. :::info For more information, see: [SEPA Direct Debit server-to-server integration](https://dev…
8 properties 3 required
Card-Issuer
string
The name of the card-issuing bank or institution.
Payment-Method-Id
string
Unique identifier for the payment method.
Card-Brand-v2
string
The brand of the payment card.
Customer-Simplified
object
A customer object.
6 properties 4 required
Customer-Creation-v2
object
The request body for creating a customer.
4 properties 1 required
Date-Of-Birth
string
The birth date of the customer.
Terminal-Hardware-Id
string
The hardware identifier of the Revolut Terminal device used to process the payment. :::note Only present for card-present transactions processed via Revolut Te…
Card-Issuer-Country
string
The ISO 3166-1 alpha-2 country code of the country where the payment card was issued.
Phone
string
The phone number of the customer in [E.164 format](https://en.wikipedia.org/wiki/E.164).
Sepa-Direct-Debit-Mandate-Reference
string
The unique mandate reference generated by Revolut. Include this in pre-debit notifications sent to your customers.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

revolut-customers-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 Disputes API
Revolut Domestic payment API