Link to this section Summary

To update an existing payment method attached to a customer object. This API is useful for use cases such as updating the card number for expired cards to prevent discontinuity in recurring payments.

Link to this section Types

account_or_customer_id()

@type account_or_customer_id() ::
  Hyperswitch.Accounts.account_id() | Hyperswitch.Customers.customer_id()

create_method_params()

@type create_method_params() :: map()

create_method_response()

@type create_method_response() :: Hyperswitch.Client.response()

delete_method_response()

@type delete_method_response() :: Hyperswitch.Client.response()

get_method_response()

@type get_method_response() :: Hyperswitch.Client.response()

method_id()

@type method_id() :: binary()

update_method_params()

@type update_method_params() :: map()

update_method_response()

@type update_method_response() :: Hyperswitch.Client.response()

Link to this section Functions

create_method(body)

@spec create_method(create_method_params()) :: create_method_response()

To create a payment method against a customer object. In case of cards, this API could be used only by PCI compliant merchants.

delete_method(method_id)

@spec delete_method(method_id()) :: delete_method_response()

Delete payment method.

get_method(method_id)

@spec get_method(method_id()) :: get_method_response()

To retrieve a payment method.

get_method(account_or_customer_id, params \\ [])

@spec get_method(
  account_or_customer_id(),
  keyword()
) :: get_method_response()

To filter and list the applicable payment methods for a particular Merchant ID or Customer ID.

update_method(method_id, body)

@spec update_method(method_id(), create_method_params()) :: update_method_response()