GetPaid

GetPaid Applications API

Onboarding applications to collect the necessary information from sellers to create their Getpaid accounts and start accepting payments.

GitHub OpenAPI

Operations 5

POST /v2/applications Create an application #
GET /v2/applications/{application_id} Get an application #
POST /v2/applications/{application_id}/refresh Refresh an application #
POST /v2/applications/{application_id}/cancel Cancel an application #
POST /v2/applications/query Query applications #

Documentation

📖
APIReference
https://docs.getpaid.io/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/getpaid/refs/heads/main/openapi/getpaid-applications-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/getpaid-applications-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

getpaid-applications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Getpaid Applications API
  version: v2
  contact:
    email: support@getpaid.io
  description: '# Getting started


    Our APIs provide programmatic access to the Getpaid solution. This page contains a comprehensive reference for all

    resources of the Getpaid public API. For walkthrough documentation please see [Getpaid guides](/) for step by step usage

    of the Getpaid platform including the API and [Getpaid API integration](/integration/api) for the technical aspects of

    this Getpaid API.


    To get started, book a demo and sign up at <https://getpaid.io>. This will give you access to the [Getpaid

    dashboard](https://dashboard.getpaid.io) where you can configure your account and retrieve your credentials needed to

    authenticate with Getpaid API.


    ## Postman


    Getpaid provides a Postman collection to test the API features in sandbox. You can [download the Postman collection and

    the environments](/integration/api/postman) to start testing the Getpaid API.


    ## Fields formats


    | Type | Format |

    | :- | :- |

    | `amount-minor` | Amount in the minor currency unit (e.g. 100 cents for 1 EUR). |

    | `country` | The country code fields follow the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) in uppercase. Examples: `DE`, `US`. |

    | `currency` | The currency code fields follow the [ISO 4217 standard](https://en.wikipedia.org/wiki/ISO_4217) in uppercase. Examples: `EUR`, `USD`. |

    | `date` | Dates are formatted using the complete date format according to the [ISO 8601 standard](https://www.w3.org/TR/NOTE-datetime): `YYYY-MM-DD`. Example: `2023-09-30`.                                        |

    | `date-time` | Date-time fields are formatted using the [ISO 8601 standard](https://www.w3.org/TR/NOTE-datetime) for the combined date and time in UTC with 3 seconds fractional digits: `YYYY-MM-DDThh:mm:ss.SSSZ`. Example: `2015-09-01T23:59:59.479Z`. |

    | `date-time-offset` | Date-time fields with time-zone are formatted [ISO 8601 standard](https://www.w3.org/TR/NOTE-datetime) for the combined date and time with the time-zone and no second fractional digits: `YYYY-MM-DDThh:mm:ssTZD`. Example: `2015-09-01T23:59:59+01:00`. |

    | `email` | Email fields should follow the [RFC 5322](https://tools.ietf.org/html/rfc5322) standard. Example: `jon.smith@acme.com` |

    | `hex-color` | Colors are represented as a string starting with `#` followed by six hexadecimal digits. Each pair of digits represents the intensity of red, green, and blue components respectively. Examples: `#FFFFFF`, `#000000`, `#FF5733`. |

    | `id` | Identifiers are formatted as a string of 3 alphabetic characters (which represents the type of the identified object), one underscore and 26 alphanumeric characters. Every identifier generated in our system is globally unique. Examples: `acc_44678r08jtm8zbt227tzhc4nw5`, `doc_473cr1y0ghbyc3m1yfbwvn3nxx`. |

    | `ip-address` | IP fields are formatted using the [Internet Protocol version 4 (IPv4)](https://en.wikipedia.org/wiki/Internet_Protocol_version_4) standard: `x.x.x.x` where `x` must be a decimal value between `0` and `255`. Example: `192.158.1.38`. |

    | `version` | A resource version. For resources that can evolved over time, a unique reference of the snapshot used in other resource. For example, the account information used for a payment, the information used for the statement descriptor or the processing configuration are tighted to the version of the account. |

    '
servers:
- url: https://api.getpaid.io
  description: Live
- url: https://api.sandbox.getpaid.io
  description: Sandbox
tags:
- name: Applications
  description: Onboarding applications to collect the necessary information from sellers to create their Getpaid accounts and start accepting payments.
paths:
  /v2/applications:
    post:
      tags:
      - Applications
      summary: Create an application
      description: 'Create an application initiated by the platform so the seller can start submitting their information. It can be:


        - `onboarding`: to create a new account for the seller and start accepting payments.

        - `change_request`: to update an existing seller account with new information.


        Related webhooks:


        - [`application_submitted`](#tag/Onboard-sellers-webhooks/operation/application_submitted): sent when an application is submitted by a seller for review.

        - [`application_completed`](#tag/Onboard-sellers-webhooks/operation/application_completed): sent when the application is approved and completed.

        '
      operationId: create_application
      security:
      - OAuth:
        - accounts:read_write
      parameters:
      - $ref: '#/components/parameters/GetpaidIdempotencyKey'
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApplicationRequest'
            examples:
              CreateApplication:
                $ref: '#/components/examples/CreateApplication'
              CreateApplicationSellerDetails:
                $ref: '#/components/examples/CreateApplicationSellerDetails'
              CreateApplicationCanada:
                $ref: '#/components/examples/CreateApplicationCanada'
              CreateApplicationCanadaSellerDetails:
                $ref: '#/components/examples/CreateApplicationSellerDetailsCanada'
              CreateChangeRequestApplication:
                $ref: '#/components/examples/CreateChangeRequestApplication'
              CreateChangeRequestApplicationWithTheme:
                $ref: '#/components/examples/CreateChangeRequestApplicationWithTheme'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApplicationResponse'
              examples:
                ApplicationCreated:
                  $ref: '#/components/examples/ApplicationCreated'
                ChangeRequestApplicationCreated:
                  $ref: '#/components/examples/ChangeRequestApplicationCreated'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '422':
          $ref: '#/components/responses/422InvalidParameters'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
  /v2/applications/{application_id}:
    get:
      tags:
      - Applications
      summary: Get an application
      description: 'Retrieve details of an application by its ID. Both `onboarding` and `change_request` applications can be retrieved.

        '
      operationId: get_application
      security:
      - OAuth:
        - accounts:read
      parameters:
      - name: application_id
        in: path
        description: The ID of the application to retrieve.
        required: true
        schema:
          $ref: '#/components/schemas/ApplicationId'
      responses:
        '200':
          description: OK
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicationResponse'
              examples:
                ApplicationInitiated:
                  $ref: '#/components/examples/ApplicationInitiated'
                ApplicationCompleted:
                  $ref: '#/components/examples/ApplicationCompleted'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
  /v2/applications/{application_id}/refresh:
    post:
      tags:
      - Applications
      summary: Refresh an application
      description: 'Extends the lifespan of an application so the seller can continue submitting their information. Both `onboarding` and `change_request` applications can be refreshed.

        '
      operationId: refresh_application
      security:
      - OAuth:
        - accounts:read_write
      parameters:
      - name: application_id
        in: path
        description: The ID of the application to refresh.
        required: true
        schema:
          $ref: '#/components/schemas/ApplicationId'
      - $ref: '#/components/parameters/GetpaidIdempotencyKey'
        required: true
      responses:
        '200':
          description: OK
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefreshApplicationResponse'
              examples:
                ApplicationRefreshed:
                  $ref: '#/components/examples/ApplicationRefreshed'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
        '409':
          $ref: '#/components/responses/409Conflict'
        '422':
          $ref: '#/components/responses/422InvalidParameters'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
  /v2/applications/{application_id}/cancel:
    post:
      tags:
      - Applications
      summary: Cancel an application
      description: 'Cancels a duplicate or abandoned application. Both `onboarding` and `change_request` applications can be cancelled.


        Applications in `approved`, `completed`, or already `cancelled` status cannot be cancelled and return a validation error.


        The response returns the updated application with `status` set to `cancelled` and the hosted flow cleared. For change requests, cancellation closes the open workflow so a new change request can be created for the same seller account.

        '
      operationId: cancel_application
      security:
      - OAuth:
        - accounts:read_write
      parameters:
      - name: application_id
        in: path
        description: The ID of the application to cancel.
        required: true
        schema:
          $ref: '#/components/schemas/ApplicationId'
      - $ref: '#/components/parameters/GetpaidIdempotencyKey'
        required: true
      responses:
        '200':
          description: OK
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicationResponse'
              examples:
                OnboardingApplicationCancelled:
                  $ref: '#/components/examples/OnboardingApplicationCancelled'
                ChangeRequestApplicationCancelled:
                  $ref: '#/components/examples/ChangeRequestApplicationCancelled'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
        '409':
          $ref: '#/components/responses/409Conflict'
        '422':
          $ref: '#/components/responses/422InvalidParameters'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
  /v2/applications/query:
    post:
      tags:
      - Applications
      summary: Query applications
      description: 'Query applications filtering, sorting and paginating results. Both `onboarding` and `change_request` applications are returned.


        See [Queries](/operate/queries) for more examples and details about pagination and common query patterns.

        '
      operationId: query_applications
      security:
      - OAuth:
        - accounts:read
      parameters:
      - $ref: '#/components/parameters/GetpaidIdempotencyKey'
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryApplicationsRequest'
            examples:
              QueryApplications:
                $ref: '#/components/examples/QueryApplications'
        required: true
      responses:
        '200':
          description: OK
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryApplicationsResponse'
              examples:
                FilteredApplications:
                  $ref: '#/components/examples/FilteredApplications'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '422':
          $ref: '#/components/responses/422InvalidParameters'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
components:
  schemas:
    PaginationCursor:
      description: The cursor to the last item. If non-empty, can be used to fetch the next page. If not set, there is no more elements.
      type: string
      maxLength: 250
      example: Q3VyaW9zaXR5IEtpbGxlZCB0aGUgQ2F0Cg==
    BusinessRequest:
      description: The seller business details if known at the time of application creation.
      type: object
      required:
      - legal_name
      - country
      properties:
        legal_name:
          allOf:
          - $ref: '#/components/schemas/MediumString'
          - description: The legal name of the business.
            example: Garage Germany AG
            minLength: 2
        country:
          allOf:
          - description: The country where the business is registered in the form of a two-letter [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
            example: DE
          - $ref: '#/components/schemas/Country'
        legal_structure:
          $ref: '#/components/schemas/BusinessLegalStructure'
        registered_address:
          allOf:
          - description: The registered address of the business.
          - $ref: '#/components/schemas/Address'
        registration_number:
          $ref: '#/components/schemas/RegistrationNumber'
    RefreshApplicationResponse:
      type: object
      required:
      - id
      - updated_at
      - expires_at
      - flow
      properties:
        id:
          $ref: '#/components/schemas/ApplicationId'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        expires_at:
          $ref: '#/components/schemas/ApplicationExpiresAt'
        flow:
          $ref: '#/components/schemas/ApplicationFlow'
    Country:
      type: string
      format: country
      minLength: 2
      maxLength: 2
      description: The two-letter [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
      example: DE
    ThemeId:
      allOf:
      - $ref: '#/components/schemas/Id'
      - description: The unique identifier of the theme.
        example: thm_4jkgtzffbf9pzem7dgfhdeztwa
    Reference:
      allOf:
      - $ref: '#/components/schemas/ShortString'
      - description: An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.
        example: ORD-202510-0232
    AccountLegalName:
      allOf:
      - description: The legal name of the account.
      - $ref: '#/components/schemas/MediumString'
    CreateApplicationResponse:
      type: object
      required:
      - id
      - status
      - reference
      - created_at
      - updated_at
      - expires_at
      - account
      - flow
      properties:
        id:
          $ref: '#/components/schemas/ApplicationId'
        status:
          $ref: '#/components/schemas/ApplicationStatus'
          const: initiated
        reference:
          $ref: '#/components/schemas/Reference'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        expires_at:
          $ref: '#/components/schemas/ApplicationExpiresAt'
        account:
          description: The account associated with the application, if created.
          type: object
          required:
          - id
          properties:
            id:
              $ref: '#/components/schemas/AccountId'
        flow:
          $ref: '#/components/schemas/ApplicationFlow'
    ApplicationFieldRequest:
      description: 'A field whose access for the seller is controlled by the change request application.

        '
      type: object
      required:
      - name
      - access
      properties:
        name:
          description: The name of the field whose access is controlled by the application.
          type: string
          enum:
          - themes
        access:
          description: The level of access granted to the seller over the field while the application is open.
          type: string
          enum:
          - read_write
    MediumString:
      type: string
      minLength: 1
      maxLength: 250
    Id:
      type: string
      format: id
      minLength: 30
      maxLength: 50
    RegistrationNumber:
      description: 'The business'' registration number.

        The registration number is validated based on the country of the business.

        '
      anyOf:
      - $ref: '#/components/schemas/BaseRegistrationNumber'
      - $ref: '#/components/schemas/GermanRegistrationNumber'
      discriminator:
        propertyName: type
        mapping:
          vat: '#/components/schemas/BaseRegistrationNumber'
          de_vr: '#/components/schemas/GermanRegistrationNumber'
          de_hra: '#/components/schemas/GermanRegistrationNumber'
          de_hrb: '#/components/schemas/GermanRegistrationNumber'
          ca_cn: '#/components/schemas/BaseRegistrationNumber'
          ee_kmkr: '#/components/schemas/BaseRegistrationNumber'
          si_tin: '#/components/schemas/BaseRegistrationNumber'
    PaginationData:
      description: The list of queried elements.
      type: array
      items:
        type: object
    ApplicationsFiltersRequest:
      description: Filtering onboarding applications.
      type: object
      properties:
        id:
          allOf:
          - description: The onboarding application identifier to filter by using an exact match operation.
          - $ref: '#/components/schemas/ApplicationId'
        statuses:
          description: The list of onboarding application statuses to filter by.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/components/schemas/ApplicationStatus'
        legal_name:
          description: The business legal name to filter by using a contains operation.
          type: string
          maxLength: 255
        reference:
          description: The onboarding application reference to filter by using a contains operation.
          type: string
          maxLength: 200
        country:
          allOf:
          - description: The country to filter by using an exact match operation.
          - $ref: '#/components/schemas/Country'
    ProblemDetailsBase:
      type: object
      description: The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].
      required:
      - type
      - title
      - status
      properties:
        type:
          type: string
          description: A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
          format: uri
          example: https://docs.getpaid.io/ref/error-types#problem
        title:
          type: string
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
          example: Invalid Request
        status:
          type: integer
          description: The HTTP status code.
          minimum: 400
          maximum: 599
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          example: The request body was invalid
    CreatedAt:
      allOf:
      - description: When the resource was created.
      - $ref: '#/components/schemas/DateTime'
    ApplicantResponse:
      description: The details of the person representing the seller that applied for the Getpaid account if known at the time of application retrieval.
      type: object
      required:
      - email
      properties:
        email:
          allOf:
          - $ref: '#/components/schemas/Email'
          - description: The applicant's email address.
        first_name:
          allOf:
          - $ref: '#/components/schemas/ShortString'
          - description: The applicant's first name.
            example: Markus
            minLength: 2
        last_name:
          allOf:
          - $ref: '#/components/schemas/ShortString'
          - description: The applicant's last name.
            example: Doe
            minLength: 2
    CreateApplicationRequest:
      oneOf:
      - $ref: '#/components/schemas/OnboardingApplicationRequest'
      - $ref: '#/components/schemas/ChangeRequestApplicationRequest'
      discriminator:
        propertyName: type
        mapping:
          onboarding: '#/components/schemas/OnboardingApplicationRequest'
          change_request: '#/components/schemas/ChangeRequestApplicationRequest'
    ApplicationStatus:
      description: The status of the onboarding application.
      type: string
      enum:
      - initiated
      - identity_verified
      - submitted
      - screened
      - approved
      - completed
      - cancelled
    BaseSortsRequest:
      description: Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
      type: array
      minItems: 1
      uniqueItems: true
      items:
        description: Each field to sort by.
        type: object
        required:
        - field
        - direction
        properties:
          field:
            description: The field to sort by. Each field available can only be used once in the list.
            type: string
          direction:
            description: The sort direction
            type: string
            enum:
            - ascending
            - descending
    ApplicationWebhooksRequest:
      description: Configuration for webhooks to receive onboarding application status updates.
      type: object
      required:
      - url
      properties:
        url:
          allOf:
          - description: The URL to which webhook events will be sent.
            example: https://webhooks.titanauto.com/getpaid
          - $ref: '#/components/schemas/Url'
    QueryApplicationsRequest:
      allOf:
      - $ref: '#/components/schemas/BaseQueryRequest'
      - required:
        - type
        properties:
          type:
            type: string
            enum:
            - applications
          filters:
            $ref: '#/components/schemas/ApplicationsFiltersRequest'
          sorts:
            $ref: '#/components/schemas/ApplicationsSortsRequest'
    BaseRegistrationNumber:
      description: The company registration number.
      type: object
      required:
      - type
      - value
      properties:
        type:
          description: The type of registration number. See the list of supported [registration numbers per country](/integration/api/references/registration-numbers).
          type: string
          example: vat
        value:
          allOf:
          - $ref: '#/components/schemas/ShortString'
          - description: The registration number. See the format for each registration number type in the [registration numbers list](/integration/api/references/registration-numbers).
            example: DE123456789
    ApplicationFlow:
      description: The flow required for the onboarding application to complete.
      type: object
      required:
      - next_step
      properties:
        next_step:
          description: The next step required to complete the flow.
          type: object
          required:
          - type
          - url
          properties:
            type:
              description: The type of the next step.
              type: string
              enum:
              - redirect
            url:
              allOf:
              - $ref: '#/components/schemas/Url'
              - description: The URL to redirect the seller to complete the onboarding.
    ApplicationId:
      allOf:
      - $ref: '#/components/schemas/Id'
      - description: The unique identifier of the onboarding application.
        example: app_4fekhxdpss1et7rjp8t7rdpnw4
    ApplicationExpiresAt:
      allOf:
      - description: When the onboarding session will expire if not submitted and must be refreshed to extend its lifespan.
      - $ref: '#/components/schemas/DateTime'
    Url:
      type: string
      format: uri
      maxLength: 1024
    AccountId:
      allOf:
      - $ref: '#/components/schemas/Id'
      - description: The unique identifier of the account.
        example: acc_44678r08jtm8zbt227tzhc4nw5
    PaginationFirst:
      description: Pagination. The number of elements that will be retrieved.
      type: integer
      default: 20
      minimum: 1
      maximum: 100
    BaseCreateApplicationRequest:
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/ApplicationType'
        webhooks:
          $ref: '#/components/schemas/ApplicationWebhooksRequest'
    DateTime:
      description: 'UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)).

        Always includes the ''Z'' UTC indicator.

        '
      type: string
      format: date-time
      minLength: 24
      maxLength: 24
      example: '2025-09-01T22:05:48.479Z'
    BusinessLegalStructure:
      description: 'The legal structure of the business.


        **It is required to provide the legal structure of the business if the country of registration is Canada (CA).**

        '
      type: string
      enum:
      - ca_private_corp
      - ca_public_corp
      - ca_non_profit
    Address:
      allOf:
      - required:
        - line1
        - street_number
        - city
        - postal_code
      - $ref: '#/components/schemas/AddressOptionalFields'
    BaseQueryRequest:
      type: object
      properties:
        type:
          description: 'The type of the Getpaid solution resources to query.


            Some query endpoints infer the resource type from the request path. In those cases, if this field is set, it

            must match the resource targeted by the request URL.

            '
          type: string
        first:
          allOf:
          - $ref: '#/components/schemas/PaginationFirst'
        after:
          $ref: '#/components/schemas/PaginationAfter'
        filters:
          description: Filters to reduce the data set to query. If not set, all resources available of the given type will be queried.
        sorts:
          $ref: '#/components/schemas/BaseSortsRequest'
    ChangeRequestApplicationRequest:
      allOf:
      - required:
        - account
        - fields
        properties:
          type:
            type: string
          account:
            description: The seller account whose information is being updated by this change request.
            type: object
            required:
            - id
            properties:
              id:
                $ref: '#/components/schemas/AccountId'
          fields:
            description: 'The list of fields whose access is granted to the seller while the change request application is open.


              The application is scoped to these fields only — the seller can review and update them, and any other field remains unchanged.

              '
            type: array
            minItems: 1
            uniqueItems: true
            items:
              $ref: '#/components/schemas/ApplicationFieldRequest'
          reference:
            $ref: '#/components/schemas/Reference'
          redirect:
            description: Configuration for the redirect behavior after the change request application is submitted.
            type: object
            required:
            - default
            properties:
              default:
                allOf:
                - $ref: '#/components/schemas/Url'
                - description: The URL to which the seller will be redirected after the change request application is submitted.
                  example: https://titanauto.com/change-request/complete?customer=53426
          theme_id:
            allOf:
            - $ref: '#/components/schemas/ThemeId'
            - description: The ID of the platform theme used to brand the hosted change request page. This affects only the appearance of the page itself and does not change the seller account's theme settings. If not provided, the account's default theme is used.
      - $ref: '#/components/schemas/BaseCreateApplicationRequest'
    ApplicantRequest:
      description: The details of the person representing the seller that is applying for the Getpaid account if known at the time of application creation.
      type: object
      required:
      - email
      properties:
        email:
          allOf:
          - $ref: '#/components/schemas/Email'
          - description: The applicant's email address.
        first_name:
          allOf:
          - $ref: '#/components/schemas/ShortString'
          - description: The applicant's first name.
            example: Markus
            minLength: 2
        last_name:
          allOf:
          - $ref: '#/components/schemas/ShortString'
          - description: The applicant's last name.
            example: Doe
            minLength: 2
    PaginatedResponse:
      type: object
      required:
      - data
      properties:
        cursor:
          $ref: '#/components/schemas/PaginationCursor'
        data:
          $ref: '#/components/schemas/PaginationData'
    BaseSortItemRequest:
      description: Each field to sort by.
      type: object
      required:
      - field
      - direction
      properties:
        field:
          description: The field to sort by. Each field available can only be used once in the list.
          type: string
        direction:
          description: The sort direction
          type: string
          enum:
          - ascending
          - descending
    Email:
      description: An email address.
      type: string
      format: email
      maxLength: 320
      example: jane.doe@company.com
    ShortString:
      type: string
      minLength: 1
      maxLength: 50
    QueryApplicationsResponse:
      allOf:
      - required:
        - type
        properties:
          type:
            type: string
            enum:
            - applications
          cursor:
            type: string
          data:
            items:
              required:
              - id
              - status
              - created_at
              - expires_at
              properties:
                id:
                  $ref: '#/components/schemas/ApplicationId'
                status:
                  $ref: '#/components/schemas/ApplicationStatus'
                reference:
                  $ref: '#/components/schemas/Reference'
                legal_name:
                  $ref: '#/components/schemas/AccountLegalName'
                country:
                  $ref: '#/components/schemas/Country'
                applicant_email:
                  $ref: '

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/getpaid/refs/heads/main/openapi/getpaid-applications-api-openapi.yml