Class Checkouts

Hierarchy

APIResource
- Checkouts

Index

Constructors

Properties

Methods

create deactivate get list listAvailablePaymentMethods process

Constructors

constructor

new Checkouts(client: SumUp): SumUp.Checkouts
Parameters
- client: SumUp
Returns SumUp.Checkouts
Inherited from Core.APIResource.constructor
- Defined in core.ts:8

Properties

`Protected`_client

_client: SumUp

Methods

create

create(body: CheckoutCreateRequest, params?: FetchParams): APIPromise<Checkout>
Create a checkout
Parameters
- body: CheckoutCreateRequest
- Optionalparams: FetchParams
Returns APIPromise<Checkout>
- Defined in resources/checkouts/index.ts:616

deactivate

deactivate(id: string, params?: FetchParams): APIPromise<void>
Deactivate a checkout
Parameters
- id: string
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/checkouts/index.ts:655

get

get(id: string, params?: FetchParams): APIPromise<CheckoutSuccess>
Retrieve a checkout
Parameters
- id: string
- Optionalparams: FetchParams
Returns APIPromise<CheckoutSuccess>
- Defined in resources/checkouts/index.ts:630

list

list(
query?: ListCheckoutsQueryParams,
params?: FetchParams,
): APIPromise<CheckoutSuccess[]>
List checkouts
Parameters
- Optionalquery: ListCheckoutsQueryParams
- Optionalparams: FetchParams
Returns APIPromise<CheckoutSuccess[]>
- Defined in resources/checkouts/index.ts:602

listAvailablePaymentMethods

listAvailablePaymentMethods(
    merchantCode: string,
    query?: GetPaymentMethodsQueryParams,
    params?: FetchParams,
): APIPromise<void>
Get available payment methods
Parameters
- merchantCode: string
- Optionalquery: GetPaymentMethodsQueryParams
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/checkouts/index.ts:587

process

process(
    id: string,
    body: CheckoutProcessMixin,
    params?: FetchParams,
): APIPromise<CheckoutSuccess | CheckoutAccepted>
Process a checkout
Parameters
- id: string
- body: CheckoutProcessMixin
- Optionalparams: FetchParams
Returns APIPromise<CheckoutSuccess | CheckoutAccepted>
- Defined in resources/checkouts/index.ts:640