charges_pkg

package
v0.0.0-...-6ed0ad3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 19, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CHARGES_IMPL

type CHARGES_IMPL struct {
	// contains filtered or unexported fields
}

* Client structure as interface implementation

func NewCHARGES

func NewCHARGES(config configuration_pkg.CONFIGURATION) *CHARGES_IMPL

* Factory for the CHARGES interaface returning CHARGES_IMPL

func (*CHARGES_IMPL) CancelCharge

func (me *CHARGES_IMPL) CancelCharge(
	chargeId string,
	idempotencyKey *string,
	body *models_pkg.ChargesRequest) (*models_pkg.ChargesResponse, error)

*

  • Cancel a charge
  • @param string chargeId parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @param *models_pkg.ChargesRequest body parameter: Optional
  • @return Returns the *models_pkg.ChargesResponse response from the API call

func (*CHARGES_IMPL) CaptureCharge

func (me *CHARGES_IMPL) CaptureCharge(
	chargeId string,
	idempotencyKey *string,
	body *models_pkg.ChargesCaptureRequest) (*models_pkg.ChargesCaptureResponse, error)

*

  • Captures a charge
  • @param string chargeId parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @param *models_pkg.ChargesCaptureRequest body parameter: Optional
  • @return Returns the *models_pkg.ChargesCaptureResponse response from the API call

func (*CHARGES_IMPL) ConfirmPayment

func (me *CHARGES_IMPL) ConfirmPayment(
	chargeId string,
	idempotencyKey *string,
	body *models_pkg.CreateConfirmPaymentRequest) (*models_pkg.ChargesConfirmPaymentResponse, error)

*

  • ConfirmPayment
  • @param string chargeId parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @param *models_pkg.CreateConfirmPaymentRequest body parameter: Optional
  • @return Returns the *models_pkg.ChargesConfirmPaymentResponse response from the API call

func (*CHARGES_IMPL) CreateCharge

func (me *CHARGES_IMPL) CreateCharge(
	body *models_pkg.ChargesRequest1,
	idempotencyKey *string) (*models_pkg.ChargesResponse, error)

*

  • Creates a new charge
  • @param *models_pkg.ChargesRequest1 body parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @return Returns the *models_pkg.ChargesResponse response from the API call

func (*CHARGES_IMPL) GetCharge

func (me *CHARGES_IMPL) GetCharge(
	chargeId string) (*models_pkg.ChargesResponse, error)

*

  • Get a charge from its id
  • @param string chargeId parameter: Required
  • @return Returns the *models_pkg.ChargesResponse response from the API call

func (*CHARGES_IMPL) GetChargeTransactions

func (me *CHARGES_IMPL) GetChargeTransactions(
	chargeId string,
	page *int64,
	size *int64) (*models_pkg.ChargesTransactionsResponse, error)

*

  • GetChargeTransactions
  • @param string chargeId parameter: Required
  • @param *int64 page parameter: Optional
  • @param *int64 size parameter: Optional
  • @return Returns the *models_pkg.ChargesTransactionsResponse response from the API call

func (*CHARGES_IMPL) GetCharges

func (me *CHARGES_IMPL) GetCharges(
	page *int64,
	size *int64,
	code *string,
	status *string,
	paymentMethod *string,
	customerId *string,
	orderId *string,
	createdSince *time.Time,
	createdUntil *time.Time) (*models_pkg.ChargesResponse2, error)

*

  • Lists all charges
  • @param *int64 page parameter: Optional
  • @param *int64 size parameter: Optional
  • @param *string code parameter: Optional
  • @param *string status parameter: Optional
  • @param *string paymentMethod parameter: Optional
  • @param *string customerId parameter: Optional
  • @param *string orderId parameter: Optional
  • @param *time.Time createdSince parameter: Optional
  • @param *time.Time createdUntil parameter: Optional
  • @return Returns the *models_pkg.ChargesResponse2 response from the API call

func (*CHARGES_IMPL) GetChargesSummary

func (me *CHARGES_IMPL) GetChargesSummary(
	status string,
	createdSince *time.Time,
	createdUntil *time.Time) (*models_pkg.GetChargesSummaryResponse, error)

*

  • GetChargesSummary
  • @param string status parameter: Required
  • @param *time.Time createdSince parameter: Optional
  • @param *time.Time createdUntil parameter: Optional
  • @return Returns the *models_pkg.GetChargesSummaryResponse response from the API call

func (*CHARGES_IMPL) RetryCharge

func (me *CHARGES_IMPL) RetryCharge(
	chargeId string,
	idempotencyKey *string) (*models_pkg.ChargesRetryResponse, error)

*

  • Retries a charge
  • @param string chargeId parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @return Returns the *models_pkg.ChargesRetryResponse response from the API call

func (*CHARGES_IMPL) UpdateChargeCard

func (me *CHARGES_IMPL) UpdateChargeCard(
	chargeId string,
	body *models_pkg.ChargesCardRequest,
	idempotencyKey *string) (*models_pkg.ChargesCardResponse, error)

*

  • Updates the card from a charge
  • @param string chargeId parameter: Required
  • @param *models_pkg.ChargesCardRequest body parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @return Returns the *models_pkg.ChargesCardResponse response from the API call

func (*CHARGES_IMPL) UpdateChargeDueDate

func (me *CHARGES_IMPL) UpdateChargeDueDate(
	chargeId string,
	body *models_pkg.ChargesDueDateRequest,
	idempotencyKey *string) (*models_pkg.ChargesDueDateResponse, error)

*

  • Updates the due date from a charge
  • @param string chargeId parameter: Required
  • @param *models_pkg.ChargesDueDateRequest body parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @return Returns the *models_pkg.ChargesDueDateResponse response from the API call

func (*CHARGES_IMPL) UpdateChargeMetadata

func (me *CHARGES_IMPL) UpdateChargeMetadata(
	chargeId string,
	body *models_pkg.ChargesMetadataRequest,
	idempotencyKey *string) (*models_pkg.ChargesMetadataResponse, error)

*

  • Updates the metadata from a charge
  • @param string chargeId parameter: Required
  • @param *models_pkg.ChargesMetadataRequest body parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @return Returns the *models_pkg.ChargesMetadataResponse response from the API call

func (*CHARGES_IMPL) UpdateChargePaymentMethod

func (me *CHARGES_IMPL) UpdateChargePaymentMethod(
	chargeId string,
	body *models_pkg.ChargesPaymentMethodRequest,
	idempotencyKey *string) (*models_pkg.ChargesPaymentMethodResponse, error)

*

  • Updates a charge's payment method
  • @param string chargeId parameter: Required
  • @param *models_pkg.ChargesPaymentMethodRequest body parameter: Required
  • @param *string idempotencyKey parameter: Optional
  • @return Returns the *models_pkg.ChargesPaymentMethodResponse response from the API call

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL