models

package
v0.0.0-...-05f3020 Latest Latest
Warning

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

Go to latest
Published: Nov 1, 2023 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package pagarmeapisdk

This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateAccessTokenRequest

type CreateAccessTokenRequest struct {
	ExpiresIn *int `json:"expires_in,omitempty"`
}

Request for creating a new Access Token

func (*CreateAccessTokenRequest) MarshalJSON

func (c *CreateAccessTokenRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateAccessTokenRequest) UnmarshalJSON

func (c *CreateAccessTokenRequest) UnmarshalJSON(input []byte) error

type CreateAddressRequest

type CreateAddressRequest struct {
	Street       string                            `json:"street"`
	Number       string                            `json:"number"`
	ZipCode      string                            `json:"zip_code"`
	Neighborhood string                            `json:"neighborhood"`
	City         string                            `json:"city"`
	State        string                            `json:"state"`
	Country      string                            `json:"country"`
	Complement   string                            `json:"complement,omitempty"`
	Metadata     types.Optional[map[string]string] `json:"metadata,omitempty"`
	Line1        string                            `json:"line_1,omitempty"`
	Line2        string                            `json:"line_2,omitempty"`
}

Request for creating a new Address

func (*CreateAddressRequest) MarshalJSON

func (c *CreateAddressRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateAddressRequest) UnmarshalJSON

func (c *CreateAddressRequest) UnmarshalJSON(input []byte) error

type CreateAnticipationRequest

type CreateAnticipationRequest struct {
	Amount      int       `json:"amount"`
	Timeframe   string    `json:"timeframe"`
	PaymentDate time.Time `json:"payment_date"`
}

Request for creating an anticipation

func (*CreateAnticipationRequest) MarshalJSON

func (c *CreateAnticipationRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateAnticipationRequest) UnmarshalJSON

func (c *CreateAnticipationRequest) UnmarshalJSON(input []byte) error

type CreateAntifraudRequest

type CreateAntifraudRequest struct {
	Type      string                 `json:"type"`
	Clearsale CreateClearSaleRequest `json:"clearsale"`
}

func (*CreateAntifraudRequest) MarshalJSON

func (c *CreateAntifraudRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateAntifraudRequest) UnmarshalJSON

func (c *CreateAntifraudRequest) UnmarshalJSON(input []byte) error

type CreateApplePayHeaderRequest

type CreateApplePayHeaderRequest struct {
	PublicKeyHash      *string `json:"public_key_hash,omitempty"`
	EphemeralPublicKey string  `json:"ephemeral_public_key"`
	TransactionId      *string `json:"transaction_id,omitempty"`
}

The ApplePay header request

func (*CreateApplePayHeaderRequest) MarshalJSON

func (c *CreateApplePayHeaderRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateApplePayHeaderRequest) UnmarshalJSON

func (c *CreateApplePayHeaderRequest) UnmarshalJSON(input []byte) error

type CreateApplePayRequest

type CreateApplePayRequest struct {
	Version            string                      `json:"version"`
	Data               string                      `json:"data"`
	Header             CreateApplePayHeaderRequest `json:"header"`
	Signature          string                      `json:"signature"`
	MerchantIdentifier string                      `json:"merchant_identifier"`
}

The ApplePay Token Payment Request

func (*CreateApplePayRequest) MarshalJSON

func (c *CreateApplePayRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateApplePayRequest) UnmarshalJSON

func (c *CreateApplePayRequest) UnmarshalJSON(input []byte) error

type CreateAutomaticAnticipationSettingsRequest

type CreateAutomaticAnticipationSettingsRequest struct {
	Enabled          bool   `json:"enabled"`
	Type             string `json:"type"`
	VolumePercentage int    `json:"volume_percentage"`
	Delay            int    `json:"delay"`
	Days             []int  `json:"days"`
}

func (*CreateAutomaticAnticipationSettingsRequest) MarshalJSON

func (c *CreateAutomaticAnticipationSettingsRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateAutomaticAnticipationSettingsRequest) UnmarshalJSON

func (c *CreateAutomaticAnticipationSettingsRequest) UnmarshalJSON(input []byte) error

type CreateBankAccountRefundingDTO

type CreateBankAccountRefundingDTO struct {
	HolderName        string `json:"holder_name"`
	HolderType        string `json:"holder_type"`
	HolderDocument    string `json:"holder_document"`
	Bank              string `json:"bank"`
	BranchNumber      string `json:"branch_number"`
	BranchCheckDigit  string `json:"branch_check_digit"`
	AccountNumber     string `json:"account_number"`
	AccountCheckDigit string `json:"account_check_digit"`
	Type              string `json:"type"`
}

Bank Account

func (*CreateBankAccountRefundingDTO) MarshalJSON

func (c *CreateBankAccountRefundingDTO) MarshalJSON() (
	[]byte,
	error)

func (*CreateBankAccountRefundingDTO) UnmarshalJSON

func (c *CreateBankAccountRefundingDTO) UnmarshalJSON(input []byte) error

type CreateBankAccountRequest

type CreateBankAccountRequest struct {
	HolderName        string                 `json:"holder_name"`
	HolderType        string                 `json:"holder_type"`
	HolderDocument    string                 `json:"holder_document"`
	Bank              string                 `json:"bank"`
	BranchNumber      string                 `json:"branch_number"`
	BranchCheckDigit  types.Optional[string] `json:"branch_check_digit"`
	AccountNumber     string                 `json:"account_number"`
	AccountCheckDigit string                 `json:"account_check_digit"`
	Type              string                 `json:"type"`
	Metadata          map[string]string      `json:"metadata"`
	PixKey            types.Optional[string] `json:"pix_key"`
}

Request for creating a bank account

func (*CreateBankAccountRequest) MarshalJSON

func (c *CreateBankAccountRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateBankAccountRequest) UnmarshalJSON

func (c *CreateBankAccountRequest) UnmarshalJSON(input []byte) error

type CreateBankTransferPaymentRequest

type CreateBankTransferPaymentRequest struct {
	Bank    string `json:"bank"`
	Retries int    `json:"retries"`
}

Request for creating a bank transfer payment

func (*CreateBankTransferPaymentRequest) MarshalJSON

func (c *CreateBankTransferPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateBankTransferPaymentRequest) UnmarshalJSON

func (c *CreateBankTransferPaymentRequest) UnmarshalJSON(input []byte) error

type CreateBoletoPaymentRequest

type CreateBoletoPaymentRequest struct {
	Retries             int                                   `json:"retries"`
	Bank                types.Optional[string]                `json:"bank"`
	Instructions        string                                `json:"instructions"`
	DueAt               types.Optional[time.Time]             `json:"due_at"`
	BillingAddress      CreateAddressRequest                  `json:"billing_address"`
	BillingAddressId    types.Optional[string]                `json:"billing_address_id"`
	NossoNumero         types.Optional[string]                `json:"nosso_numero"`
	DocumentNumber      string                                `json:"document_number"`
	StatementDescriptor string                                `json:"statement_descriptor"`
	Interest            types.Optional[CreateInterestRequest] `json:"interest"`
	Fine                types.Optional[CreateFineRequest]     `json:"fine"`
	MaxDaysToPayPastDue types.Optional[int]                   `json:"max_days_to_pay_past_due"`
}

Contains the settings for creating a boleto payment

func (*CreateBoletoPaymentRequest) MarshalJSON

func (c *CreateBoletoPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateBoletoPaymentRequest) UnmarshalJSON

func (c *CreateBoletoPaymentRequest) UnmarshalJSON(input []byte) error

type CreateCancelChargeRequest

type CreateCancelChargeRequest struct {
	Amount             *int                                   `json:"amount,omitempty"`
	SplitRules         *[]CreateCancelChargeSplitRulesRequest `json:"split_rules,omitempty"`
	Split              *[]CreateSplitRequest                  `json:"split,omitempty"`
	OperationReference string                                 `json:"operation_reference"`
	BankAccount        *CreateBankAccountRefundingDTO         `json:"bank_account,omitempty"`
}

Request for canceling a charge.

func (*CreateCancelChargeRequest) MarshalJSON

func (c *CreateCancelChargeRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCancelChargeRequest) UnmarshalJSON

func (c *CreateCancelChargeRequest) UnmarshalJSON(input []byte) error

type CreateCancelChargeSplitRulesRequest

type CreateCancelChargeSplitRulesRequest struct {
	Id     string `json:"id"`
	Amount int    `json:"Amount"`
	Type   string `json:"type"`
}

Creates a refund with split rules

func (*CreateCancelChargeSplitRulesRequest) MarshalJSON

func (c *CreateCancelChargeSplitRulesRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCancelChargeSplitRulesRequest) UnmarshalJSON

func (c *CreateCancelChargeSplitRulesRequest) UnmarshalJSON(input []byte) error

type CreateCancelSubscriptionRequest

type CreateCancelSubscriptionRequest struct {
	CancelPendingInvoices bool `json:"cancel_pending_invoices"`
}

Request for canceling a subscription

func (*CreateCancelSubscriptionRequest) MarshalJSON

func (c *CreateCancelSubscriptionRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCancelSubscriptionRequest) UnmarshalJSON

func (c *CreateCancelSubscriptionRequest) UnmarshalJSON(input []byte) error

type CreateCaptureChargeRequest

type CreateCaptureChargeRequest struct {
	Code               string                `json:"code"`
	Amount             *int                  `json:"amount,omitempty"`
	Split              *[]CreateSplitRequest `json:"split,omitempty"`
	OperationReference string                `json:"operation_reference"`
}

Request for capturing a charge

func (*CreateCaptureChargeRequest) MarshalJSON

func (c *CreateCaptureChargeRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCaptureChargeRequest) UnmarshalJSON

func (c *CreateCaptureChargeRequest) UnmarshalJSON(input []byte) error

type CreateCardOptionsRequest

type CreateCardOptionsRequest struct {
	VerifyCard bool `json:"verify_card"`
}

Options for creating the card

func (*CreateCardOptionsRequest) MarshalJSON

func (c *CreateCardOptionsRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCardOptionsRequest) UnmarshalJSON

func (c *CreateCardOptionsRequest) UnmarshalJSON(input []byte) error

type CreateCardPaymentContactlessPOIRequest

type CreateCardPaymentContactlessPOIRequest struct {
	SystemName    string `json:"system_name"`
	Model         string `json:"model"`
	Provider      string `json:"provider"`
	SerialNumber  string `json:"serial_number"`
	VersionNumber string `json:"version_number"`
}

func (*CreateCardPaymentContactlessPOIRequest) MarshalJSON

func (c *CreateCardPaymentContactlessPOIRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCardPaymentContactlessPOIRequest) UnmarshalJSON

func (c *CreateCardPaymentContactlessPOIRequest) UnmarshalJSON(input []byte) error

type CreateCardPaymentContactlessRequest

type CreateCardPaymentContactlessRequest struct {
	Type      string                   `json:"type"`
	ApplePay  *CreateApplePayRequest   `json:"apple_pay,omitempty"`
	GooglePay *CreateGooglePayRequest  `json:"google_pay,omitempty"`
	Emv       *CreateEmvDecryptRequest `json:"emv,omitempty"`
}

The card payment contactless request

func (*CreateCardPaymentContactlessRequest) MarshalJSON

func (c *CreateCardPaymentContactlessRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCardPaymentContactlessRequest) UnmarshalJSON

func (c *CreateCardPaymentContactlessRequest) UnmarshalJSON(input []byte) error

type CreateCardRequest

type CreateCardRequest struct {
	Number           *string                   `json:"number,omitempty"`
	HolderName       *string                   `json:"holder_name,omitempty"`
	ExpMonth         *int                      `json:"exp_month,omitempty"`
	ExpYear          *int                      `json:"exp_year,omitempty"`
	Cvv              *string                   `json:"cvv,omitempty"`
	BillingAddress   *CreateAddressRequest     `json:"billing_address,omitempty"`
	Brand            *string                   `json:"brand,omitempty"`
	BillingAddressId *string                   `json:"billing_address_id,omitempty"`
	Metadata         map[string]*string        `json:"metadata,omitempty"`
	Type             *string                   `json:"type,omitempty"`
	Options          *CreateCardOptionsRequest `json:"options,omitempty"`
	HolderDocument   *string                   `json:"holder_document,omitempty"`
	PrivateLabel     *bool                     `json:"private_label,omitempty"`
	Label            *string                   `json:"label,omitempty"`
	Id               *string                   `json:"id,omitempty"`
	Token            *string                   `json:"token,omitempty"`
}

Card data

func (*CreateCardRequest) MarshalJSON

func (c *CreateCardRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCardRequest) UnmarshalJSON

func (c *CreateCardRequest) UnmarshalJSON(input []byte) error

type CreateCardTokenRequest

type CreateCardTokenRequest struct {
	Number     string `json:"number"`
	HolderName string `json:"holder_name"`
	ExpMonth   int    `json:"exp_month"`
	ExpYear    int    `json:"exp_year"`
	Cvv        string `json:"cvv"`
	Brand      string `json:"brand"`
	Label      string `json:"label"`
}

Card token data

func (*CreateCardTokenRequest) MarshalJSON

func (c *CreateCardTokenRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCardTokenRequest) UnmarshalJSON

func (c *CreateCardTokenRequest) UnmarshalJSON(input []byte) error

type CreateCashPaymentRequest

type CreateCashPaymentRequest struct {
	Description string `json:"description"`
	Confirm     bool   `json:"confirm"`
}

func (*CreateCashPaymentRequest) MarshalJSON

func (c *CreateCashPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCashPaymentRequest) UnmarshalJSON

func (c *CreateCashPaymentRequest) UnmarshalJSON(input []byte) error

type CreateChargeRequest

type CreateChargeRequest struct {
	Code       types.Optional[string]                 `json:"code"`
	Amount     int                                    `json:"amount"`
	CustomerId types.Optional[string]                 `json:"customer_id"`
	Customer   types.Optional[CreateCustomerRequest]  `json:"customer"`
	Payment    CreatePaymentRequest                   `json:"payment"`
	Metadata   types.Optional[map[string]string]      `json:"metadata"`
	DueAt      types.Optional[time.Time]              `json:"due_at"`
	Antifraud  types.Optional[CreateAntifraudRequest] `json:"antifraud"`
	OrderId    string                                 `json:"order_id"`
}

Request for creating a new charge

func (*CreateChargeRequest) MarshalJSON

func (c *CreateChargeRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateChargeRequest) UnmarshalJSON

func (c *CreateChargeRequest) UnmarshalJSON(input []byte) error

type CreateCheckoutBankTransferRequest

type CreateCheckoutBankTransferRequest struct {
	Bank    []string `json:"bank"`
	Retries int      `json:"retries"`
}

Checkout bank transfer payment request

func (*CreateCheckoutBankTransferRequest) MarshalJSON

func (c *CreateCheckoutBankTransferRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCheckoutBankTransferRequest) UnmarshalJSON

func (c *CreateCheckoutBankTransferRequest) UnmarshalJSON(input []byte) error

type CreateCheckoutBoletoPaymentRequest

type CreateCheckoutBoletoPaymentRequest struct {
	Bank         string    `json:"bank"`
	Instructions string    `json:"instructions"`
	DueAt        time.Time `json:"due_at"`
}

func (*CreateCheckoutBoletoPaymentRequest) MarshalJSON

func (c *CreateCheckoutBoletoPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCheckoutBoletoPaymentRequest) UnmarshalJSON

func (c *CreateCheckoutBoletoPaymentRequest) UnmarshalJSON(input []byte) error

type CreateCheckoutCardInstallmentOptionRequest

type CreateCheckoutCardInstallmentOptionRequest struct {
	Number int `json:"number"`
	Total  int `json:"total"`
}

Options for card installment

func (*CreateCheckoutCardInstallmentOptionRequest) MarshalJSON

func (c *CreateCheckoutCardInstallmentOptionRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCheckoutCardInstallmentOptionRequest) UnmarshalJSON

func (c *CreateCheckoutCardInstallmentOptionRequest) UnmarshalJSON(input []byte) error

type CreateCheckoutCreditCardPaymentRequest

type CreateCheckoutCreditCardPaymentRequest struct {
	StatementDescriptor *string                                       `json:"statement_descriptor,omitempty"`
	Installments        *[]CreateCheckoutCardInstallmentOptionRequest `json:"installments,omitempty"`
	Authentication      *CreatePaymentAuthenticationRequest           `json:"authentication,omitempty"`
	Capture             *bool                                         `json:"capture,omitempty"`
}

Checkout card payment request

func (*CreateCheckoutCreditCardPaymentRequest) MarshalJSON

func (c *CreateCheckoutCreditCardPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCheckoutCreditCardPaymentRequest) UnmarshalJSON

func (c *CreateCheckoutCreditCardPaymentRequest) UnmarshalJSON(input []byte) error

type CreateCheckoutDebitCardPaymentRequest

type CreateCheckoutDebitCardPaymentRequest struct {
	StatementDescriptor *string                            `json:"statement_descriptor,omitempty"`
	Authentication      CreatePaymentAuthenticationRequest `json:"authentication"`
}

Checkout credit card payment request

func (*CreateCheckoutDebitCardPaymentRequest) MarshalJSON

func (c *CreateCheckoutDebitCardPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCheckoutDebitCardPaymentRequest) UnmarshalJSON

func (c *CreateCheckoutDebitCardPaymentRequest) UnmarshalJSON(input []byte) error

type CreateCheckoutPaymentRequest

type CreateCheckoutPaymentRequest struct {
	AcceptedPaymentMethods      []string                                `json:"accepted_payment_methods"`
	AcceptedMultiPaymentMethods []interface{}                           `json:"accepted_multi_payment_methods"`
	SuccessUrl                  string                                  `json:"success_url"`
	DefaultPaymentMethod        *string                                 `json:"default_payment_method,omitempty"`
	GatewayAffiliationId        *string                                 `json:"gateway_affiliation_id,omitempty"`
	CreditCard                  *CreateCheckoutCreditCardPaymentRequest `json:"credit_card,omitempty"`
	DebitCard                   *CreateCheckoutDebitCardPaymentRequest  `json:"debit_card,omitempty"`
	Boleto                      *CreateCheckoutBoletoPaymentRequest     `json:"boleto,omitempty"`
	CustomerEditable            *bool                                   `json:"customer_editable,omitempty"`
	ExpiresIn                   *int                                    `json:"expires_in,omitempty"`
	SkipCheckoutSuccessPage     bool                                    `json:"skip_checkout_success_page"`
	BillingAddressEditable      bool                                    `json:"billing_address_editable"`
	BillingAddress              CreateAddressRequest                    `json:"billing_address"`
	BankTransfer                *CreateCheckoutBankTransferRequest      `json:"bank_transfer,omitempty"`
	AcceptedBrands              []string                                `json:"accepted_brands"`
	Pix                         *CreateCheckoutPixPaymentRequest        `json:"pix,omitempty"`
}

Checkout payment request

func (*CreateCheckoutPaymentRequest) MarshalJSON

func (c *CreateCheckoutPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCheckoutPaymentRequest) UnmarshalJSON

func (c *CreateCheckoutPaymentRequest) UnmarshalJSON(input []byte) error

type CreateCheckoutPixPaymentRequest

type CreateCheckoutPixPaymentRequest struct {
	ExpiresAt             *time.Time                  `json:"expires_at,omitempty"`
	ExpiresIn             *int                        `json:"expires_in,omitempty"`
	AdditionalInformation *[]PixAdditionalInformation `json:"additional_information,omitempty"`
}

Checkout pix payment request

func (*CreateCheckoutPixPaymentRequest) MarshalJSON

func (c *CreateCheckoutPixPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCheckoutPixPaymentRequest) UnmarshalJSON

func (c *CreateCheckoutPixPaymentRequest) UnmarshalJSON(input []byte) error

type CreateClearSaleRequest

type CreateClearSaleRequest struct {
	CustomSla int `json:"custom_sla"`
}

func (*CreateClearSaleRequest) MarshalJSON

func (c *CreateClearSaleRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateClearSaleRequest) UnmarshalJSON

func (c *CreateClearSaleRequest) UnmarshalJSON(input []byte) error

type CreateConfirmPaymentRequest

type CreateConfirmPaymentRequest struct {
	Description string `json:"description"`
	Amount      *int   `json:"Amount,omitempty"`
	Code        string `json:"Code"`
}

func (*CreateConfirmPaymentRequest) MarshalJSON

func (c *CreateConfirmPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateConfirmPaymentRequest) UnmarshalJSON

func (c *CreateConfirmPaymentRequest) UnmarshalJSON(input []byte) error

type CreateCreditCardPaymentRequest

type CreateCreditCardPaymentRequest struct {
	Installments         *int                                 `json:"installments,omitempty"`
	StatementDescriptor  *string                              `json:"statement_descriptor,omitempty"`
	Card                 *CreateCardRequest                   `json:"card,omitempty"`
	CardId               *string                              `json:"card_id,omitempty"`
	CardToken            *string                              `json:"card_token,omitempty"`
	Recurrence           *bool                                `json:"recurrence,omitempty"`
	Capture              *bool                                `json:"capture,omitempty"`
	ExtendedLimitEnabled *bool                                `json:"extended_limit_enabled,omitempty"`
	ExtendedLimitCode    *string                              `json:"extended_limit_code,omitempty"`
	MerchantCategoryCode *int64                               `json:"merchant_category_code,omitempty"`
	Authentication       *CreatePaymentAuthenticationRequest  `json:"authentication,omitempty"`
	Contactless          *CreateCardPaymentContactlessRequest `json:"contactless,omitempty"`
	AutoRecovery         *bool                                `json:"auto_recovery,omitempty"`
	OperationType        *string                              `json:"operation_type,omitempty"`
	RecurrencyCycle      *string                              `json:"recurrency_cycle,omitempty"`
}

The settings for creating a credit card payment

func (*CreateCreditCardPaymentRequest) MarshalJSON

func (c *CreateCreditCardPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCreditCardPaymentRequest) UnmarshalJSON

func (c *CreateCreditCardPaymentRequest) UnmarshalJSON(input []byte) error

type CreateCustomerRequest

type CreateCustomerRequest struct {
	Name         string               `json:"name"`
	Email        string               `json:"email"`
	Document     string               `json:"document"`
	Type         string               `json:"type"`
	Address      CreateAddressRequest `json:"address"`
	Metadata     map[string]string    `json:"metadata,omitempty"`
	Phones       CreatePhonesRequest  `json:"phones"`
	Code         string               `json:"code,omitempty"`
	Gender       *string              `json:"gender,omitempty"`
	DocumentType *string              `json:"document_type,omitempty"`
}

Request for creating a new customer

func (*CreateCustomerRequest) MarshalJSON

func (c *CreateCustomerRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateCustomerRequest) UnmarshalJSON

func (c *CreateCustomerRequest) UnmarshalJSON(input []byte) error

type CreateDebitCardPaymentRequest

type CreateDebitCardPaymentRequest struct {
	StatementDescriptor *string                              `json:"statement_descriptor,omitempty"`
	Card                *CreateCardRequest                   `json:"card,omitempty"`
	CardId              *string                              `json:"card_id,omitempty"`
	CardToken           *string                              `json:"card_token,omitempty"`
	Recurrence          *bool                                `json:"recurrence,omitempty"`
	Capture             *bool                                `json:"capture,omitempty"`
	Authentication      *CreatePaymentAuthenticationRequest  `json:"authentication,omitempty"`
	Token               *CreateCardPaymentContactlessRequest `json:"token,omitempty"`
}

The settings for creating a debit card payment

func (*CreateDebitCardPaymentRequest) MarshalJSON

func (c *CreateDebitCardPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateDebitCardPaymentRequest) UnmarshalJSON

func (c *CreateDebitCardPaymentRequest) UnmarshalJSON(input []byte) error

type CreateDeviceRequest

type CreateDeviceRequest struct {
	Platform *string `json:"platform,omitempty"`
}

Request for creating a device

func (*CreateDeviceRequest) MarshalJSON

func (c *CreateDeviceRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateDeviceRequest) UnmarshalJSON

func (c *CreateDeviceRequest) UnmarshalJSON(input []byte) error

type CreateDiscountRequest

type CreateDiscountRequest struct {
	Value        float64 `json:"value"`
	DiscountType string  `json:"discount_type"`
	ItemId       string  `json:"item_id"`
	Cycles       *int    `json:"cycles,omitempty"`
	Description  *string `json:"description,omitempty"`
}

Request for creating a new discount

func (*CreateDiscountRequest) MarshalJSON

func (c *CreateDiscountRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateDiscountRequest) UnmarshalJSON

func (c *CreateDiscountRequest) UnmarshalJSON(input []byte) error

type CreateEmvDataDecryptRequest

type CreateEmvDataDecryptRequest struct {
	Cipher string                            `json:"cipher"`
	Dukpt  *CreateEmvDataDukptDecryptRequest `json:"dukpt,omitempty"`
	Tags   []CreateEmvDataTlvDecryptRequest  `json:"tags"`
}

func (*CreateEmvDataDecryptRequest) MarshalJSON

func (c *CreateEmvDataDecryptRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateEmvDataDecryptRequest) UnmarshalJSON

func (c *CreateEmvDataDecryptRequest) UnmarshalJSON(input []byte) error

type CreateEmvDataDukptDecryptRequest

type CreateEmvDataDukptDecryptRequest struct {
	Ksn string `json:"ksn"`
}

func (*CreateEmvDataDukptDecryptRequest) MarshalJSON

func (c *CreateEmvDataDukptDecryptRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateEmvDataDukptDecryptRequest) UnmarshalJSON

func (c *CreateEmvDataDukptDecryptRequest) UnmarshalJSON(input []byte) error

type CreateEmvDataTlvDecryptRequest

type CreateEmvDataTlvDecryptRequest struct {
	Tag    string `json:"tag"`
	Lenght string `json:"lenght"`
	Value  string `json:"value"`
}

func (*CreateEmvDataTlvDecryptRequest) MarshalJSON

func (c *CreateEmvDataTlvDecryptRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateEmvDataTlvDecryptRequest) UnmarshalJSON

func (c *CreateEmvDataTlvDecryptRequest) UnmarshalJSON(input []byte) error

type CreateEmvDecryptRequest

type CreateEmvDecryptRequest struct {
	IccData            string                                  `json:"icc_data"`
	CardSequenceNumber string                                  `json:"card_sequence_number"`
	Data               CreateEmvDataDecryptRequest             `json:"data"`
	Poi                *CreateCardPaymentContactlessPOIRequest `json:"poi,omitempty"`
}

func (*CreateEmvDecryptRequest) MarshalJSON

func (c *CreateEmvDecryptRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateEmvDecryptRequest) UnmarshalJSON

func (c *CreateEmvDecryptRequest) UnmarshalJSON(input []byte) error

type CreateFineRequest

type CreateFineRequest struct {
	Days   int    `json:"days"`
	Type   string `json:"type"`
	Amount int    `json:"amount"`
}

Fine Request

func (*CreateFineRequest) MarshalJSON

func (c *CreateFineRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateFineRequest) UnmarshalJSON

func (c *CreateFineRequest) UnmarshalJSON(input []byte) error

type CreateGooglePayHeaderRequest

type CreateGooglePayHeaderRequest struct {
	EphemeralPublicKey string `json:"ephemeral_public_key"`
}

The GooglePay header request

func (*CreateGooglePayHeaderRequest) MarshalJSON

func (c *CreateGooglePayHeaderRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateGooglePayHeaderRequest) UnmarshalJSON

func (c *CreateGooglePayHeaderRequest) UnmarshalJSON(input []byte) error

type CreateGooglePayRequest

type CreateGooglePayRequest struct {
	Version            string                       `json:"version"`
	Data               string                       `json:"data"`
	Header             CreateGooglePayHeaderRequest `json:"header"`
	Signature          string                       `json:"signature"`
	MerchantIdentifier string                       `json:"merchant_identifier"`
}

The GooglePay Token Payment Request

func (*CreateGooglePayRequest) MarshalJSON

func (c *CreateGooglePayRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateGooglePayRequest) UnmarshalJSON

func (c *CreateGooglePayRequest) UnmarshalJSON(input []byte) error

type CreateIncrementRequest

type CreateIncrementRequest struct {
	Value         float64 `json:"value"`
	IncrementType string  `json:"increment_type"`
	ItemId        string  `json:"item_id"`
	Cycles        *int    `json:"cycles,omitempty"`
	Description   *string `json:"description,omitempty"`
}

Request for creating a new increment

func (*CreateIncrementRequest) MarshalJSON

func (c *CreateIncrementRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateIncrementRequest) UnmarshalJSON

func (c *CreateIncrementRequest) UnmarshalJSON(input []byte) error

type CreateInterestRequest

type CreateInterestRequest struct {
	Days   int    `json:"days"`
	Type   string `json:"type"`
	Amount int    `json:"amount"`
}

Interest Request

func (*CreateInterestRequest) MarshalJSON

func (c *CreateInterestRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateInterestRequest) UnmarshalJSON

func (c *CreateInterestRequest) UnmarshalJSON(input []byte) error

type CreateInvoiceRequest

type CreateInvoiceRequest struct {
	Metadata map[string]string `json:"metadata"`
}

Request for creating a new Invoice

func (*CreateInvoiceRequest) MarshalJSON

func (c *CreateInvoiceRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateInvoiceRequest) UnmarshalJSON

func (c *CreateInvoiceRequest) UnmarshalJSON(input []byte) error

type CreateLocationRequest

type CreateLocationRequest struct {
	Latitude  string `json:"latitude"`
	Longitude string `json:"longitude"`
}

Request for creating a location

func (*CreateLocationRequest) MarshalJSON

func (c *CreateLocationRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateLocationRequest) UnmarshalJSON

func (c *CreateLocationRequest) UnmarshalJSON(input []byte) error

type CreateOrderItemRequest

type CreateOrderItemRequest struct {
	Amount      int     `json:"amount"`
	Description string  `json:"description"`
	Quantity    int     `json:"quantity"`
	Category    string  `json:"category"`
	Code        *string `json:"code,omitempty"`
}

Request for creating an order item

func (*CreateOrderItemRequest) MarshalJSON

func (c *CreateOrderItemRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateOrderItemRequest) UnmarshalJSON

func (c *CreateOrderItemRequest) UnmarshalJSON(input []byte) error

type CreateOrderRequest

type CreateOrderRequest struct {
	Items            []CreateOrderItemRequest          `json:"items"`
	Customer         CreateCustomerRequest             `json:"customer"`
	Payments         []CreatePaymentRequest            `json:"payments"`
	Code             string                            `json:"code"`
	CustomerId       types.Optional[string]            `json:"customer_id"`
	Shipping         *CreateShippingRequest            `json:"shipping,omitempty"`
	Metadata         types.Optional[map[string]string] `json:"metadata"`
	AntifraudEnabled *bool                             `json:"antifraud_enabled,omitempty"`
	Ip               *string                           `json:"ip,omitempty"`
	SessionId        *string                           `json:"session_id,omitempty"`
	Location         *CreateLocationRequest            `json:"location,omitempty"`
	Device           *CreateDeviceRequest              `json:"device,omitempty"`
	Closed           bool                              `json:"closed"`
	Currency         *string                           `json:"currency,omitempty"`
	Antifraud        *CreateAntifraudRequest           `json:"antifraud,omitempty"`
	Submerchant      *CreateSubMerchantRequest         `json:"submerchant,omitempty"`
}

Request for creating an order

func (*CreateOrderRequest) MarshalJSON

func (c *CreateOrderRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateOrderRequest) UnmarshalJSON

func (c *CreateOrderRequest) UnmarshalJSON(input []byte) error

type CreatePaymentAuthenticationRequest

type CreatePaymentAuthenticationRequest struct {
	Type         string                    `json:"type"`
	ThreedSecure CreateThreeDSecureRequest `json:"threed_secure"`
}

The payment authentication request

func (*CreatePaymentAuthenticationRequest) MarshalJSON

func (c *CreatePaymentAuthenticationRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePaymentAuthenticationRequest) UnmarshalJSON

func (c *CreatePaymentAuthenticationRequest) UnmarshalJSON(input []byte) error

type CreatePaymentRequest

type CreatePaymentRequest struct {
	PaymentMethod        string                            `json:"payment_method"`
	CreditCard           *CreateCreditCardPaymentRequest   `json:"credit_card,omitempty"`
	DebitCard            *CreateDebitCardPaymentRequest    `json:"debit_card,omitempty"`
	Boleto               *CreateBoletoPaymentRequest       `json:"boleto,omitempty"`
	Currency             *string                           `json:"currency,omitempty"`
	Voucher              *CreateVoucherPaymentRequest      `json:"voucher,omitempty"`
	Split                *[]CreateSplitRequest             `json:"split,omitempty"`
	BankTransfer         *CreateBankTransferPaymentRequest `json:"bank_transfer,omitempty"`
	GatewayAffiliationId *string                           `json:"gateway_affiliation_id,omitempty"`
	Amount               *int                              `json:"amount,omitempty"`
	Checkout             *CreateCheckoutPaymentRequest     `json:"checkout,omitempty"`
	CustomerId           *string                           `json:"customer_id,omitempty"`
	Customer             *CreateCustomerRequest            `json:"customer,omitempty"`
	Metadata             map[string]*string                `json:"metadata,omitempty"`
	Cash                 *CreateCashPaymentRequest         `json:"cash,omitempty"`
	PrivateLabel         *CreatePrivateLabelPaymentRequest `json:"private_label,omitempty"`
	Pix                  *CreatePixPaymentRequest          `json:"pix,omitempty"`
}

Payment data

func (*CreatePaymentRequest) MarshalJSON

func (c *CreatePaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePaymentRequest) UnmarshalJSON

func (c *CreatePaymentRequest) UnmarshalJSON(input []byte) error

type CreatePeriodRequest

type CreatePeriodRequest struct {
	EndAt *time.Time `json:"end_at,omitempty"`
}

func (*CreatePeriodRequest) MarshalJSON

func (c *CreatePeriodRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePeriodRequest) UnmarshalJSON

func (c *CreatePeriodRequest) UnmarshalJSON(input []byte) error

type CreatePhoneRequest

type CreatePhoneRequest struct {
	CountryCode *string `json:"country_code,omitempty"`
	Number      *string `json:"number,omitempty"`
	AreaCode    *string `json:"area_code,omitempty"`
}

func (*CreatePhoneRequest) MarshalJSON

func (c *CreatePhoneRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePhoneRequest) UnmarshalJSON

func (c *CreatePhoneRequest) UnmarshalJSON(input []byte) error

type CreatePhonesRequest

type CreatePhonesRequest struct {
	HomePhone   *CreatePhoneRequest `json:"home_phone,omitempty"`
	MobilePhone *CreatePhoneRequest `json:"mobile_phone,omitempty"`
}

func (*CreatePhonesRequest) MarshalJSON

func (c *CreatePhonesRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePhonesRequest) UnmarshalJSON

func (c *CreatePhonesRequest) UnmarshalJSON(input []byte) error

type CreatePixPaymentRequest

type CreatePixPaymentRequest struct {
	ExpiresAt             *time.Time                  `json:"expires_at,omitempty"`
	ExpiresIn             *int                        `json:"expires_in,omitempty"`
	AdditionalInformation *[]PixAdditionalInformation `json:"additional_information,omitempty"`
}

Contains information to create a pix payment

func (*CreatePixPaymentRequest) MarshalJSON

func (c *CreatePixPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePixPaymentRequest) UnmarshalJSON

func (c *CreatePixPaymentRequest) UnmarshalJSON(input []byte) error

type CreatePlanItemRequest

type CreatePlanItemRequest struct {
	Name          string                     `json:"name"`
	PricingScheme CreatePricingSchemeRequest `json:"pricing_scheme"`
	Id            string                     `json:"id"`
	Description   string                     `json:"description"`
	Cycles        *int                       `json:"cycles,omitempty"`
	Quantity      *int                       `json:"quantity,omitempty"`
}

Request for creating a plan item

func (*CreatePlanItemRequest) MarshalJSON

func (c *CreatePlanItemRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePlanItemRequest) UnmarshalJSON

func (c *CreatePlanItemRequest) UnmarshalJSON(input []byte) error

type CreatePlanRequest

type CreatePlanRequest struct {
	Name                string                     `json:"name"`
	Description         string                     `json:"description"`
	StatementDescriptor string                     `json:"statement_descriptor"`
	Items               []CreatePlanItemRequest    `json:"items"`
	Shippable           bool                       `json:"shippable"`
	PaymentMethods      []string                   `json:"payment_methods"`
	Installments        []int                      `json:"installments"`
	Currency            string                     `json:"currency"`
	Interval            string                     `json:"interval"`
	IntervalCount       int                        `json:"interval_count"`
	BillingDays         []int                      `json:"billing_days"`
	BillingType         string                     `json:"billing_type"`
	PricingScheme       CreatePricingSchemeRequest `json:"pricing_scheme"`
	Metadata            map[string]string          `json:"metadata"`
	MinimumPrice        *int                       `json:"minimum_price,omitempty"`
	Cycles              *int                       `json:"cycles,omitempty"`
	Quantity            *int                       `json:"quantity,omitempty"`
	TrialPeriodDays     *int                       `json:"trial_period_days,omitempty"`
}

Request for creating a plan

func (*CreatePlanRequest) MarshalJSON

func (c *CreatePlanRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePlanRequest) UnmarshalJSON

func (c *CreatePlanRequest) UnmarshalJSON(input []byte) error

type CreatePriceBracketRequest

type CreatePriceBracketRequest struct {
	StartQuantity int  `json:"start_quantity"`
	Price         int  `json:"price"`
	EndQuantity   *int `json:"end_quantity,omitempty"`
	OveragePrice  *int `json:"overage_price,omitempty"`
}

Request for creating a price bracket

func (*CreatePriceBracketRequest) MarshalJSON

func (c *CreatePriceBracketRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePriceBracketRequest) UnmarshalJSON

func (c *CreatePriceBracketRequest) UnmarshalJSON(input []byte) error

type CreatePricingSchemeRequest

type CreatePricingSchemeRequest struct {
	SchemeType    string                       `json:"scheme_type"`
	PriceBrackets *[]CreatePriceBracketRequest `json:"price_brackets,omitempty"`
	Price         *int                         `json:"price,omitempty"`
	MinimumPrice  *int                         `json:"minimum_price,omitempty"`
	Percentage    *float64                     `json:"percentage,omitempty"`
}

Request for creating a pricing scheme

func (*CreatePricingSchemeRequest) MarshalJSON

func (c *CreatePricingSchemeRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePricingSchemeRequest) UnmarshalJSON

func (c *CreatePricingSchemeRequest) UnmarshalJSON(input []byte) error

type CreatePrivateLabelPaymentRequest

type CreatePrivateLabelPaymentRequest struct {
	Installments         *int               `json:"installments,omitempty"`
	StatementDescriptor  *string            `json:"statement_descriptor,omitempty"`
	Card                 *CreateCardRequest `json:"card,omitempty"`
	CardId               *string            `json:"card_id,omitempty"`
	CardToken            *string            `json:"card_token,omitempty"`
	Recurrence           *bool              `json:"recurrence,omitempty"`
	Capture              *bool              `json:"capture,omitempty"`
	ExtendedLimitEnabled *bool              `json:"extended_limit_enabled,omitempty"`
	ExtendedLimitCode    *string            `json:"extended_limit_code,omitempty"`
	RecurrencyCycle      *string            `json:"recurrency_cycle,omitempty"`
}

The settings for creating a private label payment

func (*CreatePrivateLabelPaymentRequest) MarshalJSON

func (c *CreatePrivateLabelPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreatePrivateLabelPaymentRequest) UnmarshalJSON

func (c *CreatePrivateLabelPaymentRequest) UnmarshalJSON(input []byte) error

type CreateRecipientRequest

type CreateRecipientRequest struct {
	Name               string                         `json:"name"`
	Email              string                         `json:"email"`
	Description        string                         `json:"description"`
	Document           string                         `json:"document"`
	Type               string                         `json:"type"`
	DefaultBankAccount CreateBankAccountRequest       `json:"default_bank_account"`
	Metadata           map[string]string              `json:"metadata"`
	TransferSettings   *CreateTransferSettingsRequest `json:"transfer_settings,omitempty"`
	Code               string                         `json:"code"`
	PaymentMode        string                         `json:"payment_mode"`
}

Request for creating a recipient

func (*CreateRecipientRequest) MarshalJSON

func (c *CreateRecipientRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateRecipientRequest) UnmarshalJSON

func (c *CreateRecipientRequest) UnmarshalJSON(input []byte) error

type CreateSetupRequest

type CreateSetupRequest struct {
	Amount      int                  `json:"amount"`
	Description string               `json:"description"`
	Payment     CreatePaymentRequest `json:"payment"`
}

Request for creating a Setup for a subscription. The setup is an order that will be created at the subscription creation.

func (*CreateSetupRequest) MarshalJSON

func (c *CreateSetupRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateSetupRequest) UnmarshalJSON

func (c *CreateSetupRequest) UnmarshalJSON(input []byte) error

type CreateShippingRequest

type CreateShippingRequest struct {
	Amount                int                  `json:"amount"`
	Description           string               `json:"description"`
	RecipientName         string               `json:"recipient_name"`
	RecipientPhone        string               `json:"recipient_phone"`
	AddressId             string               `json:"address_id"`
	Address               CreateAddressRequest `json:"address"`
	MaxDeliveryDate       *time.Time           `json:"max_delivery_date,omitempty"`
	EstimatedDeliveryDate *time.Time           `json:"estimated_delivery_date,omitempty"`
	Type                  string               `json:"type"`
}

Shipping data

func (*CreateShippingRequest) MarshalJSON

func (c *CreateShippingRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateShippingRequest) UnmarshalJSON

func (c *CreateShippingRequest) UnmarshalJSON(input []byte) error

type CreateSplitOptionsRequest

type CreateSplitOptionsRequest struct {
	Liable              *bool `json:"liable,omitempty"`
	ChargeProcessingFee *bool `json:"charge_processing_fee,omitempty"`
	ChargeRemainderFee  *bool `json:"charge_remainder_fee,omitempty"`
}

The Split Options Request

func (*CreateSplitOptionsRequest) MarshalJSON

func (c *CreateSplitOptionsRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateSplitOptionsRequest) UnmarshalJSON

func (c *CreateSplitOptionsRequest) UnmarshalJSON(input []byte) error

type CreateSplitRequest

type CreateSplitRequest struct {
	Type        string                     `json:"type"`
	Amount      int                        `json:"amount"`
	RecipientId string                     `json:"recipient_id"`
	Options     *CreateSplitOptionsRequest `json:"options,omitempty"`
	SplitRuleId *string                    `json:"split_rule_id,omitempty"`
}

Split

func (*CreateSplitRequest) MarshalJSON

func (c *CreateSplitRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateSplitRequest) UnmarshalJSON

func (c *CreateSplitRequest) UnmarshalJSON(input []byte) error

type CreateSubMerchantRequest

type CreateSubMerchantRequest struct {
	PaymentFacilitatorCode string               `json:"payment_facilitator_code"`
	Code                   string               `json:"code"`
	Name                   string               `json:"name"`
	MerchantCategoryCode   string               `json:"merchant_category_code"`
	Document               string               `json:"document"`
	Type                   string               `json:"type"`
	Phone                  CreatePhoneRequest   `json:"phone"`
	Address                CreateAddressRequest `json:"address"`
}

SubMerchant

func (*CreateSubMerchantRequest) MarshalJSON

func (c *CreateSubMerchantRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateSubMerchantRequest) UnmarshalJSON

func (c *CreateSubMerchantRequest) UnmarshalJSON(input []byte) error

type CreateSubscriptionBoletoRequest

type CreateSubscriptionBoletoRequest struct {
	Interest            *CreateInterestRequest `json:"interest,omitempty"`
	Fine                *CreateFineRequest     `json:"fine,omitempty"`
	MaxDaysToPayPastDue types.Optional[int]    `json:"max_days_to_pay_past_due"`
}

Information about fines and interest on the "boleto" used from payment

func (*CreateSubscriptionBoletoRequest) MarshalJSON

func (c *CreateSubscriptionBoletoRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateSubscriptionBoletoRequest) UnmarshalJSON

func (c *CreateSubscriptionBoletoRequest) UnmarshalJSON(input []byte) error

type CreateSubscriptionItemRequest

type CreateSubscriptionItemRequest struct {
	Description   string                     `json:"description"`
	PricingScheme CreatePricingSchemeRequest `json:"pricing_scheme"`
	Id            string                     `json:"id"`
	PlanItemId    string                     `json:"plan_item_id"`
	Discounts     []CreateDiscountRequest    `json:"discounts"`
	Name          string                     `json:"name"`
	Cycles        *int                       `json:"cycles,omitempty"`
	Quantity      *int                       `json:"quantity,omitempty"`
	MinimumPrice  *int                       `json:"minimum_price,omitempty"`
}

Request for creating a new subscription item

func (*CreateSubscriptionItemRequest) MarshalJSON

func (c *CreateSubscriptionItemRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateSubscriptionItemRequest) UnmarshalJSON

func (c *CreateSubscriptionItemRequest) UnmarshalJSON(input []byte) error

type CreateSubscriptionRequest

type CreateSubscriptionRequest struct {
	Customer             CreateCustomerRequest            `json:"customer"`
	Card                 CreateCardRequest                `json:"card"`
	Code                 string                           `json:"code"`
	PaymentMethod        string                           `json:"payment_method"`
	BillingType          string                           `json:"billing_type"`
	StatementDescriptor  string                           `json:"statement_descriptor"`
	Description          string                           `json:"description"`
	Currency             string                           `json:"currency"`
	Interval             string                           `json:"interval"`
	IntervalCount        int                              `json:"interval_count"`
	PricingScheme        CreatePricingSchemeRequest       `json:"pricing_scheme"`
	Items                []CreateSubscriptionItemRequest  `json:"items"`
	Shipping             CreateShippingRequest            `json:"shipping"`
	Discounts            []CreateDiscountRequest          `json:"discounts"`
	Metadata             map[string]string                `json:"metadata"`
	Setup                *CreateSetupRequest              `json:"setup,omitempty"`
	PlanId               *string                          `json:"plan_id,omitempty"`
	CustomerId           *string                          `json:"customer_id,omitempty"`
	CardId               *string                          `json:"card_id,omitempty"`
	BillingDay           *int                             `json:"billing_day,omitempty"`
	Installments         *int                             `json:"installments,omitempty"`
	StartAt              *time.Time                       `json:"start_at,omitempty"`
	MinimumPrice         *int                             `json:"minimum_price,omitempty"`
	Cycles               *int                             `json:"cycles,omitempty"`
	CardToken            *string                          `json:"card_token,omitempty"`
	GatewayAffiliationId *string                          `json:"gateway_affiliation_id,omitempty"`
	Quantity             *int                             `json:"quantity,omitempty"`
	BoletoDueDays        *int                             `json:"boleto_due_days,omitempty"`
	Increments           []CreateIncrementRequest         `json:"increments"`
	Period               *CreatePeriodRequest             `json:"period,omitempty"`
	Submerchant          *CreateSubMerchantRequest        `json:"submerchant,omitempty"`
	Split                *CreateSubscriptionSplitRequest  `json:"split,omitempty"`
	Boleto               *CreateSubscriptionBoletoRequest `json:"boleto,omitempty"`
}

Request for creating a subcription

func (*CreateSubscriptionRequest) MarshalJSON

func (c *CreateSubscriptionRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateSubscriptionRequest) UnmarshalJSON

func (c *CreateSubscriptionRequest) UnmarshalJSON(input []byte) error

type CreateSubscriptionSplitRequest

type CreateSubscriptionSplitRequest struct {
	Enabled bool                 `json:"enabled"`
	Rules   []CreateSplitRequest `json:"rules"`
}

func (*CreateSubscriptionSplitRequest) MarshalJSON

func (c *CreateSubscriptionSplitRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateSubscriptionSplitRequest) UnmarshalJSON

func (c *CreateSubscriptionSplitRequest) UnmarshalJSON(input []byte) error

type CreateThreeDSecureRequest

type CreateThreeDSecureRequest struct {
	Mpi             string  `json:"mpi"`
	Cavv            *string `json:"cavv,omitempty"`
	Eci             *string `json:"eci,omitempty"`
	TransactionId   *string `json:"transaction_id,omitempty"`
	SuccessUrl      *string `json:"success_url,omitempty"`
	DsTransactionId *string `json:"ds_transaction_id,omitempty"`
	Version         *string `json:"version,omitempty"`
}

Creates a 3D-S authentication payment

func (*CreateThreeDSecureRequest) MarshalJSON

func (c *CreateThreeDSecureRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateThreeDSecureRequest) UnmarshalJSON

func (c *CreateThreeDSecureRequest) UnmarshalJSON(input []byte) error

type CreateTokenRequest

type CreateTokenRequest struct {
	Type string                 `json:"type"`
	Card CreateCardTokenRequest `json:"card"`
}

Token data

func (*CreateTokenRequest) MarshalJSON

func (c *CreateTokenRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateTokenRequest) UnmarshalJSON

func (c *CreateTokenRequest) UnmarshalJSON(input []byte) error

type CreateTransactionReportFileRequest

type CreateTransactionReportFileRequest struct {
	Name    string     `json:"name"`
	StartAt *time.Time `json:"start_at,omitempty"`
	EndAt   *string    `json:"end_at,omitempty"`
}

func (*CreateTransactionReportFileRequest) MarshalJSON

func (c *CreateTransactionReportFileRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateTransactionReportFileRequest) UnmarshalJSON

func (c *CreateTransactionReportFileRequest) UnmarshalJSON(input []byte) error

type CreateTransfer

type CreateTransfer struct {
	Amount   int       `json:"amount"`
	SourceId string    `json:"source_id"`
	TargetId string    `json:"target_id"`
	Metadata *[]string `json:"metadata,omitempty"`
}

