Class Customers

API resource for the Customers endpoints.

Allow your regular customers to save their information with the Customers model.

This will prevent re-entering payment instrument information for recurring payments on your platform.

Depending on the needs you can allow, creating, listing or deactivating payment instruments & creating, retrieving and updating customers.

Hierarchy

APIResource
- Customers

Index

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

create

create(body: Customer, options?: RequestOptions): Promise<Customer>
Creates a new saved customer resource which you can later manipulate and save payment instruments to.
Parameters
- body: Customer
- Optionaloptions: RequestOptions
Returns Promise<Customer>
- Defined in src/resources/customers/index.ts:35

createWithResponse

createWithResponse(
body: Customer,
options?: RequestOptions,
): Promise<WithResponse<Customer>>
Parameters
- body: Customer
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<Customer>>
- Defined in src/resources/customers/index.ts:43

deactivatePaymentInstrument

deactivatePaymentInstrument(
    customerId: string,
    token: string,
    options?: RequestOptions,
): Promise<void>
Deactivates an identified card payment instrument resource for a customer.
Parameters
- customerId: string
- token: string
- Optionaloptions: RequestOptions
Returns Promise<void>
- Defined in src/resources/customers/index.ts:129

deactivatePaymentInstrumentWithResponse

deactivatePaymentInstrumentWithResponse(
    customerId: string,
    token: string,
    options?: RequestOptions,
): Promise<WithResponse<void>>
Parameters
- customerId: string
- token: string
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<void>>
- Defined in src/resources/customers/index.ts:140

get

get(customerId: string, options?: RequestOptions): Promise<Customer>
Retrieves an identified saved customer resource through the unique customer_id parameter, generated upon customer creation.
Parameters
- customerId: string
- Optionaloptions: RequestOptions
Returns Promise<Customer>
- Defined in src/resources/customers/index.ts:57

getWithResponse

getWithResponse(
customerId: string,
options?: RequestOptions,
): Promise<WithResponse<Customer>>
Parameters
- customerId: string
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<Customer>>
- Defined in src/resources/customers/index.ts:64

listPaymentInstruments

listPaymentInstruments(
customerId: string,
options?: RequestOptions,
): Promise<PaymentInstrumentResponse[]>
Lists all payment instrument resources that are saved for an identified customer.
Parameters
- customerId: string
- Optionaloptions: RequestOptions
Returns Promise<PaymentInstrumentResponse[]>
- Defined in src/resources/customers/index.ts:106

listPaymentInstrumentsWithResponse

listPaymentInstrumentsWithResponse(
customerId: string,
options?: RequestOptions,
): Promise<WithResponse<PaymentInstrumentResponse[]>>
Parameters
- customerId: string
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<PaymentInstrumentResponse[]>>
- Defined in src/resources/customers/index.ts:116

update

update(
    customerId: string,
    body: UpdateCustomerParams,
    options?: RequestOptions,
): Promise<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
- body: UpdateCustomerParams
- Optionaloptions: RequestOptions
Returns Promise<Customer>
- Defined in src/resources/customers/index.ts:79

updateWithResponse

updateWithResponse(
    customerId: string,
    body: UpdateCustomerParams,
    options?: RequestOptions,
): Promise<WithResponse<Customer>>
Parameters
- customerId: string
- body: UpdateCustomerParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<Customer>>
- Defined in src/resources/customers/index.ts:91

Class Customers

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Customers

Properties

Protected_client

Methods

create

Parameters

Returns Promise<Customer>

createWithResponse

Parameters

Returns Promise<WithResponse<Customer>>

deactivatePaymentInstrument

Parameters

Returns Promise<void>

deactivatePaymentInstrumentWithResponse

Parameters

Returns Promise<WithResponse<void>>

get

Parameters

Returns Promise<Customer>

getWithResponse

Parameters

Returns Promise<WithResponse<Customer>>

listPaymentInstruments

Parameters

Returns Promise<PaymentInstrumentResponse[]>

listPaymentInstrumentsWithResponse

Parameters

Returns Promise<WithResponse<PaymentInstrumentResponse[]>>

update

Parameters

Returns Promise<Customer>

updateWithResponse

Parameters

Returns Promise<WithResponse<Customer>>

Settings

On This Page

`Protected`_client