Poq.SDK.Node

Home > @poq/sdk-sfcc > ICustomersClient > getCustomersByIDPaymentInstruments

ICustomersClient.getCustomersByIDPaymentInstruments() method

Gets customer payment instruments for an customer. Can be limited to a specific payment method by providing query parameter payment_method_id. When the customer cannot be found CustomerNotFoundException is thrown in a case of an agent but an empty result list is returned in a case of JWT.

Signature:

getCustomersByIDPaymentInstruments(customerId: string, paymentMethodId?: string, options?: RequestOptions): Promise<PoqResponse<CustomerPaymentInstrumentResult>>;

Parameters

Parameter	Type	Description
customerId	string	the id of the customer to retrieve the payment instruments for
paymentMethodId	string	(Optional)
options	RequestOptions	(Optional) Override http request option.

Returns:

Promise<PoqResponse<CustomerPaymentInstrumentResult>>