func (*CreateTransfer) MarshalJSON

func (c *CreateTransfer) MarshalJSON() (
	[]byte,
	error)

func (*CreateTransfer) UnmarshalJSON

func (c *CreateTransfer) UnmarshalJSON(input []byte) error

type CreateTransferRequest

type CreateTransferRequest struct {
	Amount   int               `json:"amount"`
	Metadata map[string]string `json:"metadata"`
}

Request for creating a transfer

func (*CreateTransferRequest) MarshalJSON

func (c *CreateTransferRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateTransferRequest) UnmarshalJSON

func (c *CreateTransferRequest) UnmarshalJSON(input []byte) error

type CreateTransferSettingsRequest

type CreateTransferSettingsRequest struct {
	TransferEnabled  bool   `json:"transfer_enabled"`
	TransferInterval string `json:"transfer_interval"`
	TransferDay      int    `json:"transfer_day"`
}

Informações de transferência do recebedor

func (*CreateTransferSettingsRequest) MarshalJSON

func (c *CreateTransferSettingsRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateTransferSettingsRequest) UnmarshalJSON

func (c *CreateTransferSettingsRequest) UnmarshalJSON(input []byte) error

type CreateUsageRequest

type CreateUsageRequest struct {
	Quantity    int       `json:"quantity"`
	Description string    `json:"description"`
	UsedAt      time.Time `json:"used_at"`
	Code        *string   `json:"code,omitempty"`
	Group       *string   `json:"group,omitempty"`
	Amount      *int      `json:"amount,omitempty"`
}

Request for creating a usage

func (*CreateUsageRequest) MarshalJSON

func (c *CreateUsageRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateUsageRequest) UnmarshalJSON

func (c *CreateUsageRequest) UnmarshalJSON(input []byte) error

type CreateVoucherPaymentRequest

type CreateVoucherPaymentRequest struct {
	StatementDescriptor *string            `json:"statement_descriptor,omitempty"`
	CardId              *string            `json:"card_id,omitempty"`
	CardToken           *string            `json:"card_token,omitempty"`
	Card                *CreateCardRequest `json:"Card,omitempty"`
	RecurrencyCycle     *string            `json:"recurrency_cycle,omitempty"`
}

The settings for creating a voucher payment

func (*CreateVoucherPaymentRequest) MarshalJSON

func (c *CreateVoucherPaymentRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateVoucherPaymentRequest) UnmarshalJSON

func (c *CreateVoucherPaymentRequest) UnmarshalJSON(input []byte) error

type CreateWithdrawRequest

type CreateWithdrawRequest struct {
	Amount   int                `json:"amount"`
	Metadata map[string]*string `json:"metadata,omitempty"`
}

func (*CreateWithdrawRequest) MarshalJSON

func (c *CreateWithdrawRequest) MarshalJSON() (
	[]byte,
	error)

func (*CreateWithdrawRequest) UnmarshalJSON

func (c *CreateWithdrawRequest) UnmarshalJSON(input []byte) error

type GetAccessTokenResponse

type GetAccessTokenResponse struct {
	Id        types.Optional[string]              `json:"id"`
	Code      types.Optional[string]              `json:"code"`
	Status    types.Optional[string]              `json:"status"`
	CreatedAt types.Optional[time.Time]           `json:"created_at"`
	Customer  types.Optional[GetCustomerResponse] `json:"customer"`
}

Response object for getting a access token

func (*GetAccessTokenResponse) MarshalJSON

func (g *GetAccessTokenResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetAccessTokenResponse) UnmarshalJSON

func (g *GetAccessTokenResponse) UnmarshalJSON(input []byte) error

type GetAddressResponse

type GetAddressResponse struct {
	Id           types.Optional[string]              `json:"id"`
	Street       types.Optional[string]              `json:"street"`
	Number       types.Optional[string]              `json:"number"`
	Complement   types.Optional[string]              `json:"complement"`
	ZipCode      types.Optional[string]              `json:"zip_code"`
	Neighborhood types.Optional[string]              `json:"neighborhood"`
	City         types.Optional[string]              `json:"city"`
	State        types.Optional[string]              `json:"state"`
	Country      types.Optional[string]              `json:"country"`
	Status       types.Optional[string]              `json:"status"`
	CreatedAt    types.Optional[time.Time]           `json:"created_at"`
	UpdatedAt    types.Optional[time.Time]           `json:"updated_at"`
	Customer     types.Optional[GetCustomerResponse] `json:"customer"`
	Metadata     types.Optional[map[string]string]   `json:"metadata"`
	Line1        types.Optional[string]              `json:"line_1"`
	Line2        types.Optional[string]              `json:"line_2"`
	DeletedAt    types.Optional[time.Time]           `json:"deleted_at"`
}

Response object for getting an Address

func (*GetAddressResponse) MarshalJSON

func (g *GetAddressResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetAddressResponse) UnmarshalJSON

func (g *GetAddressResponse) UnmarshalJSON(input []byte) error

type GetAnticipationLimitResponse

type GetAnticipationLimitResponse struct {
	Amount          types.Optional[int] `json:"amount"`
	AnticipationFee types.Optional[int] `json:"anticipation_fee"`
}

Anticipation limit

func (*GetAnticipationLimitResponse) MarshalJSON

func (g *GetAnticipationLimitResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetAnticipationLimitResponse) UnmarshalJSON

func (g *GetAnticipationLimitResponse) UnmarshalJSON(input []byte) error

type GetAnticipationLimitsResponse

type GetAnticipationLimitsResponse struct {
	Max types.Optional[GetAnticipationLimitResponse] `json:"max"`
	Min types.Optional[GetAnticipationLimitResponse] `json:"min"`
}

Anticipation limits

func (*GetAnticipationLimitsResponse) MarshalJSON

func (g *GetAnticipationLimitsResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetAnticipationLimitsResponse) UnmarshalJSON

func (g *GetAnticipationLimitsResponse) UnmarshalJSON(input []byte) error

type GetAnticipationResponse

type GetAnticipationResponse struct {
	Id              types.Optional[string]               `json:"id"`
	RequestedAmount types.Optional[int]                  `json:"requested_amount"`
	ApprovedAmount  types.Optional[int]                  `json:"approved_amount"`
	Recipient       types.Optional[GetRecipientResponse] `json:"recipient"`
	Pgid            types.Optional[string]               `json:"pgid"`
	CreatedAt       types.Optional[time.Time]            `json:"created_at"`
	UpdatedAt       types.Optional[time.Time]            `json:"updated_at"`
	PaymentDate     types.Optional[time.Time]            `json:"payment_date"`
	Status          types.Optional[string]               `json:"status"`
	Timeframe       types.Optional[string]               `json:"timeframe"`
}

Anticipation

func (*GetAnticipationResponse) MarshalJSON

func (g *GetAnticipationResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetAnticipationResponse) UnmarshalJSON

func (g *GetAnticipationResponse) UnmarshalJSON(input []byte) error

type GetAntifraudResponse

type GetAntifraudResponse struct {
	Status        types.Optional[string] `json:"status"`
	ReturnCode    types.Optional[string] `json:"return_code"`
	ReturnMessage types.Optional[string] `json:"return_message"`
	ProviderName  types.Optional[string] `json:"provider_name"`
	Score         types.Optional[string] `json:"score"`
}

func (*GetAntifraudResponse) MarshalJSON

func (g *GetAntifraudResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetAntifraudResponse) UnmarshalJSON

func (g *GetAntifraudResponse) UnmarshalJSON(input []byte) error

type GetAutomaticAnticipationResponse

type GetAutomaticAnticipationResponse struct {
	Enabled          types.Optional[bool]   `json:"enabled"`
	Type             types.Optional[string] `json:"type"`
	VolumePercentage types.Optional[int]    `json:"volume_percentage"`
	Delay            types.Optional[int]    `json:"delay"`
	Days             types.Optional[[]int]  `json:"days"`
}

func (*GetAutomaticAnticipationResponse) MarshalJSON

func (g *GetAutomaticAnticipationResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetAutomaticAnticipationResponse) UnmarshalJSON

func (g *GetAutomaticAnticipationResponse) UnmarshalJSON(input []byte) error

type GetBalanceOperationResponse

type GetBalanceOperationResponse struct {
	Id               types.Optional[string]                  `json:"id"`
	Status           types.Optional[string]                  `json:"status"`
	BalanceAmount    types.Optional[string]                  `json:"balance_amount"`
	BalanceOldAmount types.Optional[string]                  `json:"balance_old_amount"`
	Type             types.Optional[string]                  `json:"type"`
	Amount           types.Optional[string]                  `json:"amount"`
	Fee              types.Optional[string]                  `json:"fee"`
	CreatedAt        types.Optional[string]                  `json:"created_at"`
	MovementObject   *GetMovementObjectBaseResponseInterface `json:"movement_object,omitempty"`
}

Generic response object for getting a BalanceOperation.

func (*GetBalanceOperationResponse) MarshalJSON

func (g *GetBalanceOperationResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetBalanceOperationResponse) UnmarshalJSON

func (g *GetBalanceOperationResponse) UnmarshalJSON(input []byte) error

type GetBalanceOperationResponseInterface

type GetBalanceOperationResponseInterface interface {
	GetId() types.Optional[string]
	GetStatus() types.Optional[string]
	GetBalanceAmount() types.Optional[string]
	GetBalanceOldAmount() types.Optional[string]
	GetType() types.Optional[string]
	GetAmount() types.Optional[string]
	GetFee() types.Optional[string]
	GetCreatedAt() types.Optional[string]
	GetMovementObject() *GetMovementObjectBaseResponseInterface
}

Generic response object for getting a BalanceOperation.

type GetBalanceResponse

type GetBalanceResponse struct {
	Currency           types.Optional[string]               `json:"currency"`
	AvailableAmount    types.Optional[int64]                `json:"available_amount"`
	Recipient          types.Optional[GetRecipientResponse] `json:"recipient"`
	TransferredAmount  types.Optional[int64]                `json:"transferred_amount"`
	WaitingFundsAmount types.Optional[int64]                `json:"waiting_funds_amount"`
}

Balance

func (*GetBalanceResponse) MarshalJSON

func (g *GetBalanceResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetBalanceResponse) UnmarshalJSON

func (g *GetBalanceResponse) UnmarshalJSON(input []byte) error

type GetBankAccountResponse

type GetBankAccountResponse struct {
	Id                types.Optional[string]               `json:"id"`
	HolderName        types.Optional[string]               `json:"holder_name"`
	HolderType        types.Optional[string]               `json:"holder_type"`
	Bank              types.Optional[string]               `json:"bank"`
	BranchNumber      types.Optional[string]               `json:"branch_number"`
	BranchCheckDigit  types.Optional[string]               `json:"branch_check_digit"`
	AccountNumber     types.Optional[string]               `json:"account_number"`
	AccountCheckDigit types.Optional[string]               `json:"account_check_digit"`
	Type              types.Optional[string]               `json:"type"`
	Status            types.Optional[string]               `json:"status"`
	CreatedAt         types.Optional[time.Time]            `json:"created_at"`
	UpdatedAt         types.Optional[time.Time]            `json:"updated_at"`
	DeletedAt         types.Optional[time.Time]            `json:"deleted_at"`
	Recipient         types.Optional[GetRecipientResponse] `json:"recipient"`
	Metadata          types.Optional[map[string]string]    `json:"metadata"`
	PixKey            types.Optional[string]               `json:"pix_key"`
}

func (*GetBankAccountResponse) MarshalJSON

func (g *GetBankAccountResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetBankAccountResponse) UnmarshalJSON

func (g *GetBankAccountResponse) UnmarshalJSON(input []byte) error

type GetBankTransferTransactionResponse

type GetBankTransferTransactionResponse struct {
	GetTransactionResponse
	Url        *string    `json:"url,omitempty"`
	BankTid    *string    `json:"bank_tid,omitempty"`
	Bank       *string    `json:"bank,omitempty"`
	PaidAt     *time.Time `json:"paid_at,omitempty"`
	PaidAmount *int       `json:"paid_amount,omitempty"`
}

Response object for getting a bank transfer transaction

func (*GetBankTransferTransactionResponse) GetBank

Getter for bank.

func (*GetBankTransferTransactionResponse) GetBankTid

func (g *GetBankTransferTransactionResponse) GetBankTid() *string

Getter for bank_tid.

func (*GetBankTransferTransactionResponse) GetPaidAmount

func (g *GetBankTransferTransactionResponse) GetPaidAmount() *int

Getter for paid_amount.

func (*GetBankTransferTransactionResponse) GetPaidAt

Getter for paid_at.

func (*GetBankTransferTransactionResponse) GetUrl

Getter for url.

func (*GetBankTransferTransactionResponse) MarshalJSON

func (g *GetBankTransferTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetBankTransferTransactionResponse) UnmarshalJSON

func (g *GetBankTransferTransactionResponse) UnmarshalJSON(input []byte) error

type GetBankTransferTransactionResponseField

type GetBankTransferTransactionResponseField struct {
	GetBankTransferTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetBankTransferTransactionResponseField) UnmarshalJSON

func (g *GetBankTransferTransactionResponseField) UnmarshalJSON(input []byte) error

type GetBankTransferTransactionResponseInterface

type GetBankTransferTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetUrl() *string
	GetBankTid() *string
	GetBank() *string
	GetPaidAt() *time.Time
	GetPaidAmount() *int
}

Response object for getting a bank transfer transaction

func ToGetBankTransferTransactionResponseArray

func ToGetBankTransferTransactionResponseArray(getBankTransferTransactionResponse []GetBankTransferTransactionResponseField) []GetBankTransferTransactionResponseInterface

func UnmarshalGetBankTransferTransactionResponse

func UnmarshalGetBankTransferTransactionResponse(input []byte) (
	GetBankTransferTransactionResponseInterface,
	error)

type GetBankTransferTransactionResponseSlice

type GetBankTransferTransactionResponseSlice struct {
	Slice []GetBankTransferTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetBankTransferTransactionResponseSlice) UnmarshalJSON

func (ga *GetBankTransferTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetBillingAddressResponse

type GetBillingAddressResponse struct {
	Street       types.Optional[string] `json:"street"`
	Number       types.Optional[string] `json:"number"`
	ZipCode      types.Optional[string] `json:"zip_code"`
	Neighborhood types.Optional[string] `json:"neighborhood"`
	City         types.Optional[string] `json:"city"`
	State        types.Optional[string] `json:"state"`
	Country      types.Optional[string] `json:"country"`
	Complement   types.Optional[string] `json:"complement"`
	Line1        types.Optional[string] `json:"line_1"`
	Line2        types.Optional[string] `json:"line_2"`
}

Response object for getting a billing address

func (*GetBillingAddressResponse) MarshalJSON

func (g *GetBillingAddressResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetBillingAddressResponse) UnmarshalJSON

func (g *GetBillingAddressResponse) UnmarshalJSON(input []byte) error

type GetBinResponse

type GetBinResponse struct {
	Brand     types.Optional[string] `json:"brand"`
	BrandName types.Optional[string] `json:"brandName"`
	Gaps      types.Optional[[]int]  `json:"gaps"`
	Lenghts   types.Optional[[]int]  `json:"lenghts"`
	Mask      types.Optional[string] `json:"mask"`
	Input     types.Optional[string] `json:"input"`
	Cvv       types.Optional[int]    `json:"cvv"`
}

Response object for getting a bin info

func (*GetBinResponse) MarshalJSON

func (g *GetBinResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetBinResponse) UnmarshalJSON

func (g *GetBinResponse) UnmarshalJSON(input []byte) error

type GetBoletoTransactionResponse

type GetBoletoTransactionResponse struct {
	GetTransactionResponse
	Url                 types.Optional[string]                    `json:"url"`
	Barcode             types.Optional[string]                    `json:"barcode"`
	NossoNumero         types.Optional[string]                    `json:"nosso_numero"`
	Bank                types.Optional[string]                    `json:"bank"`
	DocumentNumber      types.Optional[string]                    `json:"document_number"`
	Instructions        types.Optional[string]                    `json:"instructions"`
	BillingAddress      types.Optional[GetBillingAddressResponse] `json:"billing_address"`
	DueAt               types.Optional[time.Time]                 `json:"due_at"`
	QrCode              types.Optional[string]                    `json:"qr_code"`
	Line                types.Optional[string]                    `json:"line"`
	PdfPassword         types.Optional[string]                    `json:"pdf_password"`
	Pdf                 types.Optional[string]                    `json:"pdf"`
	PaidAt              types.Optional[time.Time]                 `json:"paid_at"`
	PaidAmount          types.Optional[string]                    `json:"paid_amount"`
	Type                types.Optional[string]                    `json:"type"`
	CreditAt            types.Optional[time.Time]                 `json:"credit_at"`
	StatementDescriptor types.Optional[string]                    `json:"statement_descriptor"`
}

Response object for getting a boleto transaction

func (*GetBoletoTransactionResponse) GetBank

Getter for bank.

func (*GetBoletoTransactionResponse) GetBarcode

Getter for barcode.

func (*GetBoletoTransactionResponse) GetBillingAddress

Getter for billing_address.

func (*GetBoletoTransactionResponse) GetCreditAt

Getter for credit_at.

func (*GetBoletoTransactionResponse) GetDocumentNumber

func (g *GetBoletoTransactionResponse) GetDocumentNumber() types.Optional[string]

Getter for document_number.

func (*GetBoletoTransactionResponse) GetDueAt

Getter for due_at.

func (*GetBoletoTransactionResponse) GetInstructions

func (g *GetBoletoTransactionResponse) GetInstructions() types.Optional[string]

Getter for instructions.

func (*GetBoletoTransactionResponse) GetLine

Getter for line.

func (*GetBoletoTransactionResponse) GetNossoNumero

func (g *GetBoletoTransactionResponse) GetNossoNumero() types.Optional[string]

Getter for nosso_numero.

func (*GetBoletoTransactionResponse) GetPaidAmount

func (g *GetBoletoTransactionResponse) GetPaidAmount() types.Optional[string]

Getter for paid_amount.

func (*GetBoletoTransactionResponse) GetPaidAt

Getter for paid_at.

func (*GetBoletoTransactionResponse) GetPdf

Getter for pdf.

func (*GetBoletoTransactionResponse) GetPdfPassword

func (g *GetBoletoTransactionResponse) GetPdfPassword() types.Optional[string]

Getter for pdf_password.

func (*GetBoletoTransactionResponse) GetQrCode

Getter for qr_code.

func (*GetBoletoTransactionResponse) GetStatementDescriptor

func (g *GetBoletoTransactionResponse) GetStatementDescriptor() types.Optional[string]

Getter for statement_descriptor.

func (*GetBoletoTransactionResponse) GetType

Getter for type.

func (*GetBoletoTransactionResponse) GetUrl

Getter for url.

func (*GetBoletoTransactionResponse) MarshalJSON

func (g *GetBoletoTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetBoletoTransactionResponse) UnmarshalJSON

func (g *GetBoletoTransactionResponse) UnmarshalJSON(input []byte) error

type GetBoletoTransactionResponseField

type GetBoletoTransactionResponseField struct {
	GetBoletoTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetBoletoTransactionResponseField) UnmarshalJSON

func (g *GetBoletoTransactionResponseField) UnmarshalJSON(input []byte) error

type GetBoletoTransactionResponseInterface

type GetBoletoTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetUrl() types.Optional[string]
	GetBarcode() types.Optional[string]
	GetNossoNumero() types.Optional[string]
	GetBank() types.Optional[string]
	GetDocumentNumber() types.Optional[string]
	GetInstructions() types.Optional[string]
	GetBillingAddress() types.Optional[GetBillingAddressResponse]
	GetDueAt() types.Optional[time.Time]
	GetQrCode() types.Optional[string]
	GetLine() types.Optional[string]
	GetPdfPassword() types.Optional[string]
	GetPdf() types.Optional[string]
	GetPaidAt() types.Optional[time.Time]
	GetPaidAmount() types.Optional[string]
	GetType() types.Optional[string]
	GetCreditAt() types.Optional[time.Time]
	GetStatementDescriptor() types.Optional[string]
}

Response object for getting a boleto transaction

func ToGetBoletoTransactionResponseArray

func ToGetBoletoTransactionResponseArray(getBoletoTransactionResponse []GetBoletoTransactionResponseField) []GetBoletoTransactionResponseInterface

func UnmarshalGetBoletoTransactionResponse

func UnmarshalGetBoletoTransactionResponse(input []byte) (
	GetBoletoTransactionResponseInterface,
	error)

type GetBoletoTransactionResponseSlice

type GetBoletoTransactionResponseSlice struct {
	Slice []GetBoletoTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetBoletoTransactionResponseSlice) UnmarshalJSON

func (ga *GetBoletoTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetCardResponse

type GetCardResponse struct {
	Id             types.Optional[string]                    `json:"id"`
	LastFourDigits types.Optional[string]                    `json:"last_four_digits"`
	Brand          types.Optional[string]                    `json:"brand"`
	HolderName     types.Optional[string]                    `json:"holder_name"`
	ExpMonth       types.Optional[int]                       `json:"exp_month"`
	ExpYear        types.Optional[int]                       `json:"exp_year"`
	Status         types.Optional[string]                    `json:"status"`
	CreatedAt      types.Optional[time.Time]                 `json:"created_at"`
	UpdatedAt      types.Optional[time.Time]                 `json:"updated_at"`
	BillingAddress types.Optional[GetBillingAddressResponse] `json:"billing_address"`
	Customer       types.Optional[GetCustomerResponse]       `json:"customer"`
	Metadata       types.Optional[map[string]string]         `json:"metadata"`
	Type           types.Optional[string]                    `json:"type"`
	HolderDocument types.Optional[string]                    `json:"holder_document"`
	DeletedAt      types.Optional[time.Time]                 `json:"deleted_at"`
	FirstSixDigits types.Optional[string]                    `json:"first_six_digits"`
	Label          types.Optional[string]                    `json:"label"`
}

Response object for getting a credit card

func (*GetCardResponse) MarshalJSON

func (g *GetCardResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCardResponse) UnmarshalJSON

func (g *GetCardResponse) UnmarshalJSON(input []byte) error

type GetCardTokenResponse

type GetCardTokenResponse struct {
	LastFourDigits types.Optional[string] `json:"last_four_digits"`
	HolderName     types.Optional[string] `json:"holder_name"`
	HolderDocument types.Optional[string] `json:"holder_document"`
	ExpMonth       types.Optional[int]    `json:"exp_month"`
	ExpYear        types.Optional[int]    `json:"exp_year"`
	Brand          types.Optional[string] `json:"brand"`
	Type           types.Optional[string] `json:"type"`
	Label          types.Optional[string] `json:"label"`
}

Card token data

func (*GetCardTokenResponse) MarshalJSON

func (g *GetCardTokenResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCardTokenResponse) UnmarshalJSON

func (g *GetCardTokenResponse) UnmarshalJSON(input []byte) error

type GetCashTransactionResponse

type GetCashTransactionResponse struct {
	GetTransactionResponse
	Description types.Optional[string] `json:"description"`
}

Response object for getting a cash transaction

func (*GetCashTransactionResponse) GetDescription

func (g *GetCashTransactionResponse) GetDescription() types.Optional[string]

Getter for description.

func (*GetCashTransactionResponse) MarshalJSON

func (g *GetCashTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCashTransactionResponse) UnmarshalJSON

func (g *GetCashTransactionResponse) UnmarshalJSON(input []byte) error

type GetCashTransactionResponseField

type GetCashTransactionResponseField struct {
	GetCashTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetCashTransactionResponseField) UnmarshalJSON

func (g *GetCashTransactionResponseField) UnmarshalJSON(input []byte) error

type GetCashTransactionResponseInterface

type GetCashTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetDescription() types.Optional[string]
}

Response object for getting a cash transaction

func ToGetCashTransactionResponseArray

func ToGetCashTransactionResponseArray(getCashTransactionResponse []GetCashTransactionResponseField) []GetCashTransactionResponseInterface

func UnmarshalGetCashTransactionResponse

func UnmarshalGetCashTransactionResponse(input []byte) (
	GetCashTransactionResponseInterface,
	error)

type GetCashTransactionResponseSlice

type GetCashTransactionResponseSlice struct {
	Slice []GetCashTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetCashTransactionResponseSlice) UnmarshalJSON

