View Source Hyperswitch.Customers (hyperswitch v0.1.0)

Link to this section Summary

Functions

Create a customer object and store the customer details to be reused for future payments. Incase the customer already exists in the system, this API will respond with the customer details.

Delete a customer record.

Retrieve a customer's details.

Updates the customer's details in a customer object.

Link to this section Types

Link to this type

create_customer_params()

View Source
@type create_customer_params() :: map()
Link to this type

create_customer_response()

View Source
@type create_customer_response() :: Hyperswitch.Client.response()
@type customer_id() :: binary()
Link to this type

delete_customer_response()

View Source
@type delete_customer_response() :: Hyperswitch.Client.response()
Link to this type

get_customer_response()

View Source
@type get_customer_response() :: Hyperswitch.Client.response()
Link to this type

update_customer_params()

View Source
@type update_customer_params() :: map()
Link to this type

update_customer_response()

View Source
@type update_customer_response() :: Hyperswitch.Client.response()

Link to this section Functions

@spec create_customer(create_customer_params()) :: create_customer_response()

Create a customer object and store the customer details to be reused for future payments. Incase the customer already exists in the system, this API will respond with the customer details.

Link to this function

delete_customer(customer_id)

View Source
@spec delete_customer(customer_id()) :: delete_customer_response()

Delete a customer record.

Link to this function

get_customer(customer_id)

View Source
@spec get_customer(customer_id()) :: get_customer_response()

Retrieve a customer's details.

Link to this function

update_customer(customer_id, body)

View Source

Updates the customer's details in a customer object.