Payment operations enable you to initiate payments, or track payment status transitions. You can use the ID of the payment to retrieve information about a specific payment. :::info For more information about the payment lifecycle, see: [Order and payment lifecycle](https://developer.revolut.com/docs/guides/merchant/reference/order-lifecycle). :::
openapi: 3.0.1
info:
version: '1.0'
title: Business Accounting Payments API
description: "As a Revolut Business customer with a Business Account, you can use the Business API to automate your own business processes.\nSave time, reduce your costs, and avoid errors by using the Business API. \n\n:::tip[Before you get started]\nTo learn more about the Business API and its features, check the [**user guides**](https://developer.revolut.com/docs/guides/manage-accounts/introduction).\n\nYou can reach them at any time from the main navigation bar **→ Guides → Business**.\n:::\n\nYou can view accounts, manage counterparties, make payments or currency exchanges without manual effort in the Web UI:\n\n- Accounting: [Account management](https://developer.revolut.com/docs/api/business#get-account), [Accounting settings](https://developer.revolut.com/docs/api/business#tag-accounting), [Expense management](https://developer.revolut.com/docs/api/business#get-expense), [Transactions](https://developer.revolut.com/docs/api/business#get-transactions) \n- Payments: \n - [Counterparty management](https://developer.revolut.com/docs/api/business#get-counterparties)\n - Payment management: [Payment drafts](https://developer.revolut.com/docs/api/business#delete-payment-draft), [Payout links](https://developer.revolut.com/docs/api/business#get-payout-link), [Transfers](https://developer.revolut.com/docs/api/business#tag-transfers)\n - [Foreign exchange](https://developer.revolut.com/docs/api/business#tag-foreign-exchange)\n- Business team: [Card management](https://developer.revolut.com/docs/api/business#delete-card), [Card invitation management](https://developer.revolut.com/docs/api/business#update-card-invitation), [Team member management](https://developer.revolut.com/docs/api/business#delete-team-member)\n- Developer tools: [Sandbox simulations](https://developer.revolut.com/docs/api/business#tag-simulations), [Webhook management](https://developer.revolut.com/docs/api/business#tag-webhooks-v2)\n\nTo see the reference for the specific endpoints and operations of this API, browse the menu on the left.\n\n### Test the Business API\n\nYou can test the Business API in Postman by forking this collection:\n\n[](https://www.postman.com/revolut-api/workspace/revolut-developers/overview)"
contact: {}
servers:
- url: https://b2b.revolut.com/api/1.0
description: Production server (uses live data)
- url: https://sandbox-b2b.revolut.com/api/1.0
description: Sandbox server (uses test data)
tags:
- name: Payments
description: 'Payment operations enable you to initiate payments, or track payment status transitions. You can use the ID of the payment to retrieve information about a specific payment.
:::info
For more information about the payment lifecycle, see: [Order and payment lifecycle](https://developer.revolut.com/docs/guides/merchant/reference/order-lifecycle).
:::'
paths:
/api/orders/{order_id}/payments:
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/Order-Id'
post:
summary: Pay for an order
operationId: payOrder
description: "Initiate a payment to pay full amount for an order using a customer's saved payment method.\n\n:::note\nThe `/orders/{order_id}/confirm` endpoint has been deprecated. It will be only supported for already existing implementations.\n:::\n\n:::warning\nThis endpoint is part of a new API, pay attention to the different endpoint URL. \n:::\n\nFor more information about how to save and charge payment methods, see: [Charge a customer's saved payment method](https://developer.revolut.com/docs/guides/merchant/optimise-checkout/save-payment-methods/charge-saved-payment-method).\n\nThe following table shows who can initiate payments on saved payment methods (`initiator` parameter), depending on if the payment method was saved for the customer or the merchant (`savedPaymentMethodFor` parameter):\n\n | | `savePaymentMethodFor: customer` | `savePaymentMethodFor: merchant` |\n | ------------------------- | -------------------------------- | -------------------------------- |\n | **`initiator: customer`** | Allowed | Allowed |\n | **`initiator: merchant`** | Not allowed | Allowed |\n\n\n:::note\nUsing this endpoint, only merchant initiated payments are supported with Revolut Pay.\n:::\n \nFor more information about customers' payment methods, see the [Retrieve payment method list of a customer](https://developer.revolut.com/docs/api/merchant#retrieve-payment-method-list) operation."
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Saved-Payment-Method'
examples:
saved_card_customer:
summary: Saved card (customer initiator)
value:
saved_payment_method:
type: card
id: 2b83c23a-650e-40c3-8989-00ee24478738
initiator: customer
environment:
type: browser
time_zone_utc_offset: 180
color_depth: 48
screen_width: 1920
screen_height: 1080
java_enabled: true
challenge_window_width: 640
browser_url: https://business.revolut.com
saved_card_merchant:
summary: Saved card (merchant initiator)
value:
saved_payment_method:
type: card
id: 2b83c23a-650e-40c3-8989-00ee24478738
initiator: merchant
revolut_pay:
summary: Saved Revolut Pay (merchant initiator)
value:
saved_payment_method:
type: revolut_pay
id: 2b83c23a-650e-40c3-8989-00ee24478738
initiator: merchant
responses:
'200':
description: Payment initiated
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Retrieval'
examples:
successful_payment_card:
summary: Payment authorised (card)
value:
id: 63c55e04-4208-a43d-9c96-eaee848ffbaf
order_id: 63c55df6-1461-a886-b90f-f49d3c370253
payment_method:
type: card
id: 2b83c23a-650e-40c3-8989-00ee24478738
brand: mastercard_credit
last_four: '1234'
state: authorisation_passed
successful_payment_revolut_pay_account:
summary: Payment authorised (Revolut Pay - Revolut account)
value:
id: 63c55e04-4208-a43d-9c96-eaee848ffbaf
order_id: 63c55df6-1461-a886-b90f-f49d3c370253
payment_method:
type: revolut_pay
subtype: revolut_account
id: 2b83c23a-650e-40c3-8989-00ee24478738
state: authorisation_passed
successful_payment_revolut_pay_card:
summary: Payment authorised (Revolut Pay - card)
value:
id: 63c55e04-4208-a43d-9c96-eaee848ffbaf
order_id: 63c55df6-1461-a886-b90f-f49d3c370253
payment_method:
type: revolut_pay
subtype: card
id: 2b83c23a-650e-40c3-8989-00ee24478738
brand: visa
last_four: '1234'
state: authorisation_passed
three_ds:
summary: Saved card payment (3DS challenge)
value:
id: 5e96b328-4054-41ed-b089-595ccc4d0870
order_id: a16718e0-077a-4942-89bc-23ac17a2e14c
payment_method:
type: card
id: 2b83c23a-650e-40c3-8989-00ee24478738
brand: mastercard_credit
last_four: '1234'
state: authentication_challenge
authentication_challenge:
type: three_ds
acs_url: https://example.com
three_ds_fingerprint:
summary: Saved card payment (3DS fingerprint challenge)
value:
id: 5e96b328-4054-41ed-b089-595ccc4d0870
order_id: a16718e0-077a-4942-89bc-23ac17a2e14c
payment_method:
type: card
id: 2b83c23a-650e-40c3-8989-00ee24478738
brand: mastercard_credit
last_four: '1234'
state: authentication_challenge
authentication_challenge:
type: three_ds_fingerprint
fingerprint_url: https://example.com
fingerprint_data: string
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errorId:
type: string
description: 'The ID of the error. You can share this ID with Revolut
support for troubleshooting.'
timestamp:
type: integer
description: The date and time the error happened.
examples:
example-1:
value:
errorId: 94b27660-fdda-49ec-8b85-cd46a068ade0
timestamp: 1601296792533
'401':
description: Unauthorized
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
errorId:
type: string
description: 'The ID of the error. You can share this ID with Revolut
support for troubleshooting.'
timestamp:
type: integer
description: The date and time the error happened.
code:
type: integer
examples:
example-1:
value:
errorId: 94b27660-fdda-49ec-8b85-cd46a068ade0
timestamp: 1601296792533
code: 1024
security:
- Api-Key: []
tags:
- Payments
get:
summary: Retrieve payment list of an order
operationId: retrievePaymentList
description: "Retrieve a list of payments for a specific order, based on the order's ID.\n\n:::note\nThis endpoint is part of a new API, pay attention to the different endpoint URL.\n:::\n\nUse this endpoint to retrieve payment details for saved payment methods to make merchant and customer initiated transactions. For more information, see: \n - [Speed up customer checkout by using saved card details](https://developer.revolut.com/docs/guides/merchant/optimise-checkout/save-payment-methods/checkout-with-saved-card)\n - [Manage subscriptions](https://developer.revolut.com/docs/guides/merchant/optimise-checkout/save-payment-methods/subscription-management)"
responses:
'200':
description: List of payments
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Payment-Retrieval'
examples:
payment_list:
summary: List of payments (failed card attempt, SEPA Direct Debit retry)
value:
- id: 63dd0e4a-42c4-a1a6-ab2c-6ac9d255ca4b
token: 294358bf-3818-49b2-aacc-7ca971f52695
order_id: 63dd0e3f-7b84-ab5c-927c-1a06f7c9583a
state: declined
amount: 100
currency: EUR
payment_method:
type: card
card_brand: visa
funding: credit
card_last_four: '1234'
- id: 649adc44-3e86-a832-879c-2f6d0255dd4c
token: 8061e645-35e0-42bb-8318-603abaeab7b7
order_id: 63dd0e3f-7b84-ab5c-927c-1a06f7c9583a
state: declined
amount: 100
currency: EUR
decline_reason: insufficient_funds
payment_method:
type: revolut_pay
subtype: revolut_account
- id: 663387f1-1c2e-a295-b143-9f1fb1eec175
token: 663387f1-c91e-a464-908a-1cc4548ebc6a
order_id: 63dd0e3f-7b84-ab5c-927c-1a06f7c9583a
state: pending
amount: 100
currency: EUR
payment_method:
type: sepa_direct_debit
debtor_iban_last_four: '1234'
debtor_name: John Doe
mandate_reference: A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error-v2'
example:
code: bad_request
message: Could not parse JSON
timestamp: 1720528890647
'401':
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Error-v2'
example:
code: unauthenticated
message: Authentication failed
timestamp: 1720528890647
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error-v2'
example:
code: not_found
message: Order with id b8883ab5-964a-4329-aa44-4d3c76cf3f54 was not found
timestamp: 1720528890647
security:
- Api-Key: []
tags:
- Payments
/api/payments/{payment_id}:
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/Payment-Id'
- $ref: '#/components/parameters/Revolut-Api-Version-Optional'
get:
summary: Retrieve payment details
operationId: retrievePaymentDetails
description: "Retrieve information about a specific payment, based on the payment's ID.\n\nUse this endpoint to track a payment's lifecycle, for example:\n - When you develop a [1-click checkout process](https://developer.revolut.com/docs/guides/merchant/optimise-checkout/save-payment-methods/checkout-with-saved-card)\n - When you build a [subscription management system](https://developer.revolut.com/docs/guides/merchant/optimise-checkout/save-payment-methods/subscription-management)"
responses:
'200':
description: Payment details
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Retrieval-v3'
examples:
revolut_pay_saved:
summary: Payment completed via Revolut Pay (card, saved details)
value:
id: 6633855a-0e4f-a768-8b2c-e765d8872505
state: captured
created_at: '2024-05-02T12:21:46.638369Z'
updated_at: '2024-05-02T12:21:55.198089Z'
token: 0b277730-8b3c-48d4-ab63-8903f40ee520
amount: 100
currency: GBP
settled_amount: 77
settled_currency: GBP
risk_level: low
fees:
- type: acquiring
amount: 23
currency: GBP
payment_method:
id: 6633855a-3b39-ad95-9782-cd1327ffa0e7
type: revolut_pay_card
fingerprint: 1JAllfQY4POhBV8DaddAQ4LC5RbMP8LMLvUdJW4s5JY=
card_brand: visa
funding: credit
card_country_code: MT
card_bin: '123456'
card_last_four: '1234'
card_expiry: 12/28
cardholder_name: Example Holder
checks:
three_ds:
eci: '06'
state: verified
version: 2
order_id: 66338534-28a7-a68e-b312-43722430df1b
revolut_pay_not_saved:
summary: Payment completed via Revolut Pay (account, not saved details)
value:
id: 66338688-fd73-a358-a82d-97da413c5325
state: captured
created_at: '2024-05-02T12:26:48.134039Z'
updated_at: '2024-05-02T12:26:49.514594Z'
token: 8061e645-35e0-42bb-8318-603abaeab7b7
amount: 100
currency: GBP
settled_amount: 79
settled_currency: GBP
billing_address:
street_line_1: 123 Example Street
street_line_2: Building A, 3rd Floor
city: Example City
region: Example Region
country_code: GB
postcode: E14 4HD
risk_level: low
fees:
- type: acquiring
amount: 21
currency: GBP
payment_method:
type: revolut_pay_account
fingerprint: 1JAllfQY4POhBV8DaddAQ4LC5RbMP8LMLvUdJW4s5JY=
order_id: 6633865d-d911-a98c-8715-425f8731640c
apple_tap_to_pay:
summary: Payment declined via Apple Tap to Pay
value:
id: 66338688-fd73-a358-a82d-97da413c5325
state: declined
created_at: '2024-05-02T12:26:48.134039Z'
updated_at: '2024-05-02T12:26:49.514594Z'
token: 8061e645-35e0-42bb-8318-603abaeab7b7
amount: 100
currency: GBP
settled_amount: 79
settled_currency: GBP
billing_address:
street_line_1: 123 Example Street
street_line_2: Building A, 3rd Floor
city: Example City
region: Example Region
country_code: GB
postcode: E14 4HD
risk_level: low
fees:
- type: acquiring
amount: 21
currency: GBP
payment_method:
type: apple_tap_to_pay
failure_reason: pin_data_required
order_id: 6633865d-d911-a98c-8715-425f8731640c
apple_pay:
summary: Payment completed via Apple Pay
value:
id: 66338688-fd73-a358-a82d-97da413c5325
state: captured
created_at: '2024-05-02T12:26:48.134039Z'
updated_at: '2024-05-02T12:26:49.514594Z'
token: 8061e645-35e0-42bb-8318-603abaeab7b7
amount: 100
currency: GBP
settled_amount: 79
settled_currency: GBP
billing_address:
street_line_1: 123 Example Street
street_line_2: Building A, 3rd Floor
city: Example City
region: Example Region
country_code: GB
postcode: E14 4HD
risk_level: low
fees:
- type: acquiring
amount: 21
currency: GBP
payment_method:
type: apple_pay
fingerprint: 1JAllfQY4POhBV8DaddAQ4LC5RbMP8LMLvUdJW4s5JY=
order_id: 6633865d-d911-a98c-8715-425f8731640c
google_pay:
summary: Payment completed via Google Pay
value:
id: 66338688-fd73-a358-a82d-97da413c5325
state: captured
created_at: '2024-05-02T12:26:48.134039Z'
updated_at: '2024-05-02T12:26:49.514594Z'
token: 8061e645-35e0-42bb-8318-603abaeab7b7
amount: 100
currency: GBP
settled_amount: 79
settled_currency: GBP
billing_address:
street_line_1: 123 Example Street
street_line_2: Building A, 3rd Floor
city: Example City
region: Example Region
country_code: GB
postcode: E14 4HD
risk_level: low
fees:
- type: acquiring
amount: 21
currency: GBP
payment_method:
type: google_pay
fingerprint: 1JAllfQY4POhBV8DaddAQ4LC5RbMP8LMLvUdJW4s5JY=
order_id: 6633865d-d911-a98c-8715-425f8731640c
card_payment_saved:
summary: Payment completed via card (saved details)
value:
id: 663387f1-1c2e-a295-b143-9f1fb1eec175
state: captured
created_at: '2024-05-02T12:32:49.033945Z'
updated_at: '2024-05-02T12:32:57.003519Z'
token: 294358bf-3818-49b2-aacc-7ca971f52695
amount: 100
currency: GBP
settled_amount: 79
settled_currency: GBP
billing_address:
street_line_1: 123 Example Street
street_line_2: Building A, 3rd Floor
city: Example City
region: Example Region
country_code: GB
postcode: E14 4HD
risk_level: low
fees:
- type: acquiring
amount: 21
currency: GBP
payment_method:
id: 663387f1-c91e-a464-908a-1cc4548ebc6a
type: card
fingerprint: 1JAllfQY4POhBV8DaddAQ4LC5RbMP8LMLvUdJW4s5JY=
card_brand: visa
funding: credit
card_country_code: GB
card_bin: '123456'
card_last_four: '1234'
card_expiry: 12/30
cardholder_name: Test Holder
checks:
three_ds:
eci: '06'
state: verified
version: 2
cvv_verification: match
address: match
postcode: match
cardholder: n_a
order_id: 663387bd-8484-ac57-93a7-3751dc154bbc
card_payment_not_saved:
summary: Payment completed via card (not saved details)
value:
id: 663387f1-1c2e-a295-b143-9f1fb1eec175
state: captured
created_at: '2024-05-02T12:32:49.033945Z'
updated_at: '2024-05-02T12:32:57.003519Z'
token: 294358bf-3818-49b2-aacc-7ca971f52695
amount: 100
currency: GBP
settled_amount: 79
settled_currency: GBP
billing_address:
street_line_1: 123 Example Street
street_line_2: Building A, 3rd Floor
city: Example City
region: Example Region
country_code: GB
postcode: E14 4HD
risk_level: low
fees:
- type: acquiring
amount: 21
currency: GBP
payment_method:
type: card
fingerprint: 1JAllfQY4POhBV8DaddAQ4LC5RbMP8LMLvUdJW4s5JY=
card_brand: visa
funding: credit
card_country_code: GB
card_bin: '123456'
card_last_four: '1234'
card_expiry: 12/30
cardholder_name: Test Holder
checks:
three_ds:
eci: '06'
state: verified
version: 2
cvv_verification: match
address: match
postcode: match
cardholder: n_a
order_id: 663387bd-8484-ac57-93a7-3751dc154bbc
card_three_ds_fingerprint:
$ref: '#/components/examples/Res-Payment-Authentication-Challenge-Fingerprint'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errorId:
type: string
description: 'The ID of the error. You can share this ID with Revolut
support for troubleshooting.'
timestamp:
type: integer
description: The date and time the error happened.
examples:
example-1:
value:
errorId: 94b27660-fdda-49ec-8b85-cd46a068ade0
timestamp: 1601296792533
'401':
description: Unauthorized
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
errorId:
type: string
description: 'The ID of the error. You can share this ID with Revolut
support for troubleshooting.'
timestamp:
type: integer
description: The date and time the error happened.
code:
type: integer
examples:
example-1:
value:
errorId: 94b27660-fdda-49ec-8b85-cd46a068ade0
timestamp: 1601296792533
code: 1024
security:
- Api-Key: []
tags:
- Payments
components:
schemas:
Payment-Retrieval:
type: object
properties:
id:
$ref: '#/components/schemas/Payment-Id'
order_id:
$ref: '#/components/schemas/Order-Id'
payment_method:
type: object
description: The payment method used to pay for the order.
discriminator:
propertyName: type
mapping:
revolut_pay: '#/components/schemas/Revolut-Pay'
card: '#/components/schemas/Card-For-Payment-Details'
sepa_direct_debit: '#/components/schemas/Sepa-Direct-Debit'
oneOf:
- $ref: '#/components/schemas/Revolut-Pay'
- $ref: '#/components/schemas/Card-For-Payment-Details'
- $ref: '#/components/schemas/Sepa-Direct-Debit'
token:
$ref: '#/components/schemas/Payment-Token'
amount:
$ref: '#/components/schemas/Payment-Amount'
currency:
$ref: '#/components/schemas/Currency'
state:
$ref: '#/components/schemas/Payment-State-v2'
decline_reason:
$ref: '#/components/schemas/Decline-Reason-v2'
authentication_challenge:
$ref: '#/components/schemas/Authentication-Challenge'
required:
- id
- order_id
- payment_method
Card:
type: object
description: Object containing details of the card used for the payment.
properties:
id:
type: string
format: uuid
description: 'ID of the saved payment method.
:::note
The `id` parameter is only returned when the payment method is saved.
:::'
type:
$ref: '#/components/schemas/Payment-Method-Type'
card_brand:
type: string
description: The type of the card.
enum:
- visa
- mastercard
- american_express
funding:
type: string
description: The type of card funding.
enum:
- credit
- debit
- prepaid
card_country_code:
type: string
description: The 2-letter country code of the country where the card was issued.
card_bin:
type: string
description: The BIN of the card.
minLength: 6
maxLength: 6
card_last_four:
type: string
description: The last four digits of the card number.
minLength: 4
maxLength: 4
card_expiry:
type: string
format: MM/YY
description: The expiry date of the card in the format of MM/YY.
cardholder_name:
type: string
description: The name of the cardholder.
checks:
$ref: '#/components/schemas/Card-Checks-v2'
authorisation_code:
$ref: '#/components/schemas/Authorisation-Code'
arn:
$ref: '#/components/schemas/Arn'
capture_deadline:
$ref: '#/components/schemas/Capture-Deadline'
terminal_hardware_id:
$ref: '#/components/schemas/Terminal-Hardware-Id'
fingerprint:
$ref: '#/components/schemas/Fingerprint'
network_transaction_id:
$ref: '#/components/schemas/Network-Transaction-Id'
required:
- type
Sepa-Direct-Debit-Debtor-Name:
type: string
description: The full name of the debtor as provided in the mandate.
Sepa-Direct-Debit-Debtor-Iban-Last-Four:
type: string
description: The last four digits of the debtor's IBAN.
minLength: 4
maxLength: 4
Revolut-Pay-Account:
type: object
properties:
id:
type: string
format: uuid
description: 'ID of the saved payment method.
:::note
The `id` parameter is only returned when the payment method is saved.
:::'
type:
$ref: '#/components/schemas/Payment-Method-Type'
fingerprint:
$ref: '#/components/schemas/Fingerprint'
required:
- type
Sepa-Direct-Debit:
type: object
description: 'Object containing details of a SEPA Direct Debit payment.
:::info
For more information, see: [SEPA Direct Debit server-to-server integration](https://developer.revolut.com/docs/guides/merchant/accept-payments/payment-methods/sepa-direct-debit/server-to-server)
:::'
properties:
id:
type: string
format: uuid
description: 'ID of the saved payment method.
:::note
The `id` parameter is only returned when the payment method is saved for the merchant.
:::'
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/revolut/refs/heads/main/openapi/revolut-payments-api-openapi.yml