func (ga *GetCashTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetChargeResponse

type GetChargeResponse struct {
	Id                  types.Optional[string]                      `json:"id"`
	Code                types.Optional[string]                      `json:"code"`
	GatewayId           types.Optional[string]                      `json:"gateway_id"`
	Amount              types.Optional[int]                         `json:"amount"`
	Status              types.Optional[string]                      `json:"status"`
	Currency            types.Optional[string]                      `json:"currency"`
	PaymentMethod       types.Optional[string]                      `json:"payment_method"`
	DueAt               types.Optional[time.Time]                   `json:"due_at"`
	CreatedAt           types.Optional[time.Time]                   `json:"created_at"`
	UpdatedAt           types.Optional[time.Time]                   `json:"updated_at"`
	LastTransaction     types.Optional[GetTransactionResponseField] `json:"last_transaction"`
	Invoice             types.Optional[GetInvoiceResponse]          `json:"invoice"`
	Order               types.Optional[GetOrderResponse]            `json:"order"`
	Customer            types.Optional[GetCustomerResponse]         `json:"customer"`
	Metadata            types.Optional[map[string]string]           `json:"metadata"`
	PaidAt              types.Optional[time.Time]                   `json:"paid_at"`
	CanceledAt          types.Optional[time.Time]                   `json:"canceled_at"`
	CanceledAmount      types.Optional[int]                         `json:"canceled_amount"`
	PaidAmount          types.Optional[int]                         `json:"paid_amount"`
	InterestAndFinePaid types.Optional[int]                         `json:"interest_and_fine_paid"`
	RecurrencyCycle     types.Optional[string]                      `json:"recurrency_cycle"`
}

Response object for getting a charge

func (*GetChargeResponse) MarshalJSON

func (g *GetChargeResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetChargeResponse) UnmarshalJSON

func (g *GetChargeResponse) UnmarshalJSON(input []byte) error

type GetChargeResponseInterface

type GetChargeResponseInterface interface {
	GetId() types.Optional[string]
	GetCode() types.Optional[string]
	GetGatewayId() types.Optional[string]
	GetAmount() types.Optional[int]
	GetStatus() types.Optional[string]
	GetCurrency() types.Optional[string]
	GetPaymentMethod() types.Optional[string]
	GetDueAt() types.Optional[time.Time]
	GetCreatedAt() types.Optional[time.Time]
	GetUpdatedAt() types.Optional[time.Time]
	GetLastTransaction() types.Optional[GetTransactionResponseInterface]
	GetInvoice() types.Optional[GetInvoiceResponse]
	GetOrder() types.Optional[GetOrderResponse]
	GetCustomer() types.Optional[GetCustomerResponse]
	GetMetadata() types.Optional[map[string]string]
	GetPaidAt() types.Optional[time.Time]
	GetCanceledAt() types.Optional[time.Time]
	GetCanceledAmount() types.Optional[int]
	GetPaidAmount() types.Optional[int]
	GetInterestAndFinePaid() types.Optional[int]
	GetRecurrencyCycle() types.Optional[string]
}

Response object for getting a charge

type GetChargesSummaryResponse

type GetChargesSummaryResponse struct {
	Total types.Optional[int] `json:"total"`
}

func (*GetChargesSummaryResponse) MarshalJSON

func (g *GetChargesSummaryResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetChargesSummaryResponse) UnmarshalJSON

func (g *GetChargesSummaryResponse) UnmarshalJSON(input []byte) error

type GetCheckoutBankTransferPaymentResponse

type GetCheckoutBankTransferPaymentResponse struct {
	Bank types.Optional[[]string] `json:"bank"`
}

Bank transfer checkout response

func (*GetCheckoutBankTransferPaymentResponse) MarshalJSON

func (g *GetCheckoutBankTransferPaymentResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCheckoutBankTransferPaymentResponse) UnmarshalJSON

func (g *GetCheckoutBankTransferPaymentResponse) UnmarshalJSON(input []byte) error

type GetCheckoutBoletoPaymentResponse

type GetCheckoutBoletoPaymentResponse struct {
	DueAt        types.Optional[time.Time] `json:"due_at"`
	Instructions types.Optional[string]    `json:"instructions"`
}

func (*GetCheckoutBoletoPaymentResponse) MarshalJSON

func (g *GetCheckoutBoletoPaymentResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCheckoutBoletoPaymentResponse) UnmarshalJSON

func (g *GetCheckoutBoletoPaymentResponse) UnmarshalJSON(input []byte) error

type GetCheckoutCardInstallmentOptionsResponse

type GetCheckoutCardInstallmentOptionsResponse struct {
	Number *string `json:"number"`
	Total  *int    `json:"total"`
}

func (*GetCheckoutCardInstallmentOptionsResponse) MarshalJSON

func (g *GetCheckoutCardInstallmentOptionsResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCheckoutCardInstallmentOptionsResponse) UnmarshalJSON

func (g *GetCheckoutCardInstallmentOptionsResponse) UnmarshalJSON(input []byte) error

type GetCheckoutCreditCardPaymentResponse

type GetCheckoutCreditCardPaymentResponse struct {
	StatementDescriptor types.Optional[string]                                      `json:"statementDescriptor"`
	Installments        types.Optional[[]GetCheckoutCardInstallmentOptionsResponse] `json:"installments"`
	Authentication      types.Optional[GetPaymentAuthenticationResponse]            `json:"authentication"`
}

func (*GetCheckoutCreditCardPaymentResponse) MarshalJSON

func (g *GetCheckoutCreditCardPaymentResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCheckoutCreditCardPaymentResponse) UnmarshalJSON

func (g *GetCheckoutCreditCardPaymentResponse) UnmarshalJSON(input []byte) error

type GetCheckoutDebitCardPaymentResponse

type GetCheckoutDebitCardPaymentResponse struct {
	StatementDescriptor types.Optional[string]                           `json:"statement_descriptor"`
	Authentication      types.Optional[GetPaymentAuthenticationResponse] `json:"authentication"`
}

func (*GetCheckoutDebitCardPaymentResponse) MarshalJSON

func (g *GetCheckoutDebitCardPaymentResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCheckoutDebitCardPaymentResponse) UnmarshalJSON

func (g *GetCheckoutDebitCardPaymentResponse) UnmarshalJSON(input []byte) error

type GetCheckoutPaymentResponse

type GetCheckoutPaymentResponse struct {
	Id                      types.Optional[string]                                 `json:"id"`
	Amount                  types.Optional[int]                                    `json:"amount"`
	DefaultPaymentMethod    types.Optional[string]                                 `json:"default_payment_method"`
	SuccessUrl              types.Optional[string]                                 `json:"success_url"`
	PaymentUrl              types.Optional[string]                                 `json:"payment_url"`
	GatewayAffiliationId    types.Optional[string]                                 `json:"gateway_affiliation_id"`
	AcceptedPaymentMethods  types.Optional[[]string]                               `json:"accepted_payment_methods"`
	Status                  types.Optional[string]                                 `json:"status"`
	SkipCheckoutSuccessPage types.Optional[bool]                                   `json:"skip_checkout_success_page"`
	CreatedAt               types.Optional[time.Time]                              `json:"created_at"`
	UpdatedAt               types.Optional[time.Time]                              `json:"updated_at"`
	CanceledAt              types.Optional[time.Time]                              `json:"canceled_at"`
	CustomerEditable        types.Optional[bool]                                   `json:"customer_editable"`
	Customer                types.Optional[GetCustomerResponse]                    `json:"customer"`
	Billingaddress          types.Optional[GetAddressResponse]                     `json:"billingaddress"`
	CreditCard              types.Optional[GetCheckoutCreditCardPaymentResponse]   `json:"credit_card"`
	Boleto                  types.Optional[GetCheckoutBoletoPaymentResponse]       `json:"boleto"`
	BillingAddressEditable  types.Optional[bool]                                   `json:"billing_address_editable"`
	Shipping                types.Optional[GetShippingResponse]                    `json:"shipping"`
	Shippable               types.Optional[bool]                                   `json:"shippable"`
	ClosedAt                types.Optional[time.Time]                              `json:"closed_at"`
	ExpiresAt               types.Optional[time.Time]                              `json:"expires_at"`
	Currency                types.Optional[string]                                 `json:"currency"`
	DebitCard               types.Optional[GetCheckoutDebitCardPaymentResponse]    `json:"debit_card"`
	BankTransfer            types.Optional[GetCheckoutBankTransferPaymentResponse] `json:"bank_transfer"`
	AcceptedBrands          types.Optional[[]string]                               `json:"accepted_brands"`
	Pix                     types.Optional[GetCheckoutPixPaymentResponse]          `json:"pix"`
}

Resposta das configurações de pagamento do checkout

func (*GetCheckoutPaymentResponse) MarshalJSON

func (g *GetCheckoutPaymentResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCheckoutPaymentResponse) UnmarshalJSON

func (g *GetCheckoutPaymentResponse) UnmarshalJSON(input []byte) error

type GetCheckoutPaymentSettingsResponse

type GetCheckoutPaymentSettingsResponse struct {
	SuccessUrl             types.Optional[string]              `json:"success_url"`
	PaymentUrl             types.Optional[string]              `json:"payment_url"`
	AcceptedPaymentMethods types.Optional[[]string]            `json:"accepted_payment_methods"`
	Status                 types.Optional[string]              `json:"status"`
	Customer               types.Optional[GetCustomerResponse] `json:"customer"`
	Amount                 types.Optional[int]                 `json:"amount"`
	DefaultPaymentMethod   types.Optional[string]              `json:"default_payment_method"`
	GatewayAffiliationId   types.Optional[string]              `json:"gateway_affiliation_id"`
}

Checkout Payment Settings Response

func (*GetCheckoutPaymentSettingsResponse) MarshalJSON

func (g *GetCheckoutPaymentSettingsResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCheckoutPaymentSettingsResponse) UnmarshalJSON

func (g *GetCheckoutPaymentSettingsResponse) UnmarshalJSON(input []byte) error

type GetCheckoutPixPaymentResponse

type GetCheckoutPixPaymentResponse struct {
	ExpiresAt             types.Optional[time.Time]                  `json:"expires_at"`
	AdditionalInformation types.Optional[[]PixAdditionalInformation] `json:"additional_information"`
}

Checkout pix payment response

func (*GetCheckoutPixPaymentResponse) MarshalJSON

func (g *GetCheckoutPixPaymentResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCheckoutPixPaymentResponse) UnmarshalJSON

func (g *GetCheckoutPixPaymentResponse) UnmarshalJSON(input []byte) error

type GetCreditCardTransactionResponse

type GetCreditCardTransactionResponse struct {
	GetTransactionResponse
	StatementDescriptor     types.Optional[string]          `json:"statement_descriptor"`
	AcquirerName            *string                         `json:"acquirer_name,omitempty"`
	AcquirerAffiliationCode types.Optional[string]          `json:"acquirer_affiliation_code"`
	AcquirerTid             *string                         `json:"acquirer_tid,omitempty"`
	AcquirerNsu             *string                         `json:"acquirer_nsu,omitempty"`
	AcquirerAuthCode        types.Optional[string]          `json:"acquirer_auth_code"`
	OperationType           types.Optional[string]          `json:"operation_type"`
	Card                    types.Optional[GetCardResponse] `json:"card"`
	AcquirerMessage         types.Optional[string]          `json:"acquirer_message"`
	AcquirerReturnCode      types.Optional[string]          `json:"acquirer_return_code"`
	Installments            types.Optional[int]             `json:"installments"`
	ThreedAuthenticationUrl types.Optional[string]          `json:"threed_authentication_url"`
	FundingSource           types.Optional[string]          `json:"funding_source"`
}

Response object for getting a credit card transaction

func (*GetCreditCardTransactionResponse) GetAcquirerAffiliationCode

func (g *GetCreditCardTransactionResponse) GetAcquirerAffiliationCode() types.Optional[string]

Getter for acquirer_affiliation_code.

func (*GetCreditCardTransactionResponse) GetAcquirerAuthCode

func (g *GetCreditCardTransactionResponse) GetAcquirerAuthCode() types.Optional[string]

Getter for acquirer_auth_code.

func (*GetCreditCardTransactionResponse) GetAcquirerMessage

func (g *GetCreditCardTransactionResponse) GetAcquirerMessage() types.Optional[string]

Getter for acquirer_message.

func (*GetCreditCardTransactionResponse) GetAcquirerName

func (g *GetCreditCardTransactionResponse) GetAcquirerName() *string

Getter for acquirer_name.

func (*GetCreditCardTransactionResponse) GetAcquirerNsu

func (g *GetCreditCardTransactionResponse) GetAcquirerNsu() *string

Getter for acquirer_nsu.

func (*GetCreditCardTransactionResponse) GetAcquirerReturnCode

func (g *GetCreditCardTransactionResponse) GetAcquirerReturnCode() types.Optional[string]

Getter for acquirer_return_code.

func (*GetCreditCardTransactionResponse) GetAcquirerTid

func (g *GetCreditCardTransactionResponse) GetAcquirerTid() *string

Getter for acquirer_tid.

func (*GetCreditCardTransactionResponse) GetCard

Getter for card.

func (*GetCreditCardTransactionResponse) GetFundingSource

func (g *GetCreditCardTransactionResponse) GetFundingSource() types.Optional[string]

Getter for funding_source.

func (*GetCreditCardTransactionResponse) GetInstallments

func (g *GetCreditCardTransactionResponse) GetInstallments() types.Optional[int]

Getter for installments.

func (*GetCreditCardTransactionResponse) GetOperationType

func (g *GetCreditCardTransactionResponse) GetOperationType() types.Optional[string]

Getter for operation_type.

func (*GetCreditCardTransactionResponse) GetStatementDescriptor

func (g *GetCreditCardTransactionResponse) GetStatementDescriptor() types.Optional[string]

Getter for statement_descriptor.

func (*GetCreditCardTransactionResponse) GetThreedAuthenticationUrl

func (g *GetCreditCardTransactionResponse) GetThreedAuthenticationUrl() types.Optional[string]

Getter for threed_authentication_url.

func (*GetCreditCardTransactionResponse) MarshalJSON

func (g *GetCreditCardTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCreditCardTransactionResponse) UnmarshalJSON

func (g *GetCreditCardTransactionResponse) UnmarshalJSON(input []byte) error

type GetCreditCardTransactionResponseField

type GetCreditCardTransactionResponseField struct {
	GetCreditCardTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetCreditCardTransactionResponseField) UnmarshalJSON

func (g *GetCreditCardTransactionResponseField) UnmarshalJSON(input []byte) error

type GetCreditCardTransactionResponseInterface

type GetCreditCardTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetStatementDescriptor() types.Optional[string]
	GetAcquirerName() *string
	GetAcquirerAffiliationCode() types.Optional[string]
	GetAcquirerTid() *string
	GetAcquirerNsu() *string
	GetAcquirerAuthCode() types.Optional[string]
	GetOperationType() types.Optional[string]
	GetCard() types.Optional[GetCardResponse]
	GetAcquirerMessage() types.Optional[string]
	GetAcquirerReturnCode() types.Optional[string]
	GetInstallments() types.Optional[int]
	GetThreedAuthenticationUrl() types.Optional[string]
	GetFundingSource() types.Optional[string]
}

Response object for getting a credit card transaction

func ToGetCreditCardTransactionResponseArray

func ToGetCreditCardTransactionResponseArray(getCreditCardTransactionResponse []GetCreditCardTransactionResponseField) []GetCreditCardTransactionResponseInterface

func UnmarshalGetCreditCardTransactionResponse

func UnmarshalGetCreditCardTransactionResponse(input []byte) (
	GetCreditCardTransactionResponseInterface,
	error)

type GetCreditCardTransactionResponseSlice

type GetCreditCardTransactionResponseSlice struct {
	Slice []GetCreditCardTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetCreditCardTransactionResponseSlice) UnmarshalJSON

func (ga *GetCreditCardTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetCustomerResponse

type GetCustomerResponse struct {
	Id            types.Optional[string]             `json:"id"`
	Name          types.Optional[string]             `json:"name"`
	Email         types.Optional[string]             `json:"email"`
	Delinquent    types.Optional[bool]               `json:"delinquent"`
	CreatedAt     types.Optional[time.Time]          `json:"created_at"`
	UpdatedAt     types.Optional[time.Time]          `json:"updated_at"`
	Document      types.Optional[string]             `json:"document"`
	Type          types.Optional[string]             `json:"type"`
	FbAccessToken types.Optional[string]             `json:"fb_access_token"`
	Address       types.Optional[GetAddressResponse] `json:"address"`
	Metadata      types.Optional[map[string]string]  `json:"metadata"`
	Phones        types.Optional[GetPhonesResponse]  `json:"phones"`
	FbId          types.Optional[int64]              `json:"fb_id"`
	Code          types.Optional[string]             `json:"code"`
	DocumentType  types.Optional[string]             `json:"document_type"`
}

Response object for getting a customer

func (*GetCustomerResponse) MarshalJSON

func (g *GetCustomerResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetCustomerResponse) UnmarshalJSON

func (g *GetCustomerResponse) UnmarshalJSON(input []byte) error

type GetDebitCardTransactionResponse

type GetDebitCardTransactionResponse struct {
	GetTransactionResponse
	StatementDescriptor     types.Optional[string]          `json:"statement_descriptor"`
	AcquirerName            types.Optional[string]          `json:"acquirer_name"`
	AcquirerAffiliationCode types.Optional[string]          `json:"acquirer_affiliation_code"`
	AcquirerTid             types.Optional[string]          `json:"acquirer_tid"`
	AcquirerNsu             types.Optional[string]          `json:"acquirer_nsu"`
	AcquirerAuthCode        types.Optional[string]          `json:"acquirer_auth_code"`
	OperationType           types.Optional[string]          `json:"operation_type"`
	Card                    types.Optional[GetCardResponse] `json:"card"`
	AcquirerMessage         types.Optional[string]          `json:"acquirer_message"`
	AcquirerReturnCode      types.Optional[string]          `json:"acquirer_return_code"`
	Mpi                     types.Optional[string]          `json:"mpi"`
	Eci                     types.Optional[string]          `json:"eci"`
	AuthenticationType      types.Optional[string]          `json:"authentication_type"`
	ThreedAuthenticationUrl types.Optional[string]          `json:"threed_authentication_url"`
	FundingSource           types.Optional[string]          `json:"funding_source"`
}

Response object for getting a debit card transaction

func (*GetDebitCardTransactionResponse) GetAcquirerAffiliationCode

func (g *GetDebitCardTransactionResponse) GetAcquirerAffiliationCode() types.Optional[string]

Getter for acquirer_affiliation_code.

func (*GetDebitCardTransactionResponse) GetAcquirerAuthCode

func (g *GetDebitCardTransactionResponse) GetAcquirerAuthCode() types.Optional[string]

Getter for acquirer_auth_code.

func (*GetDebitCardTransactionResponse) GetAcquirerMessage

func (g *GetDebitCardTransactionResponse) GetAcquirerMessage() types.Optional[string]

Getter for acquirer_message.

func (*GetDebitCardTransactionResponse) GetAcquirerName

func (g *GetDebitCardTransactionResponse) GetAcquirerName() types.Optional[string]

Getter for acquirer_name.

func (*GetDebitCardTransactionResponse) GetAcquirerNsu

Getter for acquirer_nsu.

func (*GetDebitCardTransactionResponse) GetAcquirerReturnCode

func (g *GetDebitCardTransactionResponse) GetAcquirerReturnCode() types.Optional[string]

Getter for acquirer_return_code.

func (*GetDebitCardTransactionResponse) GetAcquirerTid

Getter for acquirer_tid.

func (*GetDebitCardTransactionResponse) GetAuthenticationType

func (g *GetDebitCardTransactionResponse) GetAuthenticationType() types.Optional[string]

Getter for authentication_type.

func (*GetDebitCardTransactionResponse) GetCard

Getter for card.

func (*GetDebitCardTransactionResponse) GetEci

Getter for eci.

func (*GetDebitCardTransactionResponse) GetFundingSource

func (g *GetDebitCardTransactionResponse) GetFundingSource() types.Optional[string]

Getter for funding_source.

func (*GetDebitCardTransactionResponse) GetMpi

Getter for mpi.

func (*GetDebitCardTransactionResponse) GetOperationType

func (g *GetDebitCardTransactionResponse) GetOperationType() types.Optional[string]

Getter for operation_type.

func (*GetDebitCardTransactionResponse) GetStatementDescriptor

func (g *GetDebitCardTransactionResponse) GetStatementDescriptor() types.Optional[string]

Getter for statement_descriptor.

func (*GetDebitCardTransactionResponse) GetThreedAuthenticationUrl

func (g *GetDebitCardTransactionResponse) GetThreedAuthenticationUrl() types.Optional[string]

Getter for threed_authentication_url.

func (*GetDebitCardTransactionResponse) MarshalJSON

func (g *GetDebitCardTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetDebitCardTransactionResponse) UnmarshalJSON

func (g *GetDebitCardTransactionResponse) UnmarshalJSON(input []byte) error

type GetDebitCardTransactionResponseField

type GetDebitCardTransactionResponseField struct {
	GetDebitCardTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetDebitCardTransactionResponseField) UnmarshalJSON

func (g *GetDebitCardTransactionResponseField) UnmarshalJSON(input []byte) error

type GetDebitCardTransactionResponseInterface

type GetDebitCardTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetStatementDescriptor() types.Optional[string]
	GetAcquirerName() types.Optional[string]
	GetAcquirerAffiliationCode() types.Optional[string]
	GetAcquirerTid() types.Optional[string]
	GetAcquirerNsu() types.Optional[string]
	GetAcquirerAuthCode() types.Optional[string]
	GetOperationType() types.Optional[string]
	GetCard() types.Optional[GetCardResponse]
	GetAcquirerMessage() types.Optional[string]
	GetAcquirerReturnCode() types.Optional[string]
	GetMpi() types.Optional[string]
	GetEci() types.Optional[string]
	GetAuthenticationType() types.Optional[string]
	GetThreedAuthenticationUrl() types.Optional[string]
	GetFundingSource() types.Optional[string]
}

Response object for getting a debit card transaction

func ToGetDebitCardTransactionResponseArray

func ToGetDebitCardTransactionResponseArray(getDebitCardTransactionResponse []GetDebitCardTransactionResponseField) []GetDebitCardTransactionResponseInterface

func UnmarshalGetDebitCardTransactionResponse

func UnmarshalGetDebitCardTransactionResponse(input []byte) (
	GetDebitCardTransactionResponseInterface,
	error)

type GetDebitCardTransactionResponseSlice

type GetDebitCardTransactionResponseSlice struct {
	Slice []GetDebitCardTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetDebitCardTransactionResponseSlice) UnmarshalJSON

