View Source Hyperswitch.Refunds (hyperswitch v0.1.0)

Link to this section Summary

Functions

To create a refund against an already processed payment.

To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment.

To list the refunds associated with a payment_id or with the merchant, if payment_id is not provided.

To update the properties of a Refund object. This may include attaching a reason for the refund or metadata fields.

Link to this section Types

Link to this type

create_refund_params()

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

create_refund_response()

View Source
@type create_refund_response() :: Hyperswitch.Client.response()
@type get_accont_response() :: Hyperswitch.Client.response()
@type list_refunds_params() :: map()
Link to this type

list_refunds_response()

View Source
@type list_refunds_response() :: Hyperswitch.Client.response()
@type refund_id() :: binary()
Link to this type

update_refund_params()

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

update_refund_response()

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

Link to this section Functions

@spec create_refund(create_refund_params()) :: create_refund_response()

To create a refund against an already processed payment.

@spec get_refund(refund_id()) :: get_accont_response()

To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment.

Link to this function

list_refunds(params \\ [])

View Source
@spec list_refunds(list_refunds_params()) :: list_refunds_response()

To list the refunds associated with a payment_id or with the merchant, if payment_id is not provided.

Link to this function

update_refund(refund_id, body)

View Source
@spec update_refund(refund_id(), update_refund_params()) :: update_refund_response()

To update the properties of a Refund object. This may include attaching a reason for the refund or metadata fields.