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

Properties

Methods

create deactivatePaymentInstrument get listPaymentInstruments update

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,
): APIPromise<
    Customer,
    ErrorBody
    | ErrorForbidden
    | Problem
    | CreateCustomerError,
>
Creates a new saved customer resource which you can later manipulate and save payment instruments to.
Parameters
- body: Customer
- Optionaloptions: RequestOptions
Returns APIPromise<Customer, ErrorBody | ErrorForbidden | Problem | CreateCustomerError>
- Defined in src/resources/customers/index.ts:34

deactivatePaymentInstrument

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

get

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

listPaymentInstruments

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

update

update(
    customerId: string,
    body: UpdateCustomerParams,
    options?: RequestOptions,
): APIPromise<Customer, ErrorBody | ErrorForbidden | Problem>
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 APIPromise<Customer, ErrorBody | ErrorForbidden | Problem>
- Defined in src/resources/customers/index.ts:69