func (ga *GetDebitCardTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetDeviceResponse

type GetDeviceResponse struct {
	Platform types.Optional[string] `json:"platform"`
}

Response object for geetting an order device

func (*GetDeviceResponse) MarshalJSON

func (g *GetDeviceResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetDeviceResponse) UnmarshalJSON

func (g *GetDeviceResponse) UnmarshalJSON(input []byte) error

type GetDiscountResponse

type GetDiscountResponse struct {
	Id               types.Optional[string]                      `json:"id"`
	Value            types.Optional[float64]                     `json:"value"`
	DiscountType     types.Optional[string]                      `json:"discount_type"`
	Status           types.Optional[string]                      `json:"status"`
	CreatedAt        types.Optional[time.Time]                   `json:"created_at"`
	Cycles           types.Optional[int]                         `json:"cycles"`
	DeletedAt        types.Optional[time.Time]                   `json:"deleted_at"`
	Description      types.Optional[string]                      `json:"description"`
	Subscription     types.Optional[GetSubscriptionResponse]     `json:"subscription"`
	SubscriptionItem types.Optional[GetSubscriptionItemResponse] `json:"subscription_item"`
}

Response object for getting a discount

func (*GetDiscountResponse) MarshalJSON

func (g *GetDiscountResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetDiscountResponse) UnmarshalJSON

func (g *GetDiscountResponse) UnmarshalJSON(input []byte) error

type GetFineResponse

type GetFineResponse struct {
	Days   types.Optional[int]    `json:"days"`
	Type   types.Optional[string] `json:"type"`
	Amount types.Optional[int]    `json:"amount"`
}

Fine Response

func (*GetFineResponse) MarshalJSON

func (g *GetFineResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetFineResponse) UnmarshalJSON

func (g *GetFineResponse) UnmarshalJSON(input []byte) error

type GetGatewayErrorResponse

type GetGatewayErrorResponse struct {
	Message types.Optional[string] `json:"message"`
}

Gateway Response

func (*GetGatewayErrorResponse) MarshalJSON

func (g *GetGatewayErrorResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetGatewayErrorResponse) UnmarshalJSON

func (g *GetGatewayErrorResponse) UnmarshalJSON(input []byte) error

type GetGatewayRecipientResponse

type GetGatewayRecipientResponse struct {
	Gateway   types.Optional[string] `json:"gateway"`
	Status    types.Optional[string] `json:"status"`
	Pgid      types.Optional[string] `json:"pgid"`
	CreatedAt types.Optional[string] `json:"created_at"`
	UpdatedAt types.Optional[string] `json:"updated_at"`
}

Information about the recipient on the gateway

func (*GetGatewayRecipientResponse) MarshalJSON

func (g *GetGatewayRecipientResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetGatewayRecipientResponse) UnmarshalJSON

func (g *GetGatewayRecipientResponse) UnmarshalJSON(input []byte) error

type GetGatewayResponseResponse

type GetGatewayResponseResponse struct {
	Code   types.Optional[string]                    `json:"code"`
	Errors types.Optional[[]GetGatewayErrorResponse] `json:"errors"`
}

The Transaction Gateway Response

func (*GetGatewayResponseResponse) MarshalJSON

func (g *GetGatewayResponseResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetGatewayResponseResponse) UnmarshalJSON

func (g *GetGatewayResponseResponse) UnmarshalJSON(input []byte) error

type GetIncrementResponse

type GetIncrementResponse struct {
	Id               types.Optional[string]                      `json:"id"`
	Value            types.Optional[float64]                     `json:"value"`
	IncrementType    types.Optional[string]                      `json:"increment_type"`
	Status           types.Optional[string]                      `json:"status"`
	CreatedAt        types.Optional[time.Time]                   `json:"created_at"`
	Cycles           types.Optional[int]                         `json:"cycles"`
	DeletedAt        types.Optional[time.Time]                   `json:"deleted_at"`
	Description      types.Optional[string]                      `json:"description"`
	Subscription     types.Optional[GetSubscriptionResponse]     `json:"subscription"`
	SubscriptionItem types.Optional[GetSubscriptionItemResponse] `json:"subscription_item"`
}

Response object for getting a increment

func (*GetIncrementResponse) MarshalJSON

func (g *GetIncrementResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetIncrementResponse) UnmarshalJSON

func (g *GetIncrementResponse) UnmarshalJSON(input []byte) error

type GetInterestResponse

type GetInterestResponse struct {
	Days   types.Optional[int]    `json:"days"`
	Type   types.Optional[string] `json:"type"`
	Amount types.Optional[int]    `json:"amount"`
}

Interest Response

func (*GetInterestResponse) MarshalJSON

func (g *GetInterestResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetInterestResponse) UnmarshalJSON

func (g *GetInterestResponse) UnmarshalJSON(input []byte) error

type GetInvoiceItemResponse

type GetInvoiceItemResponse struct {
	Amount             types.Optional[int]                      `json:"amount"`
	Description        types.Optional[string]                   `json:"description"`
	PricingScheme      types.Optional[GetPricingSchemeResponse] `json:"pricing_scheme"`
	PriceBracket       types.Optional[GetPriceBracketResponse]  `json:"price_bracket"`
	Quantity           types.Optional[int]                      `json:"quantity"`
	Name               types.Optional[string]                   `json:"name"`
	SubscriptionItemId types.Optional[string]                   `json:"subscription_item_id"`
}

Response object for getting an invoice item

func (*GetInvoiceItemResponse) MarshalJSON

func (g *GetInvoiceItemResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetInvoiceItemResponse) UnmarshalJSON

func (g *GetInvoiceItemResponse) UnmarshalJSON(input []byte) error

type GetInvoiceResponse

type GetInvoiceResponse struct {
	Id             types.Optional[string]                    `json:"id"`
	Code           types.Optional[string]                    `json:"code"`
	Url            types.Optional[string]                    `json:"url"`
	Amount         types.Optional[int]                       `json:"amount"`
	Status         types.Optional[string]                    `json:"status"`
	PaymentMethod  types.Optional[string]                    `json:"payment_method"`
	CreatedAt      types.Optional[time.Time]                 `json:"created_at"`
	Items          types.Optional[[]GetInvoiceItemResponse]  `json:"items"`
	Customer       types.Optional[GetCustomerResponse]       `json:"customer"`
	Charge         types.Optional[GetChargeResponse]         `json:"charge"`
	Installments   types.Optional[int]                       `json:"installments"`
	BillingAddress types.Optional[GetBillingAddressResponse] `json:"billing_address"`
	Subscription   types.Optional[GetSubscriptionResponse]   `json:"subscription"`
	Cycle          types.Optional[GetPeriodResponse]         `json:"cycle"`
	Shipping       types.Optional[GetShippingResponse]       `json:"shipping"`
	Metadata       types.Optional[map[string]string]         `json:"metadata"`
	DueAt          types.Optional[time.Time]                 `json:"due_at"`
	CanceledAt     types.Optional[time.Time]                 `json:"canceled_at"`
	BillingAt      types.Optional[time.Time]                 `json:"billing_at"`
	SeenAt         types.Optional[time.Time]                 `json:"seen_at"`
	TotalDiscount  types.Optional[int]                       `json:"total_discount"`
	TotalIncrement types.Optional[int]                       `json:"total_increment"`
	SubscriptionId types.Optional[string]                    `json:"subscription_id"`
}

Response object for getting an invoice

func (*GetInvoiceResponse) MarshalJSON

func (g *GetInvoiceResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetInvoiceResponse) UnmarshalJSON

func (g *GetInvoiceResponse) UnmarshalJSON(input []byte) error

type GetLocationResponse

type GetLocationResponse struct {
	Latitude  types.Optional[string] `json:"latitude"`
	Longitude types.Optional[string] `json:"longitude"`
}

Response object for geetting an order location request

func (*GetLocationResponse) MarshalJSON

func (g *GetLocationResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetLocationResponse) UnmarshalJSON

func (g *GetLocationResponse) UnmarshalJSON(input []byte) error

type GetMovementObjectBaseResponse

type GetMovementObjectBaseResponse struct {
	Object    *string                `json:"object,omitempty"`
	Id        types.Optional[string] `json:"id"`
	Status    types.Optional[string] `json:"status"`
	Amount    types.Optional[string] `json:"amount"`
	CreatedAt types.Optional[string] `json:"created_at"`
	Type      types.Optional[string] `json:"type"`
	ChargeId  types.Optional[string] `json:"charge_id"`
	GatewayId types.Optional[string] `json:"gateway_id"`
}

Generic response object for getting a MovementObjectBase.

func (*GetMovementObjectBaseResponse) GetAmount

Getter for amount.

func (*GetMovementObjectBaseResponse) GetChargeId

Getter for charge_id.

func (*GetMovementObjectBaseResponse) GetCreatedAt

Getter for created_at.

func (*GetMovementObjectBaseResponse) GetGatewayId

Getter for gateway_id.

func (*GetMovementObjectBaseResponse) GetId

Getter for id.

func (*GetMovementObjectBaseResponse) GetObject

func (g *GetMovementObjectBaseResponse) GetObject() *string

Getter for object.

func (*GetMovementObjectBaseResponse) GetStatus

Getter for status.

func (*GetMovementObjectBaseResponse) GetType

Getter for type.

func (*GetMovementObjectBaseResponse) MarshalJSON

func (g *GetMovementObjectBaseResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetMovementObjectBaseResponse) UnmarshalJSON

func (g *GetMovementObjectBaseResponse) UnmarshalJSON(input []byte) error

type GetMovementObjectBaseResponseField

type GetMovementObjectBaseResponseField struct {
	GetMovementObjectBaseResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetMovementObjectBaseResponseField) UnmarshalJSON

func (g *GetMovementObjectBaseResponseField) UnmarshalJSON(input []byte) error

type GetMovementObjectBaseResponseInterface

type GetMovementObjectBaseResponseInterface interface {
	GetObject() *string
	GetId() types.Optional[string]
	GetStatus() types.Optional[string]
	GetAmount() types.Optional[string]
	GetCreatedAt() types.Optional[string]
	GetType() types.Optional[string]
	GetChargeId() types.Optional[string]
	GetGatewayId() types.Optional[string]
}

Generic response object for getting a MovementObjectBase.

func ToGetMovementObjectBaseResponseArray

func ToGetMovementObjectBaseResponseArray(getMovementObjectBaseResponse []GetMovementObjectBaseResponseField) []GetMovementObjectBaseResponseInterface

func UnmarshalGetMovementObjectBaseResponse

func UnmarshalGetMovementObjectBaseResponse(input []byte) (
	GetMovementObjectBaseResponseInterface,
	error)

type GetMovementObjectBaseResponseSlice

type GetMovementObjectBaseResponseSlice struct {
	Slice []GetMovementObjectBaseResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetMovementObjectBaseResponseSlice) UnmarshalJSON

func (ga *GetMovementObjectBaseResponseSlice) UnmarshalJSON(input []byte) error

type GetMovementObjectFeeCollectionResponse

type GetMovementObjectFeeCollectionResponse struct {
	GetMovementObjectBaseResponse
	Description types.Optional[string] `json:"description"`
	PaymentDate types.Optional[string] `json:"payment_date"`
	RecipientId types.Optional[string] `json:"recipient_id"`
}

Generic response object for getting a MovementObjectFeeCollection.

func (*GetMovementObjectFeeCollectionResponse) GetDescription

Getter for description.

func (*GetMovementObjectFeeCollectionResponse) GetPaymentDate

Getter for payment_date.

func (*GetMovementObjectFeeCollectionResponse) GetRecipientId

Getter for recipient_id.

func (*GetMovementObjectFeeCollectionResponse) MarshalJSON

func (g *GetMovementObjectFeeCollectionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetMovementObjectFeeCollectionResponse) UnmarshalJSON

func (g *GetMovementObjectFeeCollectionResponse) UnmarshalJSON(input []byte) error

type GetMovementObjectFeeCollectionResponseField

type GetMovementObjectFeeCollectionResponseField struct {
	GetMovementObjectFeeCollectionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetMovementObjectFeeCollectionResponseField) UnmarshalJSON

func (g *GetMovementObjectFeeCollectionResponseField) UnmarshalJSON(input []byte) error

type GetMovementObjectFeeCollectionResponseInterface

type GetMovementObjectFeeCollectionResponseInterface interface {
	GetMovementObjectBaseResponseInterface
	GetDescription() types.Optional[string]
	GetPaymentDate() types.Optional[string]
	GetRecipientId() types.Optional[string]
}

Generic response object for getting a MovementObjectFeeCollection.

func ToGetMovementObjectFeeCollectionResponseArray

func ToGetMovementObjectFeeCollectionResponseArray(getMovementObjectFeeCollectionResponse []GetMovementObjectFeeCollectionResponseField) []GetMovementObjectFeeCollectionResponseInterface

func UnmarshalGetMovementObjectFeeCollectionResponse

func UnmarshalGetMovementObjectFeeCollectionResponse(input []byte) (
	GetMovementObjectFeeCollectionResponseInterface,
	error)

type GetMovementObjectFeeCollectionResponseSlice

type GetMovementObjectFeeCollectionResponseSlice struct {
	Slice []GetMovementObjectFeeCollectionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetMovementObjectFeeCollectionResponseSlice) UnmarshalJSON

func (ga *GetMovementObjectFeeCollectionResponseSlice) UnmarshalJSON(input []byte) error

type GetMovementObjectPayableResponse

type GetMovementObjectPayableResponse struct {
	GetMovementObjectBaseResponse
	Fee                      types.Optional[string] `json:"fee"`
	AnticipationFee          string                 `json:"anticipation_fee"`
	FraudCoverageFee         string                 `json:"fraud_coverage_fee"`
	Installment              string                 `json:"installment"`
	SplitId                  string                 `json:"split_id"`
	BulkAnticipationId       string                 `json:"bulk_anticipation_id"`
	AnticipationId           string                 `json:"anticipation_id"`
	RecipientId              string                 `json:"recipient_id"`
	OriginatorModel          string                 `json:"originator_model"`
	OriginatorModelId        string                 `json:"originator_model_id"`
	PaymentDate              string                 `json:"payment_date"`
	OriginalPaymentDate      string                 `json:"original_payment_date"`
	PaymentMethod            string                 `json:"payment_method"`
	AccrualAt                string                 `json:"accrual_at"`
	LiquidationArrangementId string                 `json:"liquidation_arrangement_id"`
}

func (*GetMovementObjectPayableResponse) GetAccrualAt

func (g *GetMovementObjectPayableResponse) GetAccrualAt() string

Getter for accrual_at.

func (*GetMovementObjectPayableResponse) GetAnticipationFee

func (g *GetMovementObjectPayableResponse) GetAnticipationFee() string

Getter for anticipation_fee.

func (*GetMovementObjectPayableResponse) GetAnticipationId

func (g *GetMovementObjectPayableResponse) GetAnticipationId() string

Getter for anticipation_id.

func (*GetMovementObjectPayableResponse) GetBulkAnticipationId

func (g *GetMovementObjectPayableResponse) GetBulkAnticipationId() string

Getter for bulk_anticipation_id.

func (*GetMovementObjectPayableResponse) GetFee

Getter for fee.

func (*GetMovementObjectPayableResponse) GetFraudCoverageFee

func (g *GetMovementObjectPayableResponse) GetFraudCoverageFee() string

Getter for fraud_coverage_fee.

func (*GetMovementObjectPayableResponse) GetInstallment

func (g *GetMovementObjectPayableResponse) GetInstallment() string

Getter for installment.

func (*GetMovementObjectPayableResponse) GetLiquidationArrangementId

func (g *GetMovementObjectPayableResponse) GetLiquidationArrangementId() string

Getter for liquidation_arrangement_id.

func (*GetMovementObjectPayableResponse) GetOriginalPaymentDate

func (g *GetMovementObjectPayableResponse) GetOriginalPaymentDate() string

Getter for original_payment_date.

func (*GetMovementObjectPayableResponse) GetOriginatorModel

func (g *GetMovementObjectPayableResponse) GetOriginatorModel() string

Getter for originator_model.

func (*GetMovementObjectPayableResponse) GetOriginatorModelId

func (g *GetMovementObjectPayableResponse) GetOriginatorModelId() string

Getter for originator_model_id.

func (*GetMovementObjectPayableResponse) GetPaymentDate

func (g *GetMovementObjectPayableResponse) GetPaymentDate() string

Getter for payment_date.

func (*GetMovementObjectPayableResponse) GetPaymentMethod

func (g *GetMovementObjectPayableResponse) GetPaymentMethod() string

Getter for payment_method.

func (*GetMovementObjectPayableResponse) GetRecipientId

func (g *GetMovementObjectPayableResponse) GetRecipientId() string

Getter for recipient_id.

func (*GetMovementObjectPayableResponse) GetSplitId

func (g *GetMovementObjectPayableResponse) GetSplitId() string

Getter for split_id.

func (*GetMovementObjectPayableResponse) MarshalJSON

func (g *GetMovementObjectPayableResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetMovementObjectPayableResponse) UnmarshalJSON

func (g *GetMovementObjectPayableResponse) UnmarshalJSON(input []byte) error

type GetMovementObjectPayableResponseField

type GetMovementObjectPayableResponseField struct {
	GetMovementObjectPayableResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetMovementObjectPayableResponseField) UnmarshalJSON

func (g *GetMovementObjectPayableResponseField) UnmarshalJSON(input []byte) error

type GetMovementObjectPayableResponseInterface

type GetMovementObjectPayableResponseInterface interface {
	GetMovementObjectBaseResponseInterface
	GetFee() types.Optional[string]
	GetAnticipationFee() string
	GetFraudCoverageFee() string
	GetInstallment() string
	GetSplitId() string
	GetBulkAnticipationId() string
	GetAnticipationId() string
	GetRecipientId() string
	GetOriginatorModel() string
	GetOriginatorModelId() string
	GetPaymentDate() string
	GetOriginalPaymentDate() string
	GetPaymentMethod() string
	GetAccrualAt() string
	GetLiquidationArrangementId() string
}

func ToGetMovementObjectPayableResponseArray

func ToGetMovementObjectPayableResponseArray(getMovementObjectPayableResponse []GetMovementObjectPayableResponseField) []GetMovementObjectPayableResponseInterface

func UnmarshalGetMovementObjectPayableResponse

func UnmarshalGetMovementObjectPayableResponse(input []byte) (
	GetMovementObjectPayableResponseInterface,
	error)

type GetMovementObjectPayableResponseSlice

type GetMovementObjectPayableResponseSlice struct {
	Slice []GetMovementObjectPayableResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetMovementObjectPayableResponseSlice) UnmarshalJSON

func (ga *GetMovementObjectPayableResponseSlice) UnmarshalJSON(input []byte) error

type GetMovementObjectRefundResponse

type GetMovementObjectRefundResponse struct {
	GetMovementObjectBaseResponse
	FraudCoverageFee     types.Optional[string] `json:"fraud_coverage_fee"`
	ChargeFeeRecipientId types.Optional[string] `json:"charge_fee_recipient_id"`
	BankAccountId        types.Optional[string] `json:"bank_account_id"`
	LocalTransactionId   types.Optional[string] `json:"local_transaction_id"`
	UpdatedAt            types.Optional[string] `json:"updated_at"`
}

Generic response object for getting a MovementObjectRefund.

func (*GetMovementObjectRefundResponse) GetBankAccountId

func (g *GetMovementObjectRefundResponse) GetBankAccountId() types.Optional[string]

Getter for bank_account_id.

func (*GetMovementObjectRefundResponse) GetChargeFeeRecipientId

func (g *GetMovementObjectRefundResponse) GetChargeFeeRecipientId() types.Optional[string]

Getter for charge_fee_recipient_id.

func (*GetMovementObjectRefundResponse) GetFraudCoverageFee

func (g *GetMovementObjectRefundResponse) GetFraudCoverageFee() types.Optional[string]

Getter for fraud_coverage_fee.

func (*GetMovementObjectRefundResponse) GetLocalTransactionId

func (g *GetMovementObjectRefundResponse) GetLocalTransactionId() types.Optional[string]

Getter for local_transaction_id.

func (*GetMovementObjectRefundResponse) GetUpdatedAt

Getter for updated_at.

func (*GetMovementObjectRefundResponse) MarshalJSON

func (g *GetMovementObjectRefundResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetMovementObjectRefundResponse) UnmarshalJSON

func (g *GetMovementObjectRefundResponse) UnmarshalJSON(input []byte) error

type GetMovementObjectRefundResponseField

type GetMovementObjectRefundResponseField struct {
	GetMovementObjectRefundResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetMovementObjectRefundResponseField) UnmarshalJSON

func (g *GetMovementObjectRefundResponseField) UnmarshalJSON(input []byte) error

type GetMovementObjectRefundResponseInterface

type GetMovementObjectRefundResponseInterface interface {
	GetMovementObjectBaseResponseInterface
	GetFraudCoverageFee() types.Optional[string]
	GetChargeFeeRecipientId() types.Optional[string]
	GetBankAccountId() types.Optional[string]
	GetLocalTransactionId() types.Optional[string]
	GetUpdatedAt() types.Optional[string]
}

Generic response object for getting a MovementObjectRefund.

func ToGetMovementObjectRefundResponseArray

func ToGetMovementObjectRefundResponseArray(getMovementObjectRefundResponse []GetMovementObjectRefundResponseField) []GetMovementObjectRefundResponseInterface

func UnmarshalGetMovementObjectRefundResponse

func UnmarshalGetMovementObjectRefundResponse(input []byte) (
	GetMovementObjectRefundResponseInterface,
	error)

type GetMovementObjectRefundResponseSlice

type GetMovementObjectRefundResponseSlice struct {
	Slice []GetMovementObjectRefundResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetMovementObjectRefundResponseSlice) UnmarshalJSON

func (ga *GetMovementObjectRefundResponseSlice) UnmarshalJSON(input []byte) error

type GetMovementObjectTransferResponse

type GetMovementObjectTransferResponse struct {
	GetMovementObjectBaseResponse
	SourceType           types.Optional[string] `json:"source_type"`
	SourceId             types.Optional[string] `json:"source_id"`
	TargetType           types.Optional[string] `json:"target_type"`
	TargetId             types.Optional[string] `json:"target_id"`
	Fee                  types.Optional[string] `json:"fee"`
	FundingDate          types.Optional[string] `json:"funding_date"`
	FundingEstimatedDate types.Optional[string] `json:"funding_estimated_date"`
	BankAccount          types.Optional[string] `json:"bank_account"`
}

func (*GetMovementObjectTransferResponse) GetBankAccount

Getter for bank_account.

func (*GetMovementObjectTransferResponse) GetFee

Getter for fee.

func (*GetMovementObjectTransferResponse) GetFundingDate

Getter for funding_date.

func (*GetMovementObjectTransferResponse) GetFundingEstimatedDate

func (g *GetMovementObjectTransferResponse) GetFundingEstimatedDate() types.Optional[string]

Getter for funding_estimated_date.

func (*GetMovementObjectTransferResponse) GetSourceId

Getter for source_id.

func (*GetMovementObjectTransferResponse) GetSourceType

Getter for source_type.

func (*GetMovementObjectTransferResponse) GetTargetId

Getter for target_id.

func (*GetMovementObjectTransferResponse) GetTargetType

Getter for target_type.

func (*GetMovementObjectTransferResponse) MarshalJSON

func (g *GetMovementObjectTransferResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetMovementObjectTransferResponse) UnmarshalJSON

func (g *GetMovementObjectTransferResponse) UnmarshalJSON(input []byte) error

type GetMovementObjectTransferResponseField

type GetMovementObjectTransferResponseField struct {
	GetMovementObjectTransferResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetMovementObjectTransferResponseField) UnmarshalJSON

func (g *GetMovementObjectTransferResponseField) UnmarshalJSON(input []byte) error

type GetMovementObjectTransferResponseInterface

type GetMovementObjectTransferResponseInterface interface {
	GetMovementObjectBaseResponseInterface
	GetSourceType() types.Optional[string]
	GetSourceId() types.Optional[string]
	GetTargetType() types.Optional[string]
	GetTargetId() types.Optional[string]
	GetFee() types.Optional[string]
	GetFundingDate() types.Optional[string]
	GetFundingEstimatedDate() types.Optional[string]
	GetBankAccount() types.Optional[string]
}

func ToGetMovementObjectTransferResponseArray

func ToGetMovementObjectTransferResponseArray(getMovementObjectTransferResponse []GetMovementObjectTransferResponseField) []GetMovementObjectTransferResponseInterface

func UnmarshalGetMovementObjectTransferResponse

func UnmarshalGetMovementObjectTransferResponse(input []byte) (
	GetMovementObjectTransferResponseInterface,
	error)

type GetMovementObjectTransferResponseSlice

type GetMovementObjectTransferResponseSlice struct {
	Slice []GetMovementObjectTransferResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetMovementObjectTransferResponseSlice) UnmarshalJSON

func (ga *GetMovementObjectTransferResponseSlice) UnmarshalJSON(input []byte) error

type GetOrderItemResponse

type GetOrderItemResponse struct {
	Id          types.Optional[string] `json:"id"`
	Amount      types.Optional[int]    `json:"amount"`
	Description types.Optional[string] `json:"description"`
	Quantity    types.Optional[int]    `json:"quantity"`
	Category    types.Optional[string] `json:"category"`
	Code        types.Optional[string] `json:"code"`
}

Response object for getting an order item

func (*GetOrderItemResponse) MarshalJSON

func (g *GetOrderItemResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetOrderItemResponse) UnmarshalJSON

func (g *GetOrderItemResponse) UnmarshalJSON(input []byte) error

type GetOrderResponse

type GetOrderResponse struct {
	Id         types.Optional[string]                       `json:"id"`
	Code       types.Optional[string]                       `json:"code"`
	Currency   types.Optional[string]                       `json:"currency"`
	Items      types.Optional[[]GetOrderItemResponse]       `json:"items"`
	Customer   types.Optional[GetCustomerResponse]          `json:"customer"`
	Status     types.Optional[string]                       `json:"status"`
	CreatedAt  types.Optional[time.Time]                    `json:"created_at"`
	UpdatedAt  types.Optional[time.Time]                    `json:"updated_at"`
	Charges    types.Optional[[]GetChargeResponse]          `json:"charges"`
	InvoiceUrl types.Optional[string]                       `json:"invoice_url"`
	Shipping   types.Optional[GetShippingResponse]          `json:"shipping"`
	Metadata   types.Optional[map[string]string]            `json:"metadata"`
	Checkouts  types.Optional[[]GetCheckoutPaymentResponse] `json:"checkouts"`
	Ip         types.Optional[string]                       `json:"ip"`
	SessionId  types.Optional[string]                       `json:"session_id"`
	Location   types.Optional[GetLocationResponse]          `json:"location"`
	Device     types.Optional[GetDeviceResponse]            `json:"device"`
	Closed     types.Optional[bool]                         `json:"closed"`
}

Response object for getting an Order

func (*GetOrderResponse) MarshalJSON

func (g *GetOrderResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetOrderResponse) UnmarshalJSON

func (g *GetOrderResponse) UnmarshalJSON(input []byte) error

type GetPayableResponse

type GetPayableResponse struct {
	Id                       types.Optional[int64]     `json:"id"`
	Status                   types.Optional[string]    `json:"status"`
	Amount                   types.Optional[int]       `json:"amount"`
	Fee                      types.Optional[int]       `json:"fee"`
	AnticipationFee          types.Optional[int]       `json:"anticipation_fee"`
	FraudCoverageFee         types.Optional[int]       `json:"fraud_coverage_fee"`
	Installment              types.Optional[int]       `json:"installment"`
	GatewayId                types.Optional[int]       `json:"gateway_id"`
	ChargeId                 types.Optional[string]    `json:"charge_id"`
	SplitId                  types.Optional[string]    `json:"split_id"`
	BulkAnticipationId       types.Optional[string]    `json:"bulk_anticipation_id"`
	AnticipationId           types.Optional[string]    `json:"anticipation_id"`
	RecipientId              types.Optional[string]    `json:"recipient_id"`
	OriginatorModel          types.Optional[string]    `json:"originator_model"`
	OriginatorModelId        types.Optional[string]    `json:"originator_model_id"`
	PaymentDate              types.Optional[time.Time] `json:"payment_date"`
	OriginalPaymentDate      types.Optional[time.Time] `json:"original_payment_date"`
	Type                     types.Optional[string]    `json:"type"`
	PaymentMethod            types.Optional[string]    `json:"payment_method"`
	AccrualAt                types.Optional[time.Time] `json:"accrual_at"`
	CreatedAt                types.Optional[time.Time] `json:"created_at"`
	LiquidationArrangementId types.Optional[string]    `json:"liquidation_arrangement_id"`
}

Response object for getting an payable

func (*GetPayableResponse) MarshalJSON

func (g *GetPayableResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPayableResponse) UnmarshalJSON

func (g *GetPayableResponse) UnmarshalJSON(input []byte) error

type GetPaymentAuthenticationResponse

type GetPaymentAuthenticationResponse struct {
	Type         types.Optional[string]                  `json:"type"`
	ThreedSecure types.Optional[GetThreeDSecureResponse] `json:"threed_secure"`
}

Payment Authentication response

func (*GetPaymentAuthenticationResponse) MarshalJSON

func (g *GetPaymentAuthenticationResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPaymentAuthenticationResponse) UnmarshalJSON

func (g *GetPaymentAuthenticationResponse) UnmarshalJSON(input []byte) error

type GetPeriodResponse

type GetPeriodResponse struct {
	StartAt      types.Optional[time.Time]               `json:"start_at"`
	EndAt        types.Optional[time.Time]               `json:"end_at"`
	Id           types.Optional[string]                  `json:"id"`
	BillingAt    types.Optional[time.Time]               `json:"billing_at"`
	Subscription types.Optional[GetSubscriptionResponse] `json:"subscription"`
	Status       types.Optional[string]                  `json:"status"`
	Duration     types.Optional[int]                     `json:"duration"`
	CreatedAt    types.Optional[string]                  `json:"created_at"`
	UpdatedAt    types.Optional[string]                  `json:"updated_at"`
	Cycle        types.Optional[int]                     `json:"cycle"`
}

Response object for getting a period

func (*GetPeriodResponse) MarshalJSON

func (g *GetPeriodResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPeriodResponse) UnmarshalJSON

func (g *GetPeriodResponse) UnmarshalJSON(input []byte) error

type GetPhoneResponse

type GetPhoneResponse struct {
	CountryCode types.Optional[string] `json:"country_code"`
	Number      types.Optional[string] `json:"number"`
	AreaCode    types.Optional[string] `json:"area_code"`
}

func (*GetPhoneResponse) MarshalJSON

func (g *GetPhoneResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPhoneResponse) UnmarshalJSON

func (g *GetPhoneResponse) UnmarshalJSON(input []byte) error

type GetPhonesResponse

type GetPhonesResponse struct {
	HomePhone   types.Optional[GetPhoneResponse] `json:"home_phone"`
	MobilePhone types.Optional[GetPhoneResponse] `json:"mobile_phone"`
}

func (*GetPhonesResponse) MarshalJSON

func (g *GetPhonesResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPhonesResponse) UnmarshalJSON

func (g *GetPhonesResponse) UnmarshalJSON(input []byte) error

type GetPixBankAccountResponse

type GetPixBankAccountResponse struct {
	BankName      types.Optional[string] `json:"bank_name"`
	Ispb          types.Optional[string] `json:"ispb"`
	BranchCode    types.Optional[string] `json:"branch_code"`
	AccountNumber types.Optional[string] `json:"account_number"`
}

Payer's bank details.

func (*GetPixBankAccountResponse) MarshalJSON

func (g *GetPixBankAccountResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPixBankAccountResponse) UnmarshalJSON

func (g *GetPixBankAccountResponse) UnmarshalJSON(input []byte) error

type GetPixPayerResponse

type GetPixPayerResponse struct {
	Name         types.Optional[string]                    `json:"name"`
	Document     types.Optional[string]                    `json:"document"`
	DocumentType types.Optional[string]                    `json:"document_type"`
	BankAccount  types.Optional[GetPixBankAccountResponse] `json:"bank_account"`
}

Pix payer data.

func (*GetPixPayerResponse) MarshalJSON

func (g *GetPixPayerResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPixPayerResponse) UnmarshalJSON

func (g *GetPixPayerResponse) UnmarshalJSON(input []byte) error

type GetPixTransactionResponse

type GetPixTransactionResponse struct {
	GetTransactionResponse
	QrCode                types.Optional[string]                     `json:"qr_code"`
	QrCodeUrl             types.Optional[string]                     `json:"qr_code_url"`
	ExpiresAt             types.Optional[time.Time]                  `json:"expires_at"`
	AdditionalInformation types.Optional[[]PixAdditionalInformation] `json:"additional_information"`
	EndToEndId            types.Optional[string]                     `json:"end_to_end_id"`
	Payer                 types.Optional[GetPixPayerResponse]        `json:"payer"`
	PixProviderTid        types.Optional[string]                     `json:"pix_provider_tid"`
}

Response object when getting a pix transaction

func (*GetPixTransactionResponse) GetAdditionalInformation

func (g *GetPixTransactionResponse) GetAdditionalInformation() types.Optional[[]PixAdditionalInformation]

Getter for additional_information.

func (*GetPixTransactionResponse) GetEndToEndId

func (g *GetPixTransactionResponse) GetEndToEndId() types.Optional[string]

Getter for end_to_end_id.

func (*GetPixTransactionResponse) GetExpiresAt

func (g *GetPixTransactionResponse) GetExpiresAt() types.Optional[time.Time]

Getter for expires_at.

func (*GetPixTransactionResponse) GetPayer

Getter for payer.

func (*GetPixTransactionResponse) GetPixProviderTid

func (g *GetPixTransactionResponse) GetPixProviderTid() types.Optional[string]

Getter for pix_provider_tid.

func (*GetPixTransactionResponse) GetQrCode

Getter for qr_code.

func (*GetPixTransactionResponse) GetQrCodeUrl

func (g *GetPixTransactionResponse) GetQrCodeUrl() types.Optional[string]

Getter for qr_code_url.

func (*GetPixTransactionResponse) MarshalJSON

func (g *GetPixTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPixTransactionResponse) UnmarshalJSON

func (g *GetPixTransactionResponse) UnmarshalJSON(input []byte) error

type GetPixTransactionResponseField

type GetPixTransactionResponseField struct {
	GetPixTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetPixTransactionResponseField) UnmarshalJSON

func (g *GetPixTransactionResponseField) UnmarshalJSON(input []byte) error

type GetPixTransactionResponseInterface

type GetPixTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetQrCode() types.Optional[string]
	GetQrCodeUrl() types.Optional[string]
	GetExpiresAt() types.Optional[time.Time]
	GetAdditionalInformation() types.Optional[[]PixAdditionalInformation]
	GetEndToEndId() types.Optional[string]
	GetPayer() types.Optional[GetPixPayerResponse]
	GetPixProviderTid() types.Optional[string]
}

