@sumup/sdk
    Preparing search index...

    Class SumUp

    Hierarchy

    • HTTPClient
      • SumUp
    Index

    Constructors

    Properties

    apiKey?: string
    baseParams: RequestOptions
    checkouts: Checkouts = ...

    Access the Checkouts API endpoints.

    customers: Customers = ...

    Access the Customers API endpoints.

    host: string
    members: Members = ...

    Access the Members API endpoints.

    memberships: Memberships = ...

    Access the Memberships API endpoints.

    merchants: Merchants = ...

    Access the Merchants API endpoints.

    payouts: Payouts = ...

    Access the Payouts API endpoints.

    readers: Readers = ...

    Access the Readers API endpoints.

    receipts: Receipts = ...

    Access the Receipts API endpoints.

    roles: Roles = ...

    Access the Roles API endpoints.

    subaccounts: Subaccounts = ...

    Access the Subaccounts API endpoints.

    transactions: Transactions = ...

    Access the Transactions API endpoints.

    Methods

    • Type Parameters

      Parameters

      • __namedParameters: Omit<Core.FullRequestOptions, "method">

      Returns APIPromise<R, E>

    • Type Parameters

      • E

      Parameters

      • input: URL
      • init: RequestInit
      • options: { maxRetries?: number; signal?: AbortSignal | null; timeout?: number }

      Returns Promise<Response>

    • Type Parameters

      Parameters

      • __namedParameters: Omit<Core.FullRequestOptions, "method">

      Returns APIPromise<R, E>

    • Type Parameters

      Parameters

      • __namedParameters: Omit<Core.FullRequestOptions, "method">

      Returns APIPromise<R, E>

    post

    • post<R, E = APIError<unknown>>(
          __namedParameters: Omit<Core.FullRequestOptions, "method">,
      ): APIPromise<R, E>

      Type Parameters

      Parameters

      • __namedParameters: Omit<Core.FullRequestOptions, "method">

      Returns APIPromise<R, E>

    • Type Parameters

      Parameters

      • __namedParameters: Omit<Core.FullRequestOptions, "method">

      Returns APIPromise<R, E>

    • Type Parameters

      Parameters

      • __namedParameters: FullRequestOptions

      Returns APIPromise<T, E>

    • Parameters

      • query: Record<string, unknown>

      Returns string