Dojo Payment intents API

openapi: 3.2.0
info:
  title: Dojo Payment intents API
  version: '2026-02-27'
  description: "# Introduction\n\nThe Dojo API is a REST API, using HTTP response codes to convey status, including successful responses and errors. Additionally, it accepts and returns JSON in the HTTP body.\nFor information on the latest development progress, visit the [changelog](../changelog).\n\n## Base URLs\n\nUse the following base URL when making requests to the API:  https://api.dojo.tech/\n\n## Authentication\n\nThe Dojo API uses [Basic HTTP authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). You can generate API keys in the [Developer Portal](https://developer.dojo.tech).\nSecret keys for the test environment use the prefix `sk_sandbox_`. Production keys use the prefix `sk_prod_`.\n\nYou must include your secret API key in the header of all requests, for example:\n\n```curl\n  --header 'content-type: application/json' \\\n  --header 'Authorization: Basic sk_prod_your_key' \\\n```\n\nAPI requests without authentication will fail.\n\n## Additional Required Headers\n\nThe following headers are required on Terminal and Terminal Sessions API requests, requests without them will fail.\n\n- `reseller-id` - Identifies the reseller who sells software on behalf of the EPOS company. This value will be unique and provided by Dojo to each reseller.\n- `software-house-id` - Identifies the EPOS company whose software is generating the request. This value shouldn't be configurable, as it will remain the same for all customers using particular EPOS software. This value will be provided by Dojo.\n\n## HTTP Responses\n\nThe API returns standard HTTP response codes [RFC 7231](https://tools.ietf.org/html/rfc7231#section-6) on each request to indicate the success or otherwise of API requests. Summaries for each HTTP code are listed below:\n\n* `200 OK`—The request was successful.\n\n* `201 Created`—The request was successful, and a new resource was created as a result.\n\n* `204 No Content`—The request was successful, but there is no content to send.\n\n* `400 Bad Request`—Bad request, probably due to a syntax error.\n\n* `401 Unauthorized`—Authentication required.\n\n* `403 Forbidden`—The API key doesn't have permissions.\n\n* `404 Not Found`—The resource doesn't exist.\n\n* `405 Method Not Allowed`—The request method is known by the server but isn't supported by the target resource.\n\n* `409 Conflict`—The request couldn't be completed because it conflicted with another request or the server's configuration.\n\n* `500`, `502`, `503`, `504` `Server Errors`—An error occurred with our API.\n\n## Errors\n\nDojo follows the error response format proposed in [RFC 7807](https://tools.ietf.org/html/rfc7807), also known as Problem Details for HTTP APIs. All errors are returned in the form of JSON.\n\n### Error Schema\n\nIn case of an error, the response object contains the following fields:\n\n* `errors` [object]—A human-readable explanation of errors.\n\n* `type` [string]—\nA URI reference RFC 3986 that identifies the problem type.\n\n* `title` [string]—A short, human-readable summary of the error.\n\n* `status` [integer]—The HTTP status code.\n\n* `detail` [string]—A human-readable message giving more details about the error. Not always present.\n\n* `traceId` [string]—The unique identifier of the failing request.\n\nThe following example shows a possible error response:\n\n```json\n{\n    \"errors\": {\n        \"Reference\": [\n            \"The Reference field is required.\"\n        ]\n    },\n    \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n    \"title\": \"One or more validation errors occurred.\",\n    \"status\": 400,\n    \"traceId\": \"00-a405f077df056a498323ffbcec05923f-aa63e6f4dbbc734a-01\",\n}\n```\n\n## Versioning\n\nDojo APIs use the yyyy-mm-dd API version-naming scheme. You have to pass the version as the `version` header in all API calls, for example:\n\n``` curl\n  --header 'content-type: application/json' \\\n  --header 'Authorization: Basic sk_prod_your_key' \\\n  --header 'version: 2026-02-27' \\\n```\n\nWhen we make [breaking changes](../development-resources/versioning-overview#breaking-changes) to the API, we release new dated versions.\n\nThe current version is `2026-02-27`.\n\n## SDKs\nUse our PHP, .NET, and mobile [client libraries](/development-resources/sdk) to build your integration.\n\n## Code Samples\n\nGet help in building your integration with our [code samples](/development-resources/code-samples).\n"
  termsOfService: https://dojo.tech/legal/
  contact:
    name: Dojo Developer Experience Team