Response object when getting a pix transaction

func ToGetPixTransactionResponseArray

func ToGetPixTransactionResponseArray(getPixTransactionResponse []GetPixTransactionResponseField) []GetPixTransactionResponseInterface

func UnmarshalGetPixTransactionResponse

func UnmarshalGetPixTransactionResponse(input []byte) (
	GetPixTransactionResponseInterface,
	error)

type GetPixTransactionResponseSlice

type GetPixTransactionResponseSlice struct {
	Slice []GetPixTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetPixTransactionResponseSlice) UnmarshalJSON

func (ga *GetPixTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetPlanItemResponse

type GetPlanItemResponse struct {
	Id            types.Optional[string]                   `json:"id"`
	Name          types.Optional[string]                   `json:"name"`
	Status        types.Optional[string]                   `json:"status"`
	CreatedAt     types.Optional[time.Time]                `json:"created_at"`
	UpdatedAt     types.Optional[time.Time]                `json:"updated_at"`
	PricingScheme types.Optional[GetPricingSchemeResponse] `json:"pricing_scheme"`
	Description   types.Optional[string]                   `json:"description"`
	Plan          types.Optional[GetPlanResponse]          `json:"plan"`
	Quantity      types.Optional[int]                      `json:"quantity"`
	Cycles        types.Optional[int]                      `json:"cycles"`
	DeletedAt     types.Optional[time.Time]                `json:"deleted_at"`
}

Response object for getting a plan item

func (*GetPlanItemResponse) MarshalJSON

func (g *GetPlanItemResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPlanItemResponse) UnmarshalJSON

func (g *GetPlanItemResponse) UnmarshalJSON(input []byte) error

type GetPlanResponse

type GetPlanResponse struct {
	Id                  types.Optional[string]                `json:"id"`
	Name                types.Optional[string]                `json:"name"`
	Description         types.Optional[string]                `json:"description"`
	Url                 types.Optional[string]                `json:"url"`
	StatementDescriptor types.Optional[string]                `json:"statement_descriptor"`
	Interval            types.Optional[string]                `json:"interval"`
	IntervalCount       types.Optional[int]                   `json:"interval_count"`
	BillingType         types.Optional[string]                `json:"billing_type"`
	PaymentMethods      types.Optional[[]string]              `json:"payment_methods"`
	Installments        types.Optional[[]int]                 `json:"installments"`
	Status              types.Optional[string]                `json:"status"`
	Currency            types.Optional[string]                `json:"currency"`
	CreatedAt           types.Optional[time.Time]             `json:"created_at"`
	UpdatedAt           types.Optional[time.Time]             `json:"updated_at"`
	Items               types.Optional[[]GetPlanItemResponse] `json:"items"`
	BillingDays         types.Optional[[]int]                 `json:"billing_days"`
	Shippable           types.Optional[bool]                  `json:"shippable"`
	Metadata            types.Optional[map[string]string]     `json:"metadata"`
	TrialPeriodDays     types.Optional[int]                   `json:"trial_period_days"`
	MinimumPrice        types.Optional[int]                   `json:"minimum_price"`
	DeletedAt           types.Optional[time.Time]             `json:"deleted_at"`
}

Response object for getting a plan

func (*GetPlanResponse) MarshalJSON

func (g *GetPlanResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPlanResponse) UnmarshalJSON

func (g *GetPlanResponse) UnmarshalJSON(input []byte) error

type GetPriceBracketResponse

type GetPriceBracketResponse struct {
	StartQuantity types.Optional[int] `json:"start_quantity"`
	Price         types.Optional[int] `json:"price"`
	EndQuantity   types.Optional[int] `json:"end_quantity"`
	OveragePrice  types.Optional[int] `json:"overage_price"`
}

Response object for getting a price bracket

func (*GetPriceBracketResponse) MarshalJSON

func (g *GetPriceBracketResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPriceBracketResponse) UnmarshalJSON

func (g *GetPriceBracketResponse) UnmarshalJSON(input []byte) error

type GetPricingSchemeResponse

type GetPricingSchemeResponse struct {
	Price         types.Optional[int]                       `json:"price"`
	SchemeType    types.Optional[string]                    `json:"scheme_type"`
	PriceBrackets types.Optional[[]GetPriceBracketResponse] `json:"price_brackets"`
	MinimumPrice  types.Optional[int]                       `json:"minimum_price"`
	Percentage    types.Optional[float64]                   `json:"percentage"`
}

Response object for getting a pricing scheme

func (*GetPricingSchemeResponse) MarshalJSON

func (g *GetPricingSchemeResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPricingSchemeResponse) UnmarshalJSON

func (g *GetPricingSchemeResponse) UnmarshalJSON(input []byte) error

type GetPrivateLabelTransactionResponse

type GetPrivateLabelTransactionResponse struct {
	GetTransactionResponse
	StatementDescriptor     types.Optional[string]          `json:"statement_descriptor"`
	AcquirerName            types.Optional[string]          `json:"acquirer_name"`
	AcquirerAffiliationCode types.Optional[string]          `json:"acquirer_affiliation_code"`
	AcquirerTid             types.Optional[string]          `json:"acquirer_tid"`
	AcquirerNsu             types.Optional[string]          `json:"acquirer_nsu"`
	AcquirerAuthCode        types.Optional[string]          `json:"acquirer_auth_code"`
	OperationType           types.Optional[string]          `json:"operation_type"`
	Card                    types.Optional[GetCardResponse] `json:"card"`
	AcquirerMessage         types.Optional[string]          `json:"acquirer_message"`
	AcquirerReturnCode      types.Optional[string]          `json:"acquirer_return_code"`
	Installments            types.Optional[int]             `json:"installments"`
}

Response object for getting a private label transaction

func (*GetPrivateLabelTransactionResponse) GetAcquirerAffiliationCode

func (g *GetPrivateLabelTransactionResponse) GetAcquirerAffiliationCode() types.Optional[string]

Getter for acquirer_affiliation_code.

func (*GetPrivateLabelTransactionResponse) GetAcquirerAuthCode

func (g *GetPrivateLabelTransactionResponse) GetAcquirerAuthCode() types.Optional[string]

Getter for acquirer_auth_code.

func (*GetPrivateLabelTransactionResponse) GetAcquirerMessage

func (g *GetPrivateLabelTransactionResponse) GetAcquirerMessage() types.Optional[string]

Getter for acquirer_message.

func (*GetPrivateLabelTransactionResponse) GetAcquirerName

Getter for acquirer_name.

func (*GetPrivateLabelTransactionResponse) GetAcquirerNsu

Getter for acquirer_nsu.

func (*GetPrivateLabelTransactionResponse) GetAcquirerReturnCode

func (g *GetPrivateLabelTransactionResponse) GetAcquirerReturnCode() types.Optional[string]

Getter for acquirer_return_code.

func (*GetPrivateLabelTransactionResponse) GetAcquirerTid

Getter for acquirer_tid.

func (*GetPrivateLabelTransactionResponse) GetCard

Getter for card.

func (*GetPrivateLabelTransactionResponse) GetInstallments

func (g *GetPrivateLabelTransactionResponse) GetInstallments() types.Optional[int]

Getter for installments.

func (*GetPrivateLabelTransactionResponse) GetOperationType

Getter for operation_type.

func (*GetPrivateLabelTransactionResponse) GetStatementDescriptor

func (g *GetPrivateLabelTransactionResponse) GetStatementDescriptor() types.Optional[string]

Getter for statement_descriptor.

func (*GetPrivateLabelTransactionResponse) MarshalJSON

func (g *GetPrivateLabelTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetPrivateLabelTransactionResponse) UnmarshalJSON

func (g *GetPrivateLabelTransactionResponse) UnmarshalJSON(input []byte) error

type GetPrivateLabelTransactionResponseField

type GetPrivateLabelTransactionResponseField struct {
	GetPrivateLabelTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetPrivateLabelTransactionResponseField) UnmarshalJSON

func (g *GetPrivateLabelTransactionResponseField) UnmarshalJSON(input []byte) error

type GetPrivateLabelTransactionResponseInterface

type GetPrivateLabelTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetStatementDescriptor() types.Optional[string]
	GetAcquirerName() types.Optional[string]
	GetAcquirerAffiliationCode() types.Optional[string]
	GetAcquirerTid() types.Optional[string]
	GetAcquirerNsu() types.Optional[string]
	GetAcquirerAuthCode() types.Optional[string]
	GetOperationType() types.Optional[string]
	GetCard() types.Optional[GetCardResponse]
	GetAcquirerMessage() types.Optional[string]
	GetAcquirerReturnCode() types.Optional[string]
	GetInstallments() types.Optional[int]
}

Response object for getting a private label transaction

func ToGetPrivateLabelTransactionResponseArray

func ToGetPrivateLabelTransactionResponseArray(getPrivateLabelTransactionResponse []GetPrivateLabelTransactionResponseField) []GetPrivateLabelTransactionResponseInterface

func UnmarshalGetPrivateLabelTransactionResponse

func UnmarshalGetPrivateLabelTransactionResponse(input []byte) (
	GetPrivateLabelTransactionResponseInterface,
	error)

type GetPrivateLabelTransactionResponseSlice

type GetPrivateLabelTransactionResponseSlice struct {
	Slice []GetPrivateLabelTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetPrivateLabelTransactionResponseSlice) UnmarshalJSON

func (ga *GetPrivateLabelTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetRecipientResponse

type GetRecipientResponse struct {
	Id                            types.Optional[string]                           `json:"id"`
	Name                          types.Optional[string]                           `json:"name"`
	Email                         types.Optional[string]                           `json:"email"`
	Document                      types.Optional[string]                           `json:"document"`
	Description                   types.Optional[string]                           `json:"description"`
	Type                          types.Optional[string]                           `json:"type"`
	Status                        types.Optional[string]                           `json:"status"`
	CreatedAt                     types.Optional[time.Time]                        `json:"created_at"`
	UpdatedAt                     types.Optional[time.Time]                        `json:"updated_at"`
	DeletedAt                     types.Optional[time.Time]                        `json:"deleted_at"`
	DefaultBankAccount            types.Optional[GetBankAccountResponse]           `json:"default_bank_account"`
	GatewayRecipients             types.Optional[[]GetGatewayRecipientResponse]    `json:"gateway_recipients"`
	Metadata                      types.Optional[map[string]string]                `json:"metadata"`
	AutomaticAnticipationSettings types.Optional[GetAutomaticAnticipationResponse] `json:"automatic_anticipation_settings"`
	TransferSettings              types.Optional[GetTransferSettingsResponse]      `json:"transfer_settings"`
	Code                          types.Optional[string]                           `json:"code"`
	PaymentMode                   types.Optional[string]                           `json:"payment_mode"`
}

Recipient response

func (*GetRecipientResponse) MarshalJSON

func (g *GetRecipientResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetRecipientResponse) UnmarshalJSON

func (g *GetRecipientResponse) UnmarshalJSON(input []byte) error

type GetSafetyPayTransactionResponse

type GetSafetyPayTransactionResponse struct {
	GetTransactionResponse
	Url        types.Optional[string]    `json:"url"`
	BankTid    types.Optional[string]    `json:"bank_tid"`
	PaidAt     types.Optional[time.Time] `json:"paid_at"`
	PaidAmount types.Optional[int]       `json:"paid_amount"`
}

Response object for getting a safety pay transaction

func (*GetSafetyPayTransactionResponse) GetBankTid

Getter for bank_tid.

func (*GetSafetyPayTransactionResponse) GetPaidAmount

func (g *GetSafetyPayTransactionResponse) GetPaidAmount() types.Optional[int]

Getter for paid_amount.

func (*GetSafetyPayTransactionResponse) GetPaidAt

Getter for paid_at.

func (*GetSafetyPayTransactionResponse) GetUrl

Getter for url.

func (*GetSafetyPayTransactionResponse) MarshalJSON

func (g *GetSafetyPayTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetSafetyPayTransactionResponse) UnmarshalJSON

func (g *GetSafetyPayTransactionResponse) UnmarshalJSON(input []byte) error

type GetSafetyPayTransactionResponseField

type GetSafetyPayTransactionResponseField struct {
	GetSafetyPayTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetSafetyPayTransactionResponseField) UnmarshalJSON

func (g *GetSafetyPayTransactionResponseField) UnmarshalJSON(input []byte) error

type GetSafetyPayTransactionResponseInterface

type GetSafetyPayTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetUrl() types.Optional[string]
	GetBankTid() types.Optional[string]
	GetPaidAt() types.Optional[time.Time]
	GetPaidAmount() types.Optional[int]
}

Response object for getting a safety pay transaction

func ToGetSafetyPayTransactionResponseArray

func ToGetSafetyPayTransactionResponseArray(getSafetyPayTransactionResponse []GetSafetyPayTransactionResponseField) []GetSafetyPayTransactionResponseInterface

func UnmarshalGetSafetyPayTransactionResponse

func UnmarshalGetSafetyPayTransactionResponse(input []byte) (
	GetSafetyPayTransactionResponseInterface,
	error)

type GetSafetyPayTransactionResponseSlice

type GetSafetyPayTransactionResponseSlice struct {
	Slice []GetSafetyPayTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetSafetyPayTransactionResponseSlice) UnmarshalJSON

