Class Customers

Hierarchy

APIResource
- Customers

Index

Constructors

Properties

Methods

create deactivatePaymentInstrument get listPaymentInstruments update

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

create

create(body: Customer, params?: FetchParams): APIPromise<Customer>
Create a customer
Parameters
- body: Customer
- Optionalparams: FetchParams
Returns APIPromise<Customer>
- Defined in resources/customers/index.ts:173

deactivatePaymentInstrument

deactivatePaymentInstrument(
    customerId: string,
    token: string,
    params?: FetchParams,
): APIPromise<void>
Deactivate a payment instrument
Parameters
- customerId: string
- token: string
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/customers/index.ts:225

get

get(customerId: string, params?: FetchParams): APIPromise<Customer>
Retrieve a customer
Parameters
- customerId: string
- Optionalparams: FetchParams
Returns APIPromise<Customer>
- Defined in resources/customers/index.ts:184

listPaymentInstruments

listPaymentInstruments(
customerId: string,
params?: FetchParams,
): APIPromise<PaymentInstrumentResponse[]>
List payment instruments
Parameters
- customerId: string
- Optionalparams: FetchParams
Returns APIPromise<PaymentInstrumentResponse[]>
- Defined in resources/customers/index.ts:212

update

update(
    customerId: string,
    body: UpdateCustomerParams,
    params?: FetchParams,
): APIPromise<Customer>
Update a customer
Parameters
- customerId: string
- body: UpdateCustomerParams
- Optionalparams: FetchParams
Returns APIPromise<Customer>
- Defined in resources/customers/index.ts:197