Revolut Payment intents API

openapi: 3.2.0
info:
  title: Merchant Payment intents API
  version: '2026-04-20'
  description: Welcome to the Revolut Merchant API - your solution to managing the core aspects of e-commerce and accepting online payments.
  contact: {}
servers:
- description: Production server (uses live data)
  url: https://merchant.revolut.com
- description: Sandbox server (uses test data)
  url: https://sandbox-merchant.revolut.com
security:
- Api-Key: []
tags:
- name: Payment Intents
  description: Operations for managing payment intents in the push payments to Revolut Terminal flow.
paths:
  /api/orders/{order_id}/payment-intents:
    parameters:
    - $ref: '#/components/parameters/Authorization'
    - $ref: '#/components/parameters/Revolut-Api-Version-Optional'
    - $ref: '#/components/parameters/Order-Id'
    post:
      summary: Create a payment intent
      operationId: createPaymentIntent
      description: 'Create a payment intent to push a payment request to a specific Revolut Terminal device.


        This endpoint is used in push payments to Revolut Terminal integration, where a POS system sends payment requests to physical terminal devices. The terminal must be in Pay at Counter mode and assigned to the same location as the order.


        **Requirements:**

        - Order must be created with `channel: "pos"` and include a `location_id`

        - Terminal must be online, in `pos` operation mode, and assigned to the same location

        - Amount must match the order amount


        **What happens next:**

        - The payment request appears on the Revolut Terminal screen

        - Customer presents their card or device to complete payment

        - You should poll the payment intent status until it reaches a final state (`completed`, `cancelled`, or `failed`)

        - When the payment intent reaches `completed` state, use the returned `payment_id` to retrieve the final payment status


        :::info

        For the complete push payments flow, see: Push payments to Revolut Terminal.

        :::'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Payment-Intent-Creation'
            examples:
              create_payment_intent:
                $ref: '#/components/examples/Req-Payment-Intent'
      responses:
        '201':
          description: Payment intent created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment-Intent'
              examples:
                payment_intent_pending:
                  $ref: '#/components/examples/Res-Payment-Intent-Pending'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - Api-Key: []
      tags:
      - Payment Intents
  /api/payment-intents/{payment_intent_id}:
    parameters:
    - $ref: '#/components/parameters/Authorization'
    - $ref: '#/components/parameters/Revolut-Api-Version-Optional'
    - $ref: '#/components/parameters/Payment-Intent-Id'
    get:
      summary: Retrieve a payment intent
      operationId: retrievePaymentIntent
      description: 'Retrieve the current state and details of a payment intent.


        This endpoint is used to poll the payment intent status after pushing a payment request to a Revolut Terminal. You should poll this endpoint repeatedly until the payment intent reaches a final state.


        **Payment intent states:**


        | State | Description |

        |-------|-------------|

        | `pending` | Payment intent created and sent to terminal, customer has not yet started interacting |

        | `processing` | Customer is actively interacting with the terminal (e.g., inserting card, entering PIN) |

        | `completed` | Payment authorisation is complete, response includes a `payment_id` that you should use to retrieve the final payment status |

        | `cancelled` | Payment intent was cancelled (by your system or by the customer on the terminal) |

        | `failed` | Payment intent failed due to technical issues (e.g., timeout, terminal became unavailable) |


        :::tip [Polling strategy]

        - Poll every second while the state is `pending` or `processing`

        - Set a reasonable timeout (e.g., 60 seconds) to handle cases where the customer abandons the payment

        :::


        :::info

        For the complete push payments flow, see: Push payments to Revolut Terminal.

        :::'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment-Intent'
              examples:
                payment_intent_pending:
                  $ref: '#/components/examples/Res-Payment-Intent-Pending'
                payment_intent_processing:
                  $ref: '#/components/examples/Res-Payment-Intent-Processing'
                payment_intent_completed:
                  $ref: '#/components/examples/Res-Payment-Intent-Completed'
                payment_intent_cancelled:
                  $ref: '#/components/examples/Res-Payment-Intent-Cancelled'
                payment_intent_failed:
                  $ref: '#/components/examples/Res-Payment-Intent-Failed'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - Api-Key: []
      tags:
      - Payment Intents
  /api/payment-intents/{payment_intent_id}/cancel:
    parameters:
    - $ref: '#/components/parameters/Authorization'
    - $ref: '#/components/parameters/Revolut-Api-Version-Optional'
    - $ref: '#/components/parameters/Payment-Intent-Id'
    post:
      summary: Cancel a payment intent
      operationId: cancelPaymentIntent
      description: 'Cancel a payment intent while it''s still in `pending` state, before the customer has completed the payment.


        This is useful if the customer changes their mind or if there''s an issue with the order before payment is completed.


        :::warning

        **Requirements:**

        - Payment intent must be in `pending` state

        - Cannot cancel payment intents that are already `completed`, `cancelled`, or `failed`

        :::


        :::info

        For the complete push payments flow, see: Push payments to Revolut Terminal.

        :::'
      responses:
        '200':
          description: Payment intent cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment-Intent'
              examples:
                payment_intent_cancelled:
                  $ref: '#/components/examples/Res-Payment-Intent-Cancelled'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - Api-Key: []
      tags:
      - Payment Intents