func (ga *GetSafetyPayTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetSetupResponse

type GetSetupResponse struct {
	Id          types.Optional[string] `json:"id"`
	Description types.Optional[string] `json:"description"`
	Amount      types.Optional[int]    `json:"amount"`
	Status      types.Optional[string] `json:"status"`
}

Response object for getting the setup from a subscription

func (*GetSetupResponse) MarshalJSON

func (g *GetSetupResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetSetupResponse) UnmarshalJSON

func (g *GetSetupResponse) UnmarshalJSON(input []byte) error

type GetShippingResponse

type GetShippingResponse struct {
	Amount                types.Optional[int]                `json:"amount"`
	Description           types.Optional[string]             `json:"description"`
	RecipientName         types.Optional[string]             `json:"recipient_name"`
	RecipientPhone        types.Optional[string]             `json:"recipient_phone"`
	Address               types.Optional[GetAddressResponse] `json:"address"`
	MaxDeliveryDate       types.Optional[time.Time]          `json:"max_delivery_date"`
	EstimatedDeliveryDate types.Optional[time.Time]          `json:"estimated_delivery_date"`
	Type                  types.Optional[string]             `json:"type"`
}

Response object for getting the shipping data

func (*GetShippingResponse) MarshalJSON

func (g *GetShippingResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetShippingResponse) UnmarshalJSON

func (g *GetShippingResponse) UnmarshalJSON(input []byte) error

type GetSplitOptionsResponse

type GetSplitOptionsResponse struct {
	Liable              types.Optional[bool]   `json:"liable"`
	ChargeProcessingFee types.Optional[bool]   `json:"charge_processing_fee"`
	ChargeRemainderFee  types.Optional[string] `json:"charge_remainder_fee"`
}

func (*GetSplitOptionsResponse) MarshalJSON

func (g *GetSplitOptionsResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetSplitOptionsResponse) UnmarshalJSON

func (g *GetSplitOptionsResponse) UnmarshalJSON(input []byte) error

type GetSplitResponse

type GetSplitResponse struct {
	Type      types.Optional[string]                  `json:"type"`
	Amount    types.Optional[int]                     `json:"amount"`
	Recipient types.Optional[GetRecipientResponse]    `json:"recipient"`
	GatewayId types.Optional[string]                  `json:"gateway_id"`
	Options   types.Optional[GetSplitOptionsResponse] `json:"options"`
	Id        types.Optional[string]                  `json:"id"`
}

Split response

func (*GetSplitResponse) MarshalJSON

func (g *GetSplitResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetSplitResponse) UnmarshalJSON

func (g *GetSplitResponse) UnmarshalJSON(input []byte) error

type GetSubscriptionBoletoResponse

type GetSubscriptionBoletoResponse struct {
	Interest            types.Optional[GetInterestResponse] `json:"interest"`
	Fine                types.Optional[GetFineResponse]     `json:"fine"`
	MaxDaysToPayPastDue types.Optional[int]                 `json:"max_days_to_pay_past_due"`
}

Response object for getting a boleto

func (*GetSubscriptionBoletoResponse) MarshalJSON

func (g *GetSubscriptionBoletoResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetSubscriptionBoletoResponse) UnmarshalJSON

func (g *GetSubscriptionBoletoResponse) UnmarshalJSON(input []byte) error

type GetSubscriptionItemResponse

type GetSubscriptionItemResponse struct {
	Id            types.Optional[string]                   `json:"id"`
	Description   types.Optional[string]                   `json:"description"`
	Status        types.Optional[string]                   `json:"status"`
	CreatedAt     types.Optional[time.Time]                `json:"created_at"`
	UpdatedAt     types.Optional[time.Time]                `json:"updated_at"`
	PricingScheme types.Optional[GetPricingSchemeResponse] `json:"pricing_scheme"`
	Discounts     types.Optional[[]GetDiscountResponse]    `json:"discounts"`
	Increments    types.Optional[[]GetIncrementResponse]   `json:"increments"`
	Subscription  types.Optional[GetSubscriptionResponse]  `json:"subscription"`
	Name          types.Optional[string]                   `json:"name"`
	Quantity      types.Optional[int]                      `json:"quantity"`
	Cycles        types.Optional[int]                      `json:"cycles"`
	DeletedAt     types.Optional[time.Time]                `json:"deleted_at"`
}

func (*GetSubscriptionItemResponse) MarshalJSON

func (g *GetSubscriptionItemResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetSubscriptionItemResponse) UnmarshalJSON

func (g *GetSubscriptionItemResponse) UnmarshalJSON(input []byte) error

type GetSubscriptionResponse

type GetSubscriptionResponse struct {
	Id                   types.Optional[string]                        `json:"id"`
	Code                 types.Optional[string]                        `json:"code"`
	StartAt              types.Optional[time.Time]                     `json:"start_at"`
	Interval             types.Optional[string]                        `json:"interval"`
	IntervalCount        types.Optional[int]                           `json:"interval_count"`
	BillingType          types.Optional[string]                        `json:"billing_type"`
	CurrentCycle         types.Optional[GetPeriodResponse]             `json:"current_cycle"`
	PaymentMethod        types.Optional[string]                        `json:"payment_method"`
	Currency             types.Optional[string]                        `json:"currency"`
	Installments         types.Optional[int]                           `json:"installments"`
	Status               types.Optional[string]                        `json:"status"`
	CreatedAt            types.Optional[time.Time]                     `json:"created_at"`
	UpdatedAt            types.Optional[time.Time]                     `json:"updated_at"`
	Customer             types.Optional[GetCustomerResponse]           `json:"customer"`
	Card                 types.Optional[GetCardResponse]               `json:"card"`
	Items                types.Optional[[]GetSubscriptionItemResponse] `json:"items"`
	StatementDescriptor  types.Optional[string]                        `json:"statement_descriptor"`
	Metadata             types.Optional[map[string]string]             `json:"metadata"`
	Setup                types.Optional[GetSetupResponse]              `json:"setup"`
	GatewayAffiliationId types.Optional[string]                        `json:"gateway_affiliation_id"`
	NextBillingAt        types.Optional[time.Time]                     `json:"next_billing_at"`
	BillingDay           types.Optional[int]                           `json:"billing_day"`
	MinimumPrice         types.Optional[int]                           `json:"minimum_price"`
	CanceledAt           types.Optional[time.Time]                     `json:"canceled_at"`
	Discounts            types.Optional[[]GetDiscountResponse]         `json:"discounts"`
	Increments           types.Optional[[]GetIncrementResponse]        `json:"increments"`
	BoletoDueDays        types.Optional[int]                           `json:"boleto_due_days"`
	Split                types.Optional[GetSubscriptionSplitResponse]  `json:"split"`
	Boleto               types.Optional[GetSubscriptionBoletoResponse] `json:"boleto"`
	ManualBilling        types.Optional[bool]                          `json:"manual_billing"`
}

func (*GetSubscriptionResponse) MarshalJSON

func (g *GetSubscriptionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetSubscriptionResponse) UnmarshalJSON

func (g *GetSubscriptionResponse) UnmarshalJSON(input []byte) error

type GetSubscriptionSplitResponse

type GetSubscriptionSplitResponse struct {
	Enabled types.Optional[bool]               `json:"enabled"`
	Rules   types.Optional[[]GetSplitResponse] `json:"rules"`
}

func (*GetSubscriptionSplitResponse) MarshalJSON

func (g *GetSubscriptionSplitResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetSubscriptionSplitResponse) UnmarshalJSON

func (g *GetSubscriptionSplitResponse) UnmarshalJSON(input []byte) error

type GetThreeDSecureResponse

type GetThreeDSecureResponse struct {
	Mpi           types.Optional[string] `json:"mpi"`
	Eci           types.Optional[string] `json:"eci"`
	Cavv          types.Optional[string] `json:"cavv"`
	TransactionId types.Optional[string] `json:"transaction_Id"`
	SuccessUrl    types.Optional[string] `json:"success_url"`
}

3D-S payment authentication response

func (*GetThreeDSecureResponse) MarshalJSON

func (g *GetThreeDSecureResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetThreeDSecureResponse) UnmarshalJSON

func (g *GetThreeDSecureResponse) UnmarshalJSON(input []byte) error

type GetTokenResponse

type GetTokenResponse struct {
	Id        types.Optional[string]               `json:"id"`
	Type      types.Optional[string]               `json:"type"`
	CreatedAt types.Optional[time.Time]            `json:"created_at"`
	ExpiresAt types.Optional[string]               `json:"expires_at"`
	Card      types.Optional[GetCardTokenResponse] `json:"card"`
}

Token data

func (*GetTokenResponse) MarshalJSON

func (g *GetTokenResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetTokenResponse) UnmarshalJSON

func (g *GetTokenResponse) UnmarshalJSON(input []byte) error

type GetTransactionReportFileResponse

type GetTransactionReportFileResponse struct {
	Name types.Optional[string]    `json:"name"`
	Date types.Optional[time.Time] `json:"date"`
}

func (*GetTransactionReportFileResponse) MarshalJSON

func (g *GetTransactionReportFileResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetTransactionReportFileResponse) UnmarshalJSON

func (g *GetTransactionReportFileResponse) UnmarshalJSON(input []byte) error

type GetTransactionResponse

type GetTransactionResponse struct {
	GatewayId           types.Optional[string]                     `json:"gateway_id"`
	Amount              types.Optional[int]                        `json:"amount"`
	Status              types.Optional[string]                     `json:"status"`
	Success             types.Optional[bool]                       `json:"success"`
	CreatedAt           types.Optional[time.Time]                  `json:"created_at"`
	UpdatedAt           types.Optional[time.Time]                  `json:"updated_at"`
	AttemptCount        types.Optional[int]                        `json:"attempt_count"`
	MaxAttempts         types.Optional[int]                        `json:"max_attempts"`
	Splits              types.Optional[[]GetSplitResponse]         `json:"splits"`
	NextAttempt         types.Optional[time.Time]                  `json:"next_attempt"`
	TransactionType     *string                                    `json:"transaction_type,omitempty"`
	Id                  types.Optional[string]                     `json:"id"`
	GatewayResponse     types.Optional[GetGatewayResponseResponse] `json:"gateway_response"`
	AntifraudResponse   types.Optional[GetAntifraudResponse]       `json:"antifraud_response"`
	Metadata            types.Optional[map[string]string]          `json:"metadata"`
	Split               types.Optional[[]GetSplitResponse]         `json:"split"`
	Interest            types.Optional[GetInterestResponse]        `json:"interest"`
	Fine                types.Optional[GetFineResponse]            `json:"fine"`
	MaxDaysToPayPastDue types.Optional[int]                        `json:"max_days_to_pay_past_due"`
}

Generic response object for getting a transaction.

func (*GetTransactionResponse) GetAmount

func (g *GetTransactionResponse) GetAmount() types.Optional[int]

Getter for amount.

func (*GetTransactionResponse) GetAntifraudResponse

func (g *GetTransactionResponse) GetAntifraudResponse() types.Optional[GetAntifraudResponse]

Getter for antifraud_response.

func (*GetTransactionResponse) GetAttemptCount

func (g *GetTransactionResponse) GetAttemptCount() types.Optional[int]

Getter for attempt_count.

func (*GetTransactionResponse) GetCreatedAt

func (g *GetTransactionResponse) GetCreatedAt() types.Optional[time.Time]

Getter for created_at.

func (*GetTransactionResponse) GetFine

Getter for fine.

func (*GetTransactionResponse) GetGatewayId

func (g *GetTransactionResponse) GetGatewayId() types.Optional[string]

Getter for gateway_id.

func (*GetTransactionResponse) GetGatewayResponse

Getter for gateway_response.

func (*GetTransactionResponse) GetId

Getter for id.

func (*GetTransactionResponse) GetInterest

Getter for interest.

func (*GetTransactionResponse) GetMaxAttempts

func (g *GetTransactionResponse) GetMaxAttempts() types.Optional[int]

Getter for max_attempts.

func (*GetTransactionResponse) GetMaxDaysToPayPastDue

func (g *GetTransactionResponse) GetMaxDaysToPayPastDue() types.Optional[int]

Getter for max_days_to_pay_past_due.

func (*GetTransactionResponse) GetMetadata

func (g *GetTransactionResponse) GetMetadata() types.Optional[map[string]string]

Getter for metadata.

func (*GetTransactionResponse) GetNextAttempt

func (g *GetTransactionResponse) GetNextAttempt() types.Optional[time.Time]

Getter for next_attempt.

func (*GetTransactionResponse) GetSplit

Getter for split.

func (*GetTransactionResponse) GetSplits

Getter for splits.

func (*GetTransactionResponse) GetStatus

func (g *GetTransactionResponse) GetStatus() types.Optional[string]

Getter for status.

func (*GetTransactionResponse) GetSuccess

func (g *GetTransactionResponse) GetSuccess() types.Optional[bool]

Getter for success.

func (*GetTransactionResponse) GetTransactionType

func (g *GetTransactionResponse) GetTransactionType() *string

Getter for transaction_type.

func (*GetTransactionResponse) GetUpdatedAt

func (g *GetTransactionResponse) GetUpdatedAt() types.Optional[time.Time]

Getter for updated_at.

func (*GetTransactionResponse) MarshalJSON

func (g *GetTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetTransactionResponse) UnmarshalJSON

func (g *GetTransactionResponse) UnmarshalJSON(input []byte) error

type GetTransactionResponseField

type GetTransactionResponseField struct {
	GetTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetTransactionResponseField) UnmarshalJSON

func (g *GetTransactionResponseField) UnmarshalJSON(input []byte) error

type GetTransactionResponseInterface

type GetTransactionResponseInterface interface {
	GetGatewayId() types.Optional[string]
	GetAmount() types.Optional[int]
	GetStatus() types.Optional[string]
	GetSuccess() types.Optional[bool]
	GetCreatedAt() types.Optional[time.Time]
	GetUpdatedAt() types.Optional[time.Time]
	GetAttemptCount() types.Optional[int]
	GetMaxAttempts() types.Optional[int]
	GetSplits() types.Optional[[]GetSplitResponse]
	GetNextAttempt() types.Optional[time.Time]
	GetTransactionType() *string
	GetId() types.Optional[string]
	GetGatewayResponse() types.Optional[GetGatewayResponseResponse]
	GetAntifraudResponse() types.Optional[GetAntifraudResponse]
	GetMetadata() types.Optional[map[string]string]
	GetSplit() types.Optional[[]GetSplitResponse]
	GetInterest() types.Optional[GetInterestResponse]
	GetFine() types.Optional[GetFineResponse]
	GetMaxDaysToPayPastDue() types.Optional[int]
}

Generic response object for getting a transaction.

func ToGetTransactionResponseArray

func ToGetTransactionResponseArray(getTransactionResponse []GetTransactionResponseField) []GetTransactionResponseInterface

func UnmarshalGetTransactionResponse

func UnmarshalGetTransactionResponse(input []byte) (
	GetTransactionResponseInterface,
	error)

type GetTransactionResponseSlice

type GetTransactionResponseSlice struct {
	Slice []GetTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetTransactionResponseSlice) UnmarshalJSON

func (ga *GetTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetTransfer

type GetTransfer struct {
	Id                   string                    `json:"id"`
	GatewayId            string                    `json:"gateway_id"`
	Amount               int                       `json:"amount"`
	Status               string                    `json:"status"`
	CreatedAt            time.Time                 `json:"created_at"`
	UpdatedAt            time.Time                 `json:"updated_at"`
	Metadata             map[string]*string        `json:"metadata,omitempty"`
	Fee                  *int                      `json:"fee,omitempty"`
	FundingDate          *time.Time                `json:"funding_date,omitempty"`
	FundingEstimatedDate *time.Time                `json:"funding_estimated_date,omitempty"`
	Type                 string                    `json:"type"`
	Source               GetTransferSourceResponse `json:"source"`
	Target               GetTransferTargetResponse `json:"target"`
}

func (*GetTransfer) MarshalJSON

func (g *GetTransfer) MarshalJSON() (
	[]byte,
	error)

func (*GetTransfer) UnmarshalJSON

func (g *GetTransfer) UnmarshalJSON(input []byte) error

type GetTransferResponse

type GetTransferResponse struct {
	Id          types.Optional[string]                 `json:"id"`
	Amount      types.Optional[int]                    `json:"amount"`
	Status      types.Optional[string]                 `json:"status"`
	CreatedAt   types.Optional[time.Time]              `json:"created_at"`
	UpdatedAt   types.Optional[time.Time]              `json:"updated_at"`
	BankAccount types.Optional[GetBankAccountResponse] `json:"bank_account"`
	Metadata    types.Optional[map[string]string]      `json:"metadata"`
}

Transfer response

func (*GetTransferResponse) MarshalJSON

func (g *GetTransferResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetTransferResponse) UnmarshalJSON

func (g *GetTransferResponse) UnmarshalJSON(input []byte) error

type GetTransferSettingsResponse

type GetTransferSettingsResponse struct {
	TransferEnabled  types.Optional[bool]   `json:"transfer_enabled"`
	TransferInterval types.Optional[string] `json:"transfer_interval"`
	TransferDay      types.Optional[int]    `json:"transfer_day"`
}

func (*GetTransferSettingsResponse) MarshalJSON

func (g *GetTransferSettingsResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetTransferSettingsResponse) UnmarshalJSON

func (g *GetTransferSettingsResponse) UnmarshalJSON(input []byte) error

type GetTransferSourceResponse

type GetTransferSourceResponse struct {
	SourceId types.Optional[string] `json:"source_id"`
	Type     types.Optional[string] `json:"type"`
}

func (*GetTransferSourceResponse) MarshalJSON

func (g *GetTransferSourceResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetTransferSourceResponse) UnmarshalJSON

func (g *GetTransferSourceResponse) UnmarshalJSON(input []byte) error

type GetTransferTargetResponse

type GetTransferTargetResponse struct {
	TargetId types.Optional[string] `json:"target_id"`
	Type     types.Optional[string] `json:"type"`
}

func (*GetTransferTargetResponse) MarshalJSON

func (g *GetTransferTargetResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetTransferTargetResponse) UnmarshalJSON

func (g *GetTransferTargetResponse) UnmarshalJSON(input []byte) error

type GetUsageReportResponse

type GetUsageReportResponse struct {
	Url              types.Optional[string] `json:"url"`
	UsageReportUrl   types.Optional[string] `json:"usage_report_url"`
	GroupedReportUrl types.Optional[string] `json:"grouped_report_url"`
}

func (*GetUsageReportResponse) MarshalJSON

func (g *GetUsageReportResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetUsageReportResponse) UnmarshalJSON

func (g *GetUsageReportResponse) UnmarshalJSON(input []byte) error

type GetUsageResponse

type GetUsageResponse struct {
	Id               types.Optional[string]                      `json:"id"`
	Quantity         types.Optional[int]                         `json:"quantity"`
	Description      types.Optional[string]                      `json:"description"`
	UsedAt           types.Optional[time.Time]                   `json:"used_at"`
	CreatedAt        types.Optional[time.Time]                   `json:"created_at"`
	Status           types.Optional[string]                      `json:"status"`
	DeletedAt        types.Optional[time.Time]                   `json:"deleted_at"`
	SubscriptionItem types.Optional[GetSubscriptionItemResponse] `json:"subscription_item"`
	Code             types.Optional[string]                      `json:"code"`
	Group            types.Optional[string]                      `json:"group"`
	Amount           types.Optional[int]                         `json:"amount"`
}

Response object for getting a usage

func (*GetUsageResponse) MarshalJSON

func (g *GetUsageResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetUsageResponse) UnmarshalJSON

func (g *GetUsageResponse) UnmarshalJSON(input []byte) error

type GetVoucherTransactionResponse

type GetVoucherTransactionResponse struct {
	GetTransactionResponse
	StatementDescriptor     types.Optional[string]          `json:"statement_descriptor"`
	AcquirerName            types.Optional[string]          `json:"acquirer_name"`
	AcquirerAffiliationCode types.Optional[string]          `json:"acquirer_affiliation_code"`
	AcquirerTid             types.Optional[string]          `json:"acquirer_tid"`
	AcquirerNsu             types.Optional[string]          `json:"acquirer_nsu"`
	AcquirerAuthCode        types.Optional[string]          `json:"acquirer_auth_code"`
	AcquirerMessage         types.Optional[string]          `json:"acquirer_message"`
	AcquirerReturnCode      types.Optional[string]          `json:"acquirer_return_code"`
	OperationType           types.Optional[string]          `json:"operation_type"`
	Card                    types.Optional[GetCardResponse] `json:"card"`
}

Response for voucher transactions

func (*GetVoucherTransactionResponse) GetAcquirerAffiliationCode

func (g *GetVoucherTransactionResponse) GetAcquirerAffiliationCode() types.Optional[string]

Getter for acquirer_affiliation_code.

func (*GetVoucherTransactionResponse) GetAcquirerAuthCode

func (g *GetVoucherTransactionResponse) GetAcquirerAuthCode() types.Optional[string]

Getter for acquirer_auth_code.

func (*GetVoucherTransactionResponse) GetAcquirerMessage

func (g *GetVoucherTransactionResponse) GetAcquirerMessage() types.Optional[string]

Getter for acquirer_message.

func (*GetVoucherTransactionResponse) GetAcquirerName

func (g *GetVoucherTransactionResponse) GetAcquirerName() types.Optional[string]

Getter for acquirer_name.

func (*GetVoucherTransactionResponse) GetAcquirerNsu

func (g *GetVoucherTransactionResponse) GetAcquirerNsu() types.Optional[string]

Getter for acquirer_nsu.

func (*GetVoucherTransactionResponse) GetAcquirerReturnCode

func (g *GetVoucherTransactionResponse) GetAcquirerReturnCode() types.Optional[string]

Getter for acquirer_return_code.

func (*GetVoucherTransactionResponse) GetAcquirerTid

func (g *GetVoucherTransactionResponse) GetAcquirerTid() types.Optional[string]

Getter for acquirer_tid.

func (*GetVoucherTransactionResponse) GetCard

Getter for card.

func (*GetVoucherTransactionResponse) GetOperationType

func (g *GetVoucherTransactionResponse) GetOperationType() types.Optional[string]

Getter for operation_type.

func (*GetVoucherTransactionResponse) GetStatementDescriptor

func (g *GetVoucherTransactionResponse) GetStatementDescriptor() types.Optional[string]

Getter for statement_descriptor.

func (*GetVoucherTransactionResponse) MarshalJSON

func (g *GetVoucherTransactionResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetVoucherTransactionResponse) UnmarshalJSON

func (g *GetVoucherTransactionResponse) UnmarshalJSON(input []byte) error

type GetVoucherTransactionResponseField

type GetVoucherTransactionResponseField struct {
	GetVoucherTransactionResponseInterface
}

Utility struct that helps the go JSON deserializer to invoke the proper deserialization logic.

func (*GetVoucherTransactionResponseField) UnmarshalJSON

func (g *GetVoucherTransactionResponseField) UnmarshalJSON(input []byte) error

type GetVoucherTransactionResponseInterface

type GetVoucherTransactionResponseInterface interface {
	GetTransactionResponseInterface
	GetStatementDescriptor() types.Optional[string]
	GetAcquirerName() types.Optional[string]
	GetAcquirerAffiliationCode() types.Optional[string]
	GetAcquirerTid() types.Optional[string]
	GetAcquirerNsu() types.Optional[string]
	GetAcquirerAuthCode() types.Optional[string]
	GetAcquirerMessage() types.Optional[string]
	GetAcquirerReturnCode() types.Optional[string]
	GetOperationType() types.Optional[string]
	GetCard() types.Optional[GetCardResponse]
}

Response for voucher transactions

func ToGetVoucherTransactionResponseArray

func ToGetVoucherTransactionResponseArray(getVoucherTransactionResponse []GetVoucherTransactionResponseField) []GetVoucherTransactionResponseInterface

func UnmarshalGetVoucherTransactionResponse

func UnmarshalGetVoucherTransactionResponse(input []byte) (
	GetVoucherTransactionResponseInterface,
	error)

type GetVoucherTransactionResponseSlice

type GetVoucherTransactionResponseSlice struct {
	Slice []GetVoucherTransactionResponseInterface
}

Utility struct that helps in the unmarshalling of slices.

func (*GetVoucherTransactionResponseSlice) UnmarshalJSON

func (ga *GetVoucherTransactionResponseSlice) UnmarshalJSON(input []byte) error

type GetWithdrawResponse

type GetWithdrawResponse struct {
	Id                   types.Optional[string]                    `json:"id"`
	GatewayId            types.Optional[string]                    `json:"gateway_id"`
	Amount               types.Optional[int]                       `json:"amount"`
	Status               types.Optional[string]                    `json:"status"`
	CreatedAt            types.Optional[time.Time]                 `json:"created_at"`
	UpdatedAt            types.Optional[time.Time]                 `json:"updated_at"`
	Metadata             types.Optional[[]string]                  `json:"metadata"`
	Fee                  types.Optional[int]                       `json:"fee"`
	FundingDate          types.Optional[time.Time]                 `json:"funding_date"`
	FundingEstimatedDate types.Optional[time.Time]                 `json:"funding_estimated_date"`
	Type                 types.Optional[string]                    `json:"type"`
	Source               types.Optional[GetWithdrawSourceResponse] `json:"source"`
	Target               types.Optional[GetWithdrawTargetResponse] `json:"target"`
}

func (*GetWithdrawResponse) MarshalJSON

func (g *GetWithdrawResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetWithdrawResponse) UnmarshalJSON

func (g *GetWithdrawResponse) UnmarshalJSON(input []byte) error

type GetWithdrawSourceResponse

type GetWithdrawSourceResponse struct {
	SourceId types.Optional[string] `json:"source_id"`
	Type     types.Optional[string] `json:"type"`
}

func (*GetWithdrawSourceResponse) MarshalJSON

func (g *GetWithdrawSourceResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetWithdrawSourceResponse) UnmarshalJSON

func (g *GetWithdrawSourceResponse) UnmarshalJSON(input []byte) error

type GetWithdrawTargetResponse

type GetWithdrawTargetResponse struct {
	TargetId types.Optional[string] `json:"target_id"`
	Type     types.Optional[string] `json:"type"`
}

func (*GetWithdrawTargetResponse) MarshalJSON

func (g *GetWithdrawTargetResponse) MarshalJSON() (
	[]byte,
	error)

func (*GetWithdrawTargetResponse) UnmarshalJSON

func (g *GetWithdrawTargetResponse) UnmarshalJSON(input []byte) error

type ListAccessTokensResponse

type ListAccessTokensResponse struct {
	Data   types.Optional[[]GetAccessTokenResponse] `json:"data"`
	Paging types.Optional[PagingResponse]           `json:"paging"`
}

Response object for listing access tokens

func (*ListAccessTokensResponse) MarshalJSON

func (l *ListAccessTokensResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListAccessTokensResponse) UnmarshalJSON

func (l *ListAccessTokensResponse) UnmarshalJSON(input []byte) error

type ListAddressesResponse

type ListAddressesResponse struct {
	Data   types.Optional[[]GetAddressResponse] `json:"data"`
	Paging types.Optional[PagingResponse]       `json:"paging"`
}

Response object for listing addresses

func (*ListAddressesResponse) MarshalJSON

func (l *ListAddressesResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListAddressesResponse) UnmarshalJSON

func (l *ListAddressesResponse) UnmarshalJSON(input []byte) error

type ListAnticipationResponse

type ListAnticipationResponse struct {
	Data   types.Optional[[]GetAnticipationResponse] `json:"data"`
	Paging types.Optional[PagingResponse]            `json:"paging"`
}

Anticipations

func (*ListAnticipationResponse) MarshalJSON

func (l *ListAnticipationResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListAnticipationResponse) UnmarshalJSON

func (l *ListAnticipationResponse) UnmarshalJSON(input []byte) error

type ListBalanceOperationResponse

type ListBalanceOperationResponse struct {
	Data   types.Optional[[]GetBalanceOperationResponse] `json:"data"`
	Paging types.Optional[PagingResponse]                `json:"paging"`
}

Response object for listing BalanceOperation objects

func (*ListBalanceOperationResponse) MarshalJSON

func (l *ListBalanceOperationResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListBalanceOperationResponse) UnmarshalJSON

func (l *ListBalanceOperationResponse) UnmarshalJSON(input []byte) error

type ListCardsResponse

type ListCardsResponse struct {
	Data   types.Optional[[]GetCardResponse] `json:"data"`
	Paging types.Optional[PagingResponse]    `json:"paging"`
}

Response object for listing cards

func (*ListCardsResponse) MarshalJSON

func (l *ListCardsResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListCardsResponse) UnmarshalJSON

func (l *ListCardsResponse) UnmarshalJSON(input []byte) error

type ListChargeTransactionsResponse

type ListChargeTransactionsResponse struct {
	Data   types.Optional[[]GetTransactionResponseInterface] `json:"data"`
	Paging types.Optional[PagingResponse]                    `json:"paging"`
}

Response object for listing charge transactions

func (*ListChargeTransactionsResponse) MarshalJSON

func (l *ListChargeTransactionsResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListChargeTransactionsResponse) UnmarshalJSON

func (l *ListChargeTransactionsResponse) UnmarshalJSON(input []byte) error

type ListChargeTransactionsResponseInterface

type ListChargeTransactionsResponseInterface interface {
	GetData() types.Optional[[]GetTransactionResponseInterface]
	GetPaging() types.Optional[PagingResponse]
}

Response object for listing charge transactions

type ListChargesResponse

type ListChargesResponse struct {
	Data   types.Optional[[]GetChargeResponse] `json:"data"`
	Paging types.Optional[PagingResponse]      `json:"paging"`
}

Response object for listing charges

func (*ListChargesResponse) MarshalJSON

func (l *ListChargesResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListChargesResponse) UnmarshalJSON

func (l *ListChargesResponse) UnmarshalJSON(input []byte) error

type ListCustomersResponse

type ListCustomersResponse struct {
	Data   types.Optional[[]GetCustomerResponse] `json:"data"`
	Paging types.Optional[PagingResponse]        `json:"paging"`
}

Response for listing the customers

func (*ListCustomersResponse) MarshalJSON

func (l *ListCustomersResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListCustomersResponse) UnmarshalJSON

func (l *ListCustomersResponse) UnmarshalJSON(input []byte) error

type ListCyclesResponse

type ListCyclesResponse struct {
	Data   types.Optional[[]GetPeriodResponse] `json:"data"`
	Paging types.Optional[PagingResponse]      `json:"paging"`
}

Response object for listing subscription cycles

func (*ListCyclesResponse) MarshalJSON

func (l *ListCyclesResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListCyclesResponse) UnmarshalJSON

func (l *ListCyclesResponse) UnmarshalJSON(input []byte) error

type ListDiscountsResponse

type ListDiscountsResponse struct {
	Data   types.Optional[[]GetDiscountResponse] `json:"data"`
	Paging types.Optional[PagingResponse]        `json:"paging"`
}

func (*ListDiscountsResponse) MarshalJSON

func (l *ListDiscountsResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListDiscountsResponse) UnmarshalJSON

func (l *ListDiscountsResponse) UnmarshalJSON(input []byte) error

type ListIncrementsResponse

type ListIncrementsResponse struct {
	Data   types.Optional[[]GetIncrementResponse] `json:"data"`
	Paging types.Optional[PagingResponse]         `json:"paging"`
}

func (*ListIncrementsResponse) MarshalJSON

func (l *ListIncrementsResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListIncrementsResponse) UnmarshalJSON

func (l *ListIncrementsResponse) UnmarshalJSON(input []byte) error

type ListInvoicesResponse

type ListInvoicesResponse struct {
	Data   types.Optional[[]GetInvoiceResponse] `json:"data"`
	Paging types.Optional[PagingResponse]       `json:"paging"`
}

Response object for listing invoices

func (*ListInvoicesResponse) MarshalJSON

func (l *ListInvoicesResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListInvoicesResponse) UnmarshalJSON

func (l *ListInvoicesResponse) UnmarshalJSON(input []byte) error

type ListOrderResponse

type ListOrderResponse struct {
	Data   types.Optional[[]GetOrderResponse] `json:"data"`
	Paging types.Optional[PagingResponse]     `json:"paging"`
}

Response object for listing order objects

func (*ListOrderResponse) MarshalJSON

func (l *ListOrderResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListOrderResponse) UnmarshalJSON

func (l *ListOrderResponse) UnmarshalJSON(input []byte) error

type ListPayablesResponse

type ListPayablesResponse struct {
	Data   types.Optional[[]GetPayableResponse] `json:"data"`
	Paging types.Optional[PagingResponse]       `json:"paging"`
}

Response object for listing payable objects

func (*ListPayablesResponse) MarshalJSON

func (l *ListPayablesResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListPayablesResponse) UnmarshalJSON

func (l *ListPayablesResponse) UnmarshalJSON(input []byte) error

type ListPlansResponse

type ListPlansResponse struct {
	Data   types.Optional[[]GetPlanResponse] `json:"data"`
	Paging types.Optional[PagingResponse]    `json:"paging"`
}

Response object for listing plans

func (*ListPlansResponse) MarshalJSON

func (l *ListPlansResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListPlansResponse) UnmarshalJSON

func (l *ListPlansResponse) UnmarshalJSON(input []byte) error

type ListRecipientResponse

type ListRecipientResponse struct {
	Data   types.Optional[[]GetRecipientResponse] `json:"data"`
	Paging types.Optional[PagingResponse]         `json:"paging"`
}

Response for the listing recipient method

func (*ListRecipientResponse) MarshalJSON

func (l *ListRecipientResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListRecipientResponse) UnmarshalJSON

func (l *ListRecipientResponse) UnmarshalJSON(input []byte) error

type ListSubscriptionItemsResponse

type ListSubscriptionItemsResponse struct {
	Data   types.Optional[[]GetSubscriptionItemResponse] `json:"data"`
	Paging types.Optional[PagingResponse]                `json:"paging"`
}

Response model for listing subscription items

func (*ListSubscriptionItemsResponse) MarshalJSON

func (l *ListSubscriptionItemsResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListSubscriptionItemsResponse) UnmarshalJSON

func (l *ListSubscriptionItemsResponse) UnmarshalJSON(input []byte) error

type ListSubscriptionsResponse

type ListSubscriptionsResponse struct {
	Data   types.Optional[[]GetSubscriptionResponse] `json:"data"`
	Paging types.Optional[PagingResponse]            `json:"paging"`
}

Response object for listing subscriptions

func (*ListSubscriptionsResponse) MarshalJSON

func (l *ListSubscriptionsResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListSubscriptionsResponse) UnmarshalJSON

func (l *ListSubscriptionsResponse) UnmarshalJSON(input []byte) error

type ListTransactionsFilesResponse

type ListTransactionsFilesResponse struct {
	Data   types.Optional[[]GetTransactionReportFileResponse] `json:"data"`
	Paging types.Optional[PagingResponse]                     `json:"paging"`
}

Response object for listing of transactions files

func (*ListTransactionsFilesResponse) MarshalJSON

func (l *ListTransactionsFilesResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListTransactionsFilesResponse) UnmarshalJSON

func (l *ListTransactionsFilesResponse) UnmarshalJSON(input []byte) error

type ListTransactionsResponse

type ListTransactionsResponse struct {
	Data   types.Optional[[]GetTransactionResponseInterface] `json:"data"`
	Paging types.Optional[PagingResponse]                    `json:"paging"`
}

Response object for listing transactions

func (*ListTransactionsResponse) MarshalJSON

func (l *ListTransactionsResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListTransactionsResponse) UnmarshalJSON

func (l *ListTransactionsResponse) UnmarshalJSON(input []byte) error

type ListTransactionsResponseInterface

type ListTransactionsResponseInterface interface {
	GetData() types.Optional[[]GetTransactionResponseInterface]
	GetPaging() types.Optional[PagingResponse]
}

Response object for listing transactions

type ListTransferResponse

type ListTransferResponse struct {
	Data   types.Optional[[]GetTransferResponse] `json:"data"`
	Paging types.Optional[PagingResponse]        `json:"paging"`
}

List of paginated transfer objects

func (*ListTransferResponse) MarshalJSON

func (l *ListTransferResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListTransferResponse) UnmarshalJSON

func (l *ListTransferResponse) UnmarshalJSON(input []byte) error

type ListTransfers

type ListTransfers struct {
	Data   []GetTransfer  `json:"data"`
	Paging PagingResponse `json:"paging"`
}

func (*ListTransfers) MarshalJSON

func (l *ListTransfers) MarshalJSON() (
	[]byte,
	error)

func (*ListTransfers) UnmarshalJSON

func (l *ListTransfers) UnmarshalJSON(input []byte) error

type ListUsagesResponse

type ListUsagesResponse struct {
	Data   types.Optional[[]GetUsageResponse] `json:"data"`
	Paging types.Optional[PagingResponse]     `json:"paging"`
}

Response model for listing the usages from a subscription item

func (*ListUsagesResponse) MarshalJSON

func (l *ListUsagesResponse) MarshalJSON() (
	[]byte,
	error)

func (*ListUsagesResponse) UnmarshalJSON

func (l *ListUsagesResponse) UnmarshalJSON(input []byte) error

type ListWithdrawals

type ListWithdrawals struct {
	Data   []GetWithdrawResponse `json:"data"`
	Paging PagingResponse        `json:"paging"`
}

func (*ListWithdrawals) MarshalJSON

func (l *ListWithdrawals) MarshalJSON() (
	[]byte,
	error)

func (*ListWithdrawals) UnmarshalJSON

func (l *ListWithdrawals) UnmarshalJSON(input []byte) error

type PagingResponse

type PagingResponse struct {
	Total    types.Optional[int]    `json:"total"`
	Previous types.Optional[string] `json:"previous"`
	Next     types.Optional[string] `json:"next"`
}

Object used for returning lists of objects with pagination

func (*PagingResponse) MarshalJSON

func (p *PagingResponse) MarshalJSON() (
	[]byte,
	error)

func (*PagingResponse) UnmarshalJSON

func (p *PagingResponse) UnmarshalJSON(input []byte) error

type PixAdditionalInformation

type PixAdditionalInformation struct {
	Name  types.Optional[string] `json:"Name"`
	Value types.Optional[string] `json:"Value"`
}

Pix Additional Information

func (*PixAdditionalInformation) MarshalJSON

func (p *PixAdditionalInformation) MarshalJSON() (
	[]byte,
	error)

func (*PixAdditionalInformation) UnmarshalJSON

func (p *PixAdditionalInformation) UnmarshalJSON(input []byte) error

type UpdateAddressRequest

type UpdateAddressRequest struct {
	Number     string            `json:"number"`
	Complement string            `json:"complement"`
	Metadata   map[string]string `json:"metadata"`
	Line2      string            `json:"line_2"`
}

Request for updating an address

func (*UpdateAddressRequest) MarshalJSON

func (u *UpdateAddressRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateAddressRequest) UnmarshalJSON

func (u *UpdateAddressRequest) UnmarshalJSON(input []byte) error

type UpdateAutomaticAnticipationSettingsRequest

type UpdateAutomaticAnticipationSettingsRequest struct {
	Enabled          *bool   `json:"enabled,omitempty"`
	Type             *string `json:"type,omitempty"`
	VolumePercentage *int    `json:"volume_percentage,omitempty"`
	Delay            *int    `json:"delay,omitempty"`
	Days             *int    `json:"days,omitempty"`
}

func (*UpdateAutomaticAnticipationSettingsRequest) MarshalJSON

func (u *UpdateAutomaticAnticipationSettingsRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateAutomaticAnticipationSettingsRequest) UnmarshalJSON

func (u *UpdateAutomaticAnticipationSettingsRequest) UnmarshalJSON(input []byte) error

type UpdateCardRequest

type UpdateCardRequest struct {
	HolderName       string                 `json:"holder_name"`
	ExpMonth         int                    `json:"exp_month"`
	ExpYear          int                    `json:"exp_year"`
	BillingAddressId types.Optional[string] `json:"billing_address_id"`
	BillingAddress   CreateAddressRequest   `json:"billing_address"`
	Metadata         map[string]string      `json:"metadata"`
	Label            string                 `json:"label"`
}

Request for updating a card

func (*UpdateCardRequest) MarshalJSON

func (u *UpdateCardRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateCardRequest) UnmarshalJSON

func (u *UpdateCardRequest) UnmarshalJSON(input []byte) error

type UpdateChargeCardRequest

type UpdateChargeCardRequest struct {
	UpdateSubscription bool              `json:"update_subscription"`
	CardId             string            `json:"card_id"`
	Card               CreateCardRequest `json:"card"`
	Recurrence         bool              `json:"recurrence"`
}

Request for updating card data

func (*UpdateChargeCardRequest) MarshalJSON

func (u *UpdateChargeCardRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateChargeCardRequest) UnmarshalJSON

func (u *UpdateChargeCardRequest) UnmarshalJSON(input []byte) error

type UpdateChargeDueDateRequest

type UpdateChargeDueDateRequest struct {
	DueAt *time.Time `json:"due_at,omitempty"`
}

Request for updating a charge due date

func (*UpdateChargeDueDateRequest) MarshalJSON

func (u *UpdateChargeDueDateRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateChargeDueDateRequest) UnmarshalJSON

func (u *UpdateChargeDueDateRequest) UnmarshalJSON(input []byte) error

type UpdateChargePaymentMethodRequest

type UpdateChargePaymentMethodRequest struct {
	UpdateSubscription bool                             `json:"update_subscription"`
	PaymentMethod      string                           `json:"payment_method"`
	CreditCard         CreateCreditCardPaymentRequest   `json:"credit_card"`
	DebitCard          CreateDebitCardPaymentRequest    `json:"debit_card"`
	Boleto             CreateBoletoPaymentRequest       `json:"boleto"`
	Voucher            CreateVoucherPaymentRequest      `json:"voucher"`
	Cash               CreateCashPaymentRequest         `json:"cash"`
	BankTransfer       CreateBankTransferPaymentRequest `json:"bank_transfer"`
	PrivateLabel       CreatePrivateLabelPaymentRequest `json:"private_label"`
}

Request for updating the payment method of a charge

func (*UpdateChargePaymentMethodRequest) MarshalJSON

func (u *UpdateChargePaymentMethodRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateChargePaymentMethodRequest) UnmarshalJSON

func (u *UpdateChargePaymentMethodRequest) UnmarshalJSON(input []byte) error

type UpdateCurrentCycleEndDateRequest

type UpdateCurrentCycleEndDateRequest struct {
	EndAt *time.Time `json:"end_at,omitempty"`
}

Request to update the end date of the current subscription cycle

func (*UpdateCurrentCycleEndDateRequest) MarshalJSON

func (u *UpdateCurrentCycleEndDateRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateCurrentCycleEndDateRequest) UnmarshalJSON

func (u *UpdateCurrentCycleEndDateRequest) UnmarshalJSON(input []byte) error

type UpdateCurrentCycleStatusRequest

type UpdateCurrentCycleStatusRequest struct {
	Status string `json:"status"`
}

func (*UpdateCurrentCycleStatusRequest) MarshalJSON

func (u *UpdateCurrentCycleStatusRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateCurrentCycleStatusRequest) UnmarshalJSON

func (u *UpdateCurrentCycleStatusRequest) UnmarshalJSON(input []byte) error

type UpdateCustomerRequest

type UpdateCustomerRequest struct {
	Name         *string               `json:"name,omitempty"`
	Email        *string               `json:"email,omitempty"`
	Document     *string               `json:"document,omitempty"`
	Type         *string               `json:"type,omitempty"`
	Address      *CreateAddressRequest `json:"address,omitempty"`
	Metadata     map[string]*string    `json:"metadata,omitempty"`
	Phones       *CreatePhonesRequest  `json:"phones,omitempty"`
	Code         *string               `json:"code,omitempty"`
	Gender       *string               `json:"gender,omitempty"`
	DocumentType *string               `json:"document_type,omitempty"`
}

Request for updating a customer

func (*UpdateCustomerRequest) MarshalJSON

func (u *UpdateCustomerRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateCustomerRequest) UnmarshalJSON

func (u *UpdateCustomerRequest) UnmarshalJSON(input []byte) error

type UpdateInvoiceStatusRequest

type UpdateInvoiceStatusRequest struct {
	Status string `json:"status"`
}

Invoice Update Status Request

func (*UpdateInvoiceStatusRequest) MarshalJSON

func (u *UpdateInvoiceStatusRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateInvoiceStatusRequest) UnmarshalJSON

func (u *UpdateInvoiceStatusRequest) UnmarshalJSON(input []byte) error

type UpdateMetadataRequest

type UpdateMetadataRequest struct {
	Metadata map[string]string `json:"metadata"`
}

Request for updating an metadata

func (*UpdateMetadataRequest) MarshalJSON

func (u *UpdateMetadataRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateMetadataRequest) UnmarshalJSON

func (u *UpdateMetadataRequest) UnmarshalJSON(input []byte) error

type UpdateOrderItemRequest

type UpdateOrderItemRequest struct {
	Amount      int    `json:"amount"`
	Description string `json:"description"`
	Quantity    int    `json:"quantity"`
	Category    string `json:"category"`
}

Update Order item Request

func (*UpdateOrderItemRequest) MarshalJSON

func (u *UpdateOrderItemRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateOrderItemRequest) UnmarshalJSON

func (u *UpdateOrderItemRequest) UnmarshalJSON(input []byte) error

type UpdateOrderStatusRequest

type UpdateOrderStatusRequest struct {
	Status string `json:"status"`
}

func (*UpdateOrderStatusRequest) MarshalJSON

func (u *UpdateOrderStatusRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateOrderStatusRequest) UnmarshalJSON

func (u *UpdateOrderStatusRequest) UnmarshalJSON(input []byte) error

type UpdatePlanItemRequest

type UpdatePlanItemRequest struct {
	Name          string                     `json:"name"`
	Description   string                     `json:"description"`
	Status        string                     `json:"status"`
	PricingScheme UpdatePricingSchemeRequest `json:"pricing_scheme"`
	Quantity      *int                       `json:"quantity,omitempty"`
	Cycles        *int                       `json:"cycles,omitempty"`
}

Request for updating a plan item

func (*UpdatePlanItemRequest) MarshalJSON

func (u *UpdatePlanItemRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdatePlanItemRequest) UnmarshalJSON

func (u *UpdatePlanItemRequest) UnmarshalJSON(input []byte) error

type UpdatePlanRequest

type UpdatePlanRequest struct {
	Name                string            `json:"name"`
	Description         string            `json:"description"`
	Installments        []int             `json:"installments"`
	StatementDescriptor string            `json:"statement_descriptor"`
	Currency            string            `json:"currency"`
	Interval            string            `json:"interval"`
	IntervalCount       int               `json:"interval_count"`
	PaymentMethods      []string          `json:"payment_methods"`
	BillingType         string            `json:"billing_type"`
	Status              string            `json:"status"`
	Shippable           bool              `json:"shippable"`
	BillingDays         []int             `json:"billing_days"`
	Metadata            map[string]string `json:"metadata"`
	MinimumPrice        *int              `json:"minimum_price,omitempty"`
	TrialPeriodDays     *int              `json:"trial_period_days,omitempty"`
}

Request for updating a plan

func (*UpdatePlanRequest) MarshalJSON

func (u *UpdatePlanRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdatePlanRequest) UnmarshalJSON

func (u *UpdatePlanRequest) UnmarshalJSON(input []byte) error

type UpdatePriceBracketRequest

type UpdatePriceBracketRequest struct {
	StartQuantity int  `json:"start_quantity"`
	Price         int  `json:"price"`
	EndQuantity   *int `json:"end_quantity,omitempty"`
	OveragePrice  *int `json:"overage_price,omitempty"`
}

Request for updating a price bracket

func (*UpdatePriceBracketRequest) MarshalJSON

func (u *UpdatePriceBracketRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdatePriceBracketRequest) UnmarshalJSON

func (u *UpdatePriceBracketRequest) UnmarshalJSON(input []byte) error

type UpdatePricingSchemeRequest

type UpdatePricingSchemeRequest struct {
	SchemeType    string                      `json:"scheme_type"`
	PriceBrackets []UpdatePriceBracketRequest `json:"price_brackets"`
	Price         *int                        `json:"price,omitempty"`
	MinimumPrice  *int                        `json:"minimum_price,omitempty"`
	Percentage    *float64                    `json:"percentage,omitempty"`
}

Request for updating a pricing scheme

func (*UpdatePricingSchemeRequest) MarshalJSON

func (u *UpdatePricingSchemeRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdatePricingSchemeRequest) UnmarshalJSON

func (u *UpdatePricingSchemeRequest) UnmarshalJSON(input []byte) error

type UpdateRecipientBankAccountRequest

type UpdateRecipientBankAccountRequest struct {
	BankAccount CreateBankAccountRequest `json:"bank_account"`
	PaymentMode string                   `json:"payment_mode"`
}

Updates the default bank account for a recipient

func (*UpdateRecipientBankAccountRequest) MarshalJSON

func (u *UpdateRecipientBankAccountRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateRecipientBankAccountRequest) UnmarshalJSON

func (u *UpdateRecipientBankAccountRequest) UnmarshalJSON(input []byte) error

type UpdateRecipientRequest

type UpdateRecipientRequest struct {
	Name        string            `json:"name"`
	Email       string            `json:"email"`
	Description string            `json:"description"`
	Type        string            `json:"type"`
	Status      string            `json:"status"`
	Metadata    map[string]string `json:"metadata"`
}

Request for updating a Recipient

func (*UpdateRecipientRequest) MarshalJSON

func (u *UpdateRecipientRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateRecipientRequest) UnmarshalJSON

func (u *UpdateRecipientRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionAffiliationIdRequest

type UpdateSubscriptionAffiliationIdRequest struct {
	GatewayAffiliationId string `json:"gateway_affiliation_id"`
}

Request for updating a Subscription Affiliation Id

func (*UpdateSubscriptionAffiliationIdRequest) MarshalJSON

func (u *UpdateSubscriptionAffiliationIdRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionAffiliationIdRequest) UnmarshalJSON

func (u *UpdateSubscriptionAffiliationIdRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionBillingDateRequest

type UpdateSubscriptionBillingDateRequest struct {
	NextBillingAt time.Time `json:"next_billing_at"`
}

Request for updating the due date from a subscription

func (*UpdateSubscriptionBillingDateRequest) MarshalJSON

func (u *UpdateSubscriptionBillingDateRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionBillingDateRequest) UnmarshalJSON

func (u *UpdateSubscriptionBillingDateRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionCardRequest

type UpdateSubscriptionCardRequest struct {
	Card   CreateCardRequest `json:"card"`
	CardId string            `json:"card_id"`
}

Request for updating the card from a subscription

func (*UpdateSubscriptionCardRequest) MarshalJSON

func (u *UpdateSubscriptionCardRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionCardRequest) UnmarshalJSON

func (u *UpdateSubscriptionCardRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionDueDaysRequest

type UpdateSubscriptionDueDaysRequest struct {
	BoletoDueDays int `json:"boleto_due_days"`
}

func (*UpdateSubscriptionDueDaysRequest) MarshalJSON

func (u *UpdateSubscriptionDueDaysRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionDueDaysRequest) UnmarshalJSON

func (u *UpdateSubscriptionDueDaysRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionItemRequest

type UpdateSubscriptionItemRequest struct {
	Description   string                     `json:"description"`
	Status        string                     `json:"status"`
	PricingScheme UpdatePricingSchemeRequest `json:"pricing_scheme"`
	Name          string                     `json:"name"`
	Cycles        *int                       `json:"cycles,omitempty"`
	Quantity      *int                       `json:"quantity,omitempty"`
	MinimumPrice  *int                       `json:"minimum_price,omitempty"`
}

Request for updating a subscription item

func (*UpdateSubscriptionItemRequest) MarshalJSON

func (u *UpdateSubscriptionItemRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionItemRequest) UnmarshalJSON

func (u *UpdateSubscriptionItemRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionMinimumPriceRequest

type UpdateSubscriptionMinimumPriceRequest struct {
	MinimumPrice *int `json:"minimum_price,omitempty"`
}

Atualização do valor mínimo da assinatura

func (*UpdateSubscriptionMinimumPriceRequest) MarshalJSON

func (u *UpdateSubscriptionMinimumPriceRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionMinimumPriceRequest) UnmarshalJSON

func (u *UpdateSubscriptionMinimumPriceRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionPaymentMethodRequest

type UpdateSubscriptionPaymentMethodRequest struct {
	PaymentMethod string                           `json:"payment_method"`
	CardId        string                           `json:"card_id"`
	Card          CreateCardRequest                `json:"card"`
	CardToken     *string                          `json:"card_token,omitempty"`
	Boleto        *CreateSubscriptionBoletoRequest `json:"boleto,omitempty"`
}

Request for updating a subscription's payment method

func (*UpdateSubscriptionPaymentMethodRequest) MarshalJSON

func (u *UpdateSubscriptionPaymentMethodRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionPaymentMethodRequest) UnmarshalJSON

func (u *UpdateSubscriptionPaymentMethodRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionSplitRequest

type UpdateSubscriptionSplitRequest struct {
	Enabled bool                 `json:"enabled"`
	Rules   []CreateSplitRequest `json:"rules"`
}

func (*UpdateSubscriptionSplitRequest) MarshalJSON

func (u *UpdateSubscriptionSplitRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionSplitRequest) UnmarshalJSON

func (u *UpdateSubscriptionSplitRequest) UnmarshalJSON(input []byte) error

type UpdateSubscriptionStartAtRequest

type UpdateSubscriptionStartAtRequest struct {
	StartAt time.Time `json:"start_at"`
}

Request for updating the start date from a subscription

func (*UpdateSubscriptionStartAtRequest) MarshalJSON

func (u *UpdateSubscriptionStartAtRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateSubscriptionStartAtRequest) UnmarshalJSON

func (u *UpdateSubscriptionStartAtRequest) UnmarshalJSON(input []byte) error

type UpdateTransferSettingsRequest

type UpdateTransferSettingsRequest struct {
	TransferEnabled  string `json:"transfer_enabled"`
	TransferInterval string `json:"transfer_interval"`
	TransferDay      string `json:"transfer_day"`
}

func (*UpdateTransferSettingsRequest) MarshalJSON

func (u *UpdateTransferSettingsRequest) MarshalJSON() (
	[]byte,
	error)

func (*UpdateTransferSettingsRequest) UnmarshalJSON

func (u *UpdateTransferSettingsRequest) UnmarshalJSON(input []byte) error

Source Files

Jump to

Keyboard shortcuts

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