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>
Creates a new saved customer resource which you can later manipulate and save payment instruments to.
Parameters
- Optionalbody: Customer
- Optionalparams: FetchParams
Returns APIPromise<Customer>
- Defined in resources/customers/index.ts:171

deactivatePaymentInstrument

deactivatePaymentInstrument(
    customerId: string,
    token: string,
    params?: FetchParams,
): APIPromise<void>
Deactivates an identified card payment instrument resource for a customer.
Parameters
- customerId: string
- token: string
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/customers/index.ts:229

get

get(customerId: string, params?: FetchParams): APIPromise<Customer>
Retrieves an identified saved customer resource through the unique customer_id parameter, generated upon customer creation.
Parameters
- customerId: string
- Optionalparams: FetchParams
Returns APIPromise<Customer>
- Defined in resources/customers/index.ts:185

listPaymentInstruments

listPaymentInstruments(
customerId: string,
params?: FetchParams,
): APIPromise<PaymentInstrumentResponse[]>
Lists all payment instrument resources that are saved for an identified customer.
Parameters
- customerId: string
- Optionalparams: FetchParams
Returns APIPromise<PaymentInstrumentResponse[]>
- Defined in resources/customers/index.ts:216

update

update(
    customerId: string,
    body?: UpdateCustomerParams,
    params?: FetchParams,
): APIPromise<Customer>
Updates an identified saved customer resource's personal details.

The request only overwrites the parameters included in the request, all other parameters will remain with their initially assigned values.
Parameters
- customerId: string
- Optionalbody: UpdateCustomerParams
- Optionalparams: FetchParams
Returns APIPromise<Customer>
- Defined in resources/customers/index.ts:201