charges_pkg

package

v0.0.0-...-2e3d4c0 Latest Latest Go to latest Published: Jun 22, 2023 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pagarme/pagarme-core-api-go

Links

Open Source Insights

Documentation ¶

Index ¶

type CHARGES
type CHARGES_IMPL
- func NewCHARGES(config configuration_pkg.CONFIGURATION) *CHARGES_IMPL

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CHARGES ¶

type CHARGES interface {
	CaptureCharge(string, *string, *models_pkg.CreateCaptureChargeRequest) (*models_pkg.GetChargeResponse, error)

	GetChargeTransactions(string, *int64, *int64) (*models_pkg.ListChargeTransactionsResponse, error)

	GetCharges(*int64, *int64, *string, *string, *string, *string, *string, *time.Time, *time.Time) (*models_pkg.ListChargesResponse, error)

	UpdateChargePaymentMethod(string, *models_pkg.UpdateChargePaymentMethodRequest, *string) (*models_pkg.GetChargeResponse, error)

	UpdateChargeDueDate(string, *models_pkg.UpdateChargeDueDateRequest, *string) (*models_pkg.GetChargeResponse, error)

	ConfirmPayment(string, *string, *models_pkg.CreateConfirmPaymentRequest) (*models_pkg.GetChargeResponse, error)

	GetCharge(string) (*models_pkg.GetChargeResponse, error)

	RetryCharge(string, *string) (*models_pkg.GetChargeResponse, error)

	UpdateChargeMetadata(string, *models_pkg.UpdateMetadataRequest, *string) (*models_pkg.GetChargeResponse, error)

	UpdateChargeCard(string, *models_pkg.UpdateChargeCardRequest, *string) (*models_pkg.GetChargeResponse, error)

	CancelCharge(string, *string, *models_pkg.CreateCancelChargeRequest) (*models_pkg.GetChargeResponse, error)

	GetChargesSummary(string, *time.Time, *time.Time) (*models_pkg.GetChargesSummaryResponse, error)

	CreateCharge(*models_pkg.CreateChargeRequest, *string) (*models_pkg.GetChargeResponse, error)
}

* Interface for the CHARGES_IMPL

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.CreateCancelChargeRequest) (*models_pkg.GetChargeResponse, error)

*

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

func (*CHARGES_IMPL) CaptureCharge ¶

func (me *CHARGES_IMPL) CaptureCharge(
	chargeId string,
	idempotencyKey *string,
	body *models_pkg.CreateCaptureChargeRequest) (*models_pkg.GetChargeResponse, error)

*

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

func (*CHARGES_IMPL) ConfirmPayment ¶

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

*

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

func (*CHARGES_IMPL) CreateCharge ¶

func (me *CHARGES_IMPL) CreateCharge(
	body *models_pkg.CreateChargeRequest,
	idempotencyKey *string) (*models_pkg.GetChargeResponse, error)

*

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

func (*CHARGES_IMPL) GetCharge ¶

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

*

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

func (*CHARGES_IMPL) GetChargeTransactions ¶

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

*

GetChargeTransactions
@param string chargeId parameter: Required
@param *int64 page parameter: Optional
@param *int64 size parameter: Optional
@return Returns the *models_pkg.ListChargeTransactionsResponse 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.ListChargesResponse, 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.ListChargesResponse 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.GetChargeResponse, error)

*

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

func (*CHARGES_IMPL) UpdateChargeCard ¶

func (me *CHARGES_IMPL) UpdateChargeCard(
	chargeId string,
	body *models_pkg.UpdateChargeCardRequest,
	idempotencyKey *string) (*models_pkg.GetChargeResponse, error)

*

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

func (*CHARGES_IMPL) UpdateChargeDueDate ¶

func (me *CHARGES_IMPL) UpdateChargeDueDate(
	chargeId string,
	body *models_pkg.UpdateChargeDueDateRequest,
	idempotencyKey *string) (*models_pkg.GetChargeResponse, error)

*

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

func (*CHARGES_IMPL) UpdateChargeMetadata ¶

func (me *CHARGES_IMPL) UpdateChargeMetadata(
	chargeId string,
	body *models_pkg.UpdateMetadataRequest,
	idempotencyKey *string) (*models_pkg.GetChargeResponse, error)

*

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

func (*CHARGES_IMPL) UpdateChargePaymentMethod ¶

func (me *CHARGES_IMPL) UpdateChargePaymentMethod(
	chargeId string,
	body *models_pkg.UpdateChargePaymentMethodRequest,
	idempotencyKey *string) (*models_pkg.GetChargeResponse, error)

*

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

Source Files ¶

View all Source files

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