openapi: 3.1.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Account acceptDispute createPermit API
  description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
  x-timestamp: '2023-05-30T15:27:20Z'
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: createPermit
paths:
  /createPermit:
    post:
      tags:
      - createPermit
      summary: Adyen Create New Permits Linked to a Recurring Contract.
      description: Create permits for a recurring contract, including support for defining restrictions.
      x-addedInVersion: '40'
      operationId: post-createPermit
      x-sortIndex: 0
      x-methodName: createPermit
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePermitRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePermitResult'
              examples:
                post-createPermit200Example:
                  summary: Default post-createPermit 200 response
                  x-microcks-default: true
                  value:
                    permitResultList:
                    - example_value
                    pspReference: REF-001
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-createPermit400Example:
                  summary: Default post-createPermit 400 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-createPermit401Example:
                  summary: Default post-createPermit 401 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-createPermit403Example:
                  summary: Default post-createPermit 403 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-createPermit422Example:
                  summary: Default post-createPermit 422 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-createPermit500Example:
                  summary: Default post-createPermit 500 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreatePermitResult:
      properties:
        permitResultList:
          description: List of new permits.
          items:
            $ref: '#/components/schemas/PermitResult'
          type: array
        pspReference:
          description: A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.
          type: string
      type: object
    CreatePermitRequest:
      properties:
        merchantAccount:
          description: The merchant account identifier, with which you want to process the transaction.
          type: string
        permits:
          description: The permits to create for this recurring contract.
          items:
            $ref: '#/components/schemas/Permit'
          type: array
        recurringDetailReference:
          description: The recurring contract the new permits will use.
          type: string
        shopperReference:
          description: The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
          type: string
      required:
      - merchantAccount
      - shopperReference
      - recurringDetailReference
      - permits
      type: object
    Amount:
      properties:
        currency:
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
          maxLength: 3
          minLength: 3
          type: string
        value:
          description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          format: int64
          type: integer
      required:
      - value
      - currency
      type: object
    ServiceError:
      properties:
        additionalData:
          x-addedInVersion: '46'
          additionalProperties:
            type: string
          description: Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.
          type: object
        errorCode:
          description: The error code mapped to the error message.
          type: string
        errorType:
          description: The category of the error.
          type: string
        message:
          description: A short explanation of the issue.
          type: string
        pspReference:
          description: The PSP reference of the payment.
          type: string
        status:
          description: The HTTP response status.
          format: int32
          type: integer
      type: object
    Permit:
      properties:
        partnerId:
          description: Partner ID (when using the permit-per-partner token sharing model).
          type: string
        profileReference:
          description: The profile to apply to this permit (when using the shared permits model).
          type: string
        restriction:
          description: Permit level restriction overrides.
          $ref: '#/components/schemas/PermitRestriction'
        resultKey:
          description: The key to link permit requests to permit results.
          type: string
        validTillDate:
          description: The expiry date for this permit.
          format: date-time
          type: string
      type: object
    PermitResult:
      properties:
        resultKey:
          x-addedInVersion: '32'
          description: The key to link permit requests to permit results.
          type: string
        token:
          x-addedInVersion: '32'
          description: The permit token which is used to make payments by the partner company.
          type: string
      type: object
    PermitRestriction:
      properties:
        maxAmount:
          description: The total sum amount of one or more payments made using this permit may not exceed this amount if set.
          $ref: '#/components/schemas/Amount'
        singleTransactionLimit:
          description: The amount of any single payment using this permit may not exceed this amount if set.
          $ref: '#/components/schemas/Amount'
        singleUse:
          description: Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.
          type: boolean
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http
x-groups:
- Account holders
- Accounts
- Verification