components:
  examples:
    Res-Payment-Intent-Failed:
      summary: Payment intent failed
      value:
        id: b4d58add-b3fe-40e4-a70a-8c78df977888
        state: failed
        terminal_id: 0e53f673-7705-473a-a263-89a3e7647c3d
        order_id: 5c9fc54e-11b4-4f7f-8686-4a64d4d20db4
        amount: 2500
        currency: GBP
        created_at: '2025-01-15T11:01:00Z'
        updated_at: '2025-01-15T11:03:00Z'
    Res-Payment-Intent-Completed:
      summary: Payment intent completed
      value:
        id: b4d58add-b3fe-40e4-a70a-8c78df977888
        state: completed
        terminal_id: 0e53f673-7705-473a-a263-89a3e7647c3d
        order_id: 5c9fc54e-11b4-4f7f-8686-4a64d4d20db4
        payment_id: 7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d
        amount: 2500
        currency: GBP
        created_at: '2025-01-15T11:01:00Z'
        updated_at: '2025-01-15T11:02:30Z'
    Res-Payment-Intent-Cancelled:
      summary: Payment intent cancelled
      value:
        id: b4d58add-b3fe-40e4-a70a-8c78df977888
        state: cancelled
        terminal_id: 0e53f673-7705-473a-a263-89a3e7647c3d
        order_id: 5c9fc54e-11b4-4f7f-8686-4a64d4d20db4
        amount: 2500
        currency: GBP
        created_at: '2025-01-15T11:01:00Z'
        updated_at: '2025-01-15T11:01:45Z'
    Res-Payment-Intent-Pending:
      summary: Payment intent pending
      value:
        id: b4d58add-b3fe-40e4-a70a-8c78df977888
        state: pending
        order_id: 5c9fc54e-11b4-4f7f-8686-4a64d4d20db4
        amount: 2500
        currency: GBP
    Req-Payment-Intent:
      summary: Create payment intent request example
      value:
        amount: 2500
        terminal_id: 0e53f673-7705-473a-a263-89a3e7647c3d
    Res-Payment-Intent-Processing:
      summary: Payment intent processing
      value:
        id: b4d58add-b3fe-40e4-a70a-8c78df977888
        order_id: 5c9fc54e-11b4-4f7f-8686-4a64d4d20db4
        state: processing
        amount: 2500
        currency: GBP
        terminal_id: 0e53f673-7705-473a-a263-89a3e7647c3d
        created_at: '2025-01-15T11:01:00Z'
        updated_at: '2025-01-15T11:02:15Z'
  schemas:
    Payment-Intent:
      title: Payment Intent
      type: object
      description: 'Represents a payment intent that has been pushed to a Revolut Terminal device.


        When the payment intent reaches `completed` state, it includes a `payment_id` that can be used to [retrieve the final payment status](https://developer.revolut.com/docs/api/merchant#retrieve-payment-details).'
      properties:
        id:
          $ref: '#/components/schemas/Payment-Intent-Id'
        state:
          $ref: '#/components/schemas/Payment-Intent-State'
        terminal_id:
          $ref: '#/components/schemas/Terminal-Id'
        order_id:
          $ref: '#/components/schemas/Order-Id'
        payment_id:
          $ref: '#/components/schemas/Payment-Id'
        amount:
          $ref: '#/components/schemas/Payment-Intent-Amount'
        currency:
          $ref: '#/components/schemas/Currency'
        created_at:
          type: string
          format: date-time
          description: The date and time the payment intent was created.
        updated_at:
          type: string
          format: date-time
          description: The date and time the payment intent was last updated.
      required:
      - id
      - order_id
      - state
      - amount
      - currency
      - terminal_id
      - created_at
      - updated_at
    Error:
      title: Error
      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.
      required:
      - errorId
      - timestamp
    Order-Id:
      type: string
      format: uuid
      description: Permanent order ID used to retrieve, capture, cancel, or refund an order after authorization.
    Payment-Id:
      type: string
      format: uuid
      description: The ID of the payment.
    Payment-Intent-Id:
      title: Payment Intent ID
      type: string
      format: uuid
      description: The unique identifier of the payment intent.
    Terminal-Id:
      title: Terminal ID
      type: string
      format: uuid
      description: The unique identifier of the terminal.
    Payment-Intent-Creation:
      title: Payment Intent creation
      type: object
      description: Request body for creating a payment intent to push to a terminal.
      properties:
        amount:
          $ref: '#/components/schemas/Payment-Intent-Amount'
        terminal_id:
          $ref: '#/components/schemas/Terminal-Id'
      required:
      - amount
      - terminal_id
    Payment-Intent-Amount:
      title: Payment Intent amount
      type: integer
      description: 'The payment amount expressed in minor currency units, according to the [ISO 4217 standard](https://en.wikipedia.org/wiki/ISO_4217). For example, `7034` in `EUR` corresponds to €70.34.


        :::info

        Conversion between major and minor units varies by currency. For instance, `100` minor units equal £1.00 in `GBP`, whereas in `ISK` they represent 100 units. For more details, see the [ISO 4217 standard](https://en.wikipedia.org/wiki/ISO_4217).

        :::'
    Currency:
      type: string
      format: ISO 4217
      minLength: 3
      maxLength: 3
      description: '[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case.


        :::info

        For more information about the supported currencies, see: [Help Center](https://help.revolut.com/business/help/merchant-accounts/payments/in-which-currencies-can-i-accept-payments/).

        :::'
    Payment-Intent-State:
      type: string
      description: 'The current state of the payment intent.


        | State | Description |

        |-------|-------------|

        | `pending` | Payment intent created and sent to terminal, customer has not yet started interacting |

        | `processing` | Customer is actively interacting with the terminal (e.g., inserting card, entering PIN) |

        | `completed` | Payment authorization is complete, includes a `payment_id` in the response |

        | `cancelled` | Payment intent was cancelled (by system or customer) |

        | `failed` | Payment intent failed due to technical issues (timeout, terminal unavailable, network error) |'
      enum:
      - pending
      - processing
      - completed
      - cancelled
      - failed
  parameters:
    Revolut-Api-Version-Optional:
      name: Revolut-Api-Version
      in: header
      schema:
        type: string
        format: date
        example: '2026-04-20'
        enum:
        - '2023-09-01'
        - '2024-05-01'
        - '2024-09-01'
        - '2025-10-16'
        - '2025-12-04'
        - '2026-03-12'
        - '2026-04-20'
      description: 'The version of the Merchant API, specified in `YYYY-MM-DD` format.


        :::info

        For more information about API versioning, see: [API versions](https://developer.revolut.com/docs/guides/merchant/reference/versioning/api-versions).

        :::'
      x-config-always-visible-in-example: true
    Payment-Intent-Id:
      name: payment_intent_id
      in: path
      required: true
      description: The unique identifier of the payment intent.
      schema:
        $ref: '#/components/schemas/Payment-Intent-Id'
    Authorization:
      name: Authorization
      in: header
      schema:
        type: string
        format: Bearer <yourSecretApiKey>
        example: Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq
      required: true
      description: "This parameter accepts the [Merchant API Secret key](https://business.revolut.com/settings/apis?tab=merchant-api) to authorise requests coming from the merchant's backend. \n\nIt ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a `Bearer` token.\n\n:::info\nFor more information, see: [Authentication](https://developer.revolut.com/docs/api/merchant#authentication)\n:::"
    Order-Id:
      name: order_id
      in: path
      schema:
        type: string
        format: uuid
        description: A UUID string, typically used to identify resources.
      required: true
      description: The ID of the `Order` object.
  securitySchemes:
    Api-Key:
      type: apiKey
      in: header
      name: Authorization
      description: 'Each Merchant API request must contain an authorization header in the following format:


        ```

        ''Authorization: Bearer <yourSecretApiKey>''

        ```


        To use this API, you need to generate API keys from your Revolut Business account. The Secret key is used in the authorization header for all server calls, while the Public key is provided with payment methods at checkout.


        :::info

        For detailed instructions on generating your API keys, see: [Generate API keys](https://developer.revolut.com/docs/guides/merchant/get-started#generate-api-keys).

        :::'