servers:
- url: https://api.dojo.tech
security:
- ApiKeyAuth: []
tags:
- name: Payment intents
  description: 'Allows you to take and manage payments.


    **Documentation**: [Payment intents](../../payments/manage-payments/payment-intent)'
paths:
  /payment-intents:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentIntentRequest'
            examples:
              Auto:
                value:
                  amount:
                    value: 1000
                    currencyCode: GBP
                  reference: Order 234
                  description: Demo payment intent
                  captureMode: Auto
              Manual:
                value:
                  amount:
                    value: 1000
                    currencyCode: GBP
                  reference: Order 234
                  description: Demo payment intent
                  captureMode: Manual
                  AutoExpireAction: Capture
                  AutoExpireIn: 00:00:55
        required: true
        x-name: createPaymentIntentRequest
        x-position: 1
      tags:
      - Payment intents
      parameters:
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntent'
              examples:
                Auto:
                  value:
                    id: pi_sandbox_G_FeegU8WESxtY_Nct8jqw
                    captureMode: Auto
                    cardHolderNotPresent: false
                    clientSessionSecretExpirationDate: '0001-01-01T00:00:00Z'
                    status: Created
                    paymentMethods:
                    - Card
                    amount:
                      value: 1000
                      currencyCode: GBP
                    totalAmount:
                      value: 1000
                      currencyCode: GBP
                    refundedAmount: 0
                    createdAt: '2024-04-07T23:25:44.802258Z'
                    updatedAt: '2024-04-07T23:25:44.802258Z'
                    reference: Order 234
                    description: Demo payment intent
                    itemLines: []
                    taxLines: []
                    merchantConfig:
                      supportedPaymentMethods:
                        cardSchemes:
                        - VISA
                        - MASTERCARD
                        - MAESTRO
                        - DISCOVER
                        - DCI
                        wallets:
                        - APPLE_PAY
                        - GOOGLE_PAY
                    config:
                      branding: {}
                      tradingName: Cam Test Ltd
                    paymentSource: api
                    expireAt: '2024-05-07T23:25:44.8023189Z'
                    metadata:
                      location-id: rpl_bOppxLvOEsS
                    paymentEvents: []
                    paymentLink: https://pay.dojo.tech:443/checkout/pi_sandbox_G_FeegU8WESxtY_Nct8jqw
                    terminalSessionHistory: []
                Manual:
                  value:
                    id: pi_sandbox_LXGmW_Rlv0CN5WlBimQg5A
                    captureMode: Manual
                    cardHolderNotPresent: false
                    clientSessionSecretExpirationDate: '0001-01-01T00:00:00Z'
                    status: Created
                    paymentMethods:
                    - Card
                    amount:
                      value: 1000
                      currencyCode: GBP
                    totalAmount:
                      value: 1000
                      currencyCode: GBP
                    refundedAmount: 0
                    createdAt: '2024-04-07T23:24:53.3770815Z'
                    updatedAt: '2024-04-07T23:24:53.3770816Z'
                    reference: Order 234
                    description: Demo payment intent
                    itemLines: []
                    taxLines: []
                    merchantConfig:
                      supportedPaymentMethods:
                        cardSchemes:
                        - VISA
                        - MASTERCARD
                        - MAESTRO
                        - DISCOVER
                        - DCI
                        wallets:
                        - APPLE_PAY
                        - GOOGLE_PAY
                    config:
                      branding: {}
                      tradingName: Cam Test Ltd
                    paymentSource: api
                    autoExpireAction: Capture
                    expireAt: '2024-05-07T23:24:53.3771391Z'
                    autoExpireIn: 00:00:55
                    metadata:
                      location-id: rpl_bOppxLvOEsS
                    paymentEvents: []
                    paymentLink: https://pay.dojo.tech:443/checkout/pi_sandbox_LXGmW_Rlv0CN5WlBimQg5A
                    terminalSessionHistory: []
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Forbidden
      operationId: PaymentIntents_CreatePaymentIntent
      summary: Create a payment intent
      description: Creates a payment intent.
  /payment-intents/{paymentIntentId}:
    get:
      tags:
      - Payment intents
      parameters:
      - example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw
        name: paymentIntentId
        description: 'The unique identifier of the payment intent.

          '
        schema:
          type:
          - string
          - 'null'
        in: path
        required: true
        x-position: 1
      - name: returnCanceled
        description: If the value is `true`, and the payment intent being retrieved has a status of `Canceled`, the payment intent will be returned in the response. Otherwise a 404 (not found) status code will be returned.
        schema:
          type: boolean
        in: query
        required: false
        x-position: 2
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntent'
              example:
                id: pi_sandbox_S_zeCMipQkSG9fFmqS-ceQ
                captureMode: Auto
                cardHolderNotPresent: false
                clientSessionSecret: bHte6dGrBuOoMwOgKGG3X3s2HFKERz3rbZ2SLD-H_BU_1wy-b3IgRCIUtgm7pZXh1QJC70slbaaNvm0XUcZ7T3UL8LRUMz5HK529D23ITvv_QaeIbrV8nI6Y-pxeDuqn444VqHAEok7Ue0Wsg5HgXz327lXV_A==
                clientSessionSecretExpirationDate: '2024-07-25T09:19:10Z'
                paymentDetails:
                  transactionId: 19e4535e-ef6e-48e2-90be-d2b313c1cefd
                  transactionDateTime: '2024-07-25T08:49:20.973410318Z'
                  message: DEPOSITED
                  authCode: '123456'
                  card:
                    cardNumber: 44565300****1096
                    cardName: test
                    expiryDate: '2024-12-31'
                    cardType: VISA
                    cardFundingType: Unknown
                    entryMode: Contactless
                    verificationMethod: Pin
                  avsResult: ADDRESS_MATCH_POSTCODE_MATCH
                status: Captured
                paymentMethods:
                - Card
                amount:
                  value: 1000
                  currencyCode: GBP
                totalAmount:
                  value: 1000
                  currencyCode: GBP
                refundedAmount: 0
                billingAddress:
                  address1: ''
                  address2: ''
                  address3: ''
                  address4: ''
                  city: ''
                  state: ''
                  postcode: ''
                  countryCode: ''
                shippingDetails:
                  name: ''
                  address:
                    address1: ''
                    address2: ''
                    address3: ''
                    address4: ''
                    city: ''
                    state: ''
                    postcode: ''
                    countryCode: ''
                createdAt: '2024-07-25T08:48:38.497Z'
                updatedAt: '2024-07-25T08:49:24.761Z'
                reference: Order 234
                description: Demo payment intent
                itemLines: []
                taxLines: []
                merchantConfig:
                  supportedPaymentMethods:
                    cardSchemes:
                    - VISA
                    - MASTERCARD
                    - MAESTRO
                    - DISCOVER
                    - DCI
                    - AMEX
                    wallets:
                    - APPLE_PAY
                    - GOOGLE_PAY
                config:
                  branding: {}
                  tradingName: I DIM SUM
                paymentSource: api
                expireAt: '2024-08-24T08:48:38.498Z'
                metadata:
                  location-id: '202059233225269'
                paymentEvents:
                - transactionId: 19e4535e-ef6e-48e2-90be-d2b313c1cefd
                  transactionDateTime: '2024-07-25T08:49:20.973410318Z'
                  eventType: AuthChallenged
                  authCode: ''
                  cardNumber: 44565300****1096
                  expiryDate: '2024-12-31'
                  cardType: VISA
                  cardholderName: test
                  paymentMethodId: ''
                - transactionId: 19e4535e-ef6e-48e2-90be-d2b313c1cefd
                  transactionDateTime: '2024-07-25T08:49:20.973410318Z'
                  eventType: Captured
                  authCode: '123456'
                  cardNumber: 44565300****1096
                  expiryDate: '2024-12-31'
                  cardType: VISA
                  cardholderName: test
                  paymentMethodId: ''
                paymentLink: https://pay.dojo.tech:443/checkout/pi_sandbox_S_zeCMipQkSG9fFmqS-ceQ
                terminalSessionHistory: []
                captures: []
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Not found
      operationId: PaymentIntents_Get
      summary: Retrieve a payment intent
      description: Retrieves the details of a payment intent.
    delete:
      tags:
      - Payment intents
      parameters:
      - $ref: '#/components/parameters/Version'
      - example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw
        name: paymentIntentId
        description: 'The unique identifier of the payment intent.

          '
        schema:
          type:
          - string
          - 'null'
        in: path
        required: true
        x-position: 1
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntent'
              example:
                id: pi_sandbox_6p477TZOmECe5zUHszJCCg
                captureMode: Auto
                clientSessionSecret: DIi9C5SJTyI4V62Eqw00_vD47U3fmFsFSRVvuY--gTRVMb1TxCmudI0Nl4GUTEHTxzwWGqIkYEXQ7aWgwZFC4rmPE8gTLN_rxGeqpihGm1YvSiuKQTREQW50TmDKUMxklbqnenGvnjdKruNFhpBFQBXR-Ni_8g==
                clientSessionSecretExpirationDate: '2024-02-13T02:55:34Z'
                status: Canceled
                paymentMethods:
                - Card
                amount:
                  value: 1000
                  currencyCode: GBP
                totalAmount:
                  value: 1000
                  currencyCode: GBP
                refundedAmount: 0
                createdAt: '2024-02-13T02:25:34.17Z'
                updatedAt: '2024-02-13T02:25:34.17Z'
                reference: Order 234
                description: Demo payment intent
                itemLines: []
                taxLines: []
                merchantConfig:
                  supportedPaymentMethods:
                    cardSchemes:
                    - VISA
                    - MASTERCARD
                    - MAESTRO
                    - DISCOVER
                    - DCI
                    - AMEX
                    wallets:
                    - APPLE_PAY
                    - GOOGLE_PAY
                config:
                  branding:
                    logoUrl: https://cdn.dojo.tech/payments/branding/logos/acc_wrr9HHrH10KHXtVxfWNPHw/file_y-_CuT9RLkKK2vvvLaGeUw/90395f2a-029e-4f23-afdb-258bdbb1002b.png
                    faviconUrl: https://cdn.dojo.tech/payments/branding/favicons/acc_wrr9HHrH10KHXtVxfWNPHw/file_v7EuxUbMmkCUMm7lP9PIgg/dojo.png
                  tradingName: Dojo Cafe (Paymentsense)
                paymentSource: api
                expireAt: '2024-03-14T02:25:34.17Z'
                metadata:
                  location-id: '771402011592305'
                paymentEvents: []
                paymentLink: https://pay.dojo.tech:443/checkout/pi_sandbox_6p477TZOmECe5zUHszJCCg
                terminalSessionHistory: []
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Not found
      operationId: PaymentIntents_Delete
      summary: Cancel a payment intent
      description: Cancels a payment intent. If a payment intent's status is `Created`, it can be canceled. After cancellation, the payment intent status will change to `Canceled` and any operations will fail with an error.
  /payment-intents/{paymentIntentId}/charge:
    post:
      tags:
      - Payment intents
      summary: Charge a card
      operationId: PaymentIntents_ChargePaymentIntent
      description: Allows you to charge a card later. This is available for merchant-initiated transactions only.
      parameters:
      - $ref: '#/components/parameters/Version'
      - name: paymentIntentId
        in: path
        required: true
        schema:
          type:
          - string
          - 'null'
        description: 'The unique identifier of the payment intent.

          '
        x-position: 3
        example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeResponse'
              example:
                paymentIntentId: pi_sandbox_TRVit9jxx0KLSVW48a-K_w
                status: Successful
                message: DEPOSITED
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /payment-intents/{paymentIntentId}/refresh-client-session-secret:
    post:
      tags:
      - Payment intents
      operationId: PaymentIntents_RefreshClientSessionSecret
      parameters:
      - $ref: '#/components/parameters/Version'
      - name: paymentIntentId
        in: path
        required: true
        schema:
          type:
          - string
          - 'null'
        description: 'The unique identifier of the payment intent.

          '
        x-position: 1
        example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntent'
              example:
                id: pi_sandbox_H8tBljY-O0GZZpHA-kC8UQ
                captureMode: Auto
                clientSessionSecret: y4I5IegbtuzHR-tLn4S4ONlK0felINimLd_a2x_y3h1zwKTXFRowSZG3amVGmaRBxxCqy7ynJhh8IN9mMwEpFeUPZKJyMWEFPPAmAJ8_5pPtaK11SPvUg-WT2erSkT-e34oo4dwrsBx6igxEPBCEV-OBBu74HA==
                clientSessionSecretExpirationDate: '2024-02-13T14:50:28Z'
                status: Created
                paymentMethods:
                - Card
                amount:
                  value: 1000
                  currencyCode: GBP
                totalAmount:
                  value: 1000
                  currencyCode: GBP
                refundedAmount: 0
                createdAt: '2024-02-13T14:20:14.418Z'
                updatedAt: '2024-02-13T14:20:28.2961052Z'
                reference: Order 234
                description: Demo payment intent
                itemLines: []
                taxLines: []
                merchantConfig:
                  supportedPaymentMethods:
                    cardSchemes:
                    - VISA
                    - MASTERCARD
                    - MAESTRO
                    - DISCOVER
                    - DCI
                    - AMEX
                    wallets:
                    - APPLE_PAY
                    - GOOGLE_PAY
                config:
                  branding:
                    logoUrl: https://cdn.dojo.tech/payments/branding/logos/acc_wrr9HHrH10KHXtVxfWNPHw/file_y-_CuT9RLkKK2vvvLaGeUw/90395f2a-029e-4f23-afdb-258bdbb1002b.png
                    faviconUrl: https://cdn.dojo.tech/payments/branding/favicons/acc_wrr9HHrH10KHXtVxfWNPHw/file_v7EuxUbMmkCUMm7lP9PIgg/dojo.png
                  tradingName: Dojo Cafe (Paymentsense)
                paymentSource: api
                expireAt: '2024-03-14T14:20:14.418Z'
                metadata:
                  location-id: '771402011592305'
                paymentEvents: []
                paymentLink: https://pay.dojo.tech:443/checkout/pi_sandbox_H8tBljY-O0GZZpHA-kC8UQ
                terminalSessionHistory: []
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Update a client session secret
      description: Updates a client session secret if the current secret key has been consumed or expired. These tokens are one-time use only. If you need to retry a payment, you must generate a new token.
  /payment-intents/search:
    post:
      tags:
      - Payment intents
      operationId: PaymentIntents_Search
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchPaymentIntentRequest'
        required: true
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedPaymentIntent'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      parameters:
      - $ref: '#/components/parameters/Version'
      summary: List all payment intents
      description: 'Retrieves a list of payment intents.

        Results are paginated. By default, the method returns up to 50 payment intents.'
  /payment-intents/{paymentIntentId}/tips-amount:
    post:
      tags:
      - Payment intents
      operationId: PaymentIntents_SetTipsAmount
      parameters:
      - $ref: '#/components/parameters/Version'
      - name: paymentIntentId
        in: path
        required: true
        description: 'The unique identifier of the payment intent.

          '
        schema:
          type:
          - string
          - 'null'
        x-position: 1
        example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetTipsAmountRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntent'
              example:
                id: pi_sandbox_G_FeegU8WESxtY_Nct8jqw
                captureMode: Auto
                cardHolderNotPresent: false
                clientSessionSecretExpirationDate: '0001-01-01T00:00:00Z'
                status: Created
                paymentMethods:
                - Card
                amount:
                  value: 1000
                  currencyCode: GBP
                totalAmount:
                  value: 1000
                  currencyCode: GBP
                refundedAmount: 0
                createdAt: '2024-04-07T23:25:44.802258Z'
                updatedAt: '2024-04-07T23:25:44.802258Z'
                reference: Order 234
                description: Demo payment intent
                itemLines: []
                taxLines: []
                merchantConfig:
                  supportedPaymentMethods:
                    cardSchemes:
                    - VISA
                    - MASTERCARD
                    - MAESTRO
                    - DISCOVER
                    - DCI
                    wallets:
                    - APPLE_PAY
                    - GOOGLE_PAY
                config:
                  branding: {}
                  tradingName: Cam Test Ltd
                paymentSource: api
                expireAt: '2024-05-07T23:25:44.8023189Z'
                metadata:
                  location-id: rpl_bOppxLvOEsS
                paymentEvents: []
                paymentLink: https://pay.dojo.tech:443/checkout/pi_sandbox_G_FeegU8WESxtY_Nct8jqw
                terminalSessionHistory: []
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '405':
          description: Method not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Change tips amount
      description: 'Changes tip amount for a payment intent. Available if you enabled tipping when creating the payment intent.

        <!-- Check if tips or gratuity exists>'
  /payment-intents/{paymentIntentId}/amount:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetAmountRequest'
        required: true
        x-name: request
        x-position: 2
      tags:
      - Payment intents
      parameters:
      - $ref: '#/components/parameters/Version'
      - example: pi_sandbox_RBMHTJ4fIkmSppDILZVCGw
        name: paymentIntentId
        description: 'The unique identifier of the payment intent.

          '
        schema:
          type:
          - string
          - 'null'
        in: path
        required: true
        x-position: 1
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntent'
              example:
                id: pi_sandbox_xt4SwkRZ60moZFWJ9iOKrw
                captureMode: Auto
                cardHolderNotPresent: false
                clientSessionSecret: NoK0mY76TgasoZdQ-X9xDZ3jYGDq1lMg0frwxbOVMz2xXqbRzpseN6dXtoMOzjDZVz82Y0C2xGLj4Zys1PZqu1u7F4mj9fV9aK7C7fQn90tIyp3sM3ws0U8mpgfbPc4WPAxYo8BFHkZ2PggnaUH-vL00kDbreg==
                clientSessionSecretExpirationDate: '2024-04-10T23:23:13Z'
                status: Created
                paymentMethods:
                - Card
                amount:
                  value: 5500
                  currencyCode: GBP
                requestedAmount:
                  value: 1000
                  currencyCode: GBP
                totalAmount:
                  value: 5500
                  currencyCode: GBP
                refundedAmount: 0
                createdAt: '2024-04-10T22:52:58.037Z'
                updatedAt: '2024-04-10T22:53:13.6644908Z'
                reference: Order 234
                description: Demo payment intent
                itemLines: []
                taxLines: []
                merchantConfig:
                  supportedPaymentMethods:
                    cardSchemes:
                    - VISA
                    - MASTERCARD
                    - MAESTRO
                    - DISCOVER
                    - DCI
                    - AMEX
                    wallets:
                    - APPLE_PAY
                    - GOOGLE_PAY
                config:
                  payment:
                    customAmountAllowed: true
                    tipsAllowed: true
                  branding:
                    logoUrl: https://cdn.dojo.tech/payments/branding/logos/acc_wrr9HHrH10KHXtVxfWNPHw/file_y-_CuT9RLkKK2vvvLaGeUw/90395f2a-029e-4f23-afdb-258bdbb1002b.png
                    faviconUrl: https://cdn.dojo.tech/payments/branding/favicons/acc_wrr9HHrH10KHXtVxfWNPHw/file_v7EuxUbMmkCUMm7lP9PIgg/dojo.png
                  tradingName: Dojo Cafe (Paymentsense)
                paymentSource: api
                expireAt: '2024-05-10T22:52:58.037Z'
                metadata:
                  location-id: '771402011592305'
                paymentEvents: []
                paymentLink: https://pay.dojo.tech:443/checkout/pi_sandbox_xt4SwkRZ60moZFWJ9iOKrw
                terminalSessionHistory: []
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Unauthorized
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Method not allowed
      operationId: PaymentIntents_SetCustomAmount
      summary: Change a payment intent amount
      description: Changes the paymen

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dojo/refs/heads/main/openapi/dojo-payment-intents-api-openapi.yml