Versions in this module Expand all Collapse all v1 v1.0.2 Dec 6, 2023 v1.0.1 Dec 6, 2023 v1.0.0 Dec 6, 2023 Changes in this version + const HttpContentTypeJSON + const HttpContentTypeText + const SortPaymentBookDueDate + func Pointer[T any](value T) *T + type Account interface + DeleteWhiteLabelSubaccount func(ctx context.Context, body DeleteWhiteLabelSubaccountRequest) (*DeleteWhiteLabelSubaccountResponse, error) + Get func(ctx context.Context) (*AccountResponse, error) + GetAccountStatement func(ctx context.Context, filter GetAccountStatementRequest) (*Pageable[AccountStatementResponse], error) + GetBalance func(ctx context.Context) (*AccountBalanceResponse, error) + GetBankInfo func(ctx context.Context) (*AccountBankInfoResponse, error) + GetFees func(ctx context.Context) (*AccountFeesResponse, error) + GetInvoiceCustomization func(ctx context.Context) (*InvoiceCustomizationResponse, error) + GetPaymentStatistic func(ctx context.Context, filter GetPaymentStatisticRequest) (*PaymentStatisticResponse, error) + GetRegistrationStatus func(ctx context.Context) (*AccountRegistrationStatusResponse, error) + GetSplitStatistic func(ctx context.Context) (*SplitStatisticResponse, error) + GetWallets func(ctx context.Context) (*Pageable[AccountWalletResponse], error) + SaveInvoiceCustomization func(ctx context.Context, body SaveInvoiceCustomizationRequest) (*InvoiceCustomizationResponse, error) + Update func(ctx context.Context, body UpdateAccountRequest) (*AccountResponse, error) + func NewAccount(env Env, accessToken string) Account + type AccountAnticipationBankSlipResponse struct + MonthlyFeePercentage float64 + type AccountAnticipationCreditCardFeesResponse struct + DetachedMonthlyFeeValue float64 + InstallmentMonthlyFeeValue float64 + type AccountAnticipationFeesResponse struct + BankSlip AccountAnticipationBankSlipResponse + CreditCard AccountAnticipationCreditCardFeesResponse + type AccountBalanceResponse struct + Balance float64 + Errors []ErrorResponse + func (a AccountBalanceResponse) IsFailure() bool + func (a AccountBalanceResponse) IsNoContent() bool + func (a AccountBalanceResponse) IsSuccess() bool + type AccountBankInfoResponse struct + Account string + AccountDigit string + Agency string + Errors []ErrorResponse + func (a AccountBankInfoResponse) IsFailure() bool + func (a AccountBankInfoResponse) IsNoContent() bool + func (a AccountBankInfoResponse) IsSuccess() bool + type AccountBankSlipFeesResponse struct + DefaultValue float64 + DiscountValue float64 + ExpirationDate Date + type AccountCreditBureauFeesResponse struct + LegalPersonFeeValue float64 + NaturalPersonFeeValue float64 + type AccountCreditCardFeesResponse struct + DiscountExpiration Date + DiscountOneInstallmentPercentage float64 + DiscountUpToSixInstallmentsPercentage float64 + DiscountUpToTwelveInstallmentsPercentage float64 + OneInstallmentPercentage float64 + OperationValue float64 + UpToSixInstallmentsPercentage float64 + UpToTwelveInstallmentsPercentage float64 + type AccountDebitCardFeesResponse struct + DefaultPercentage float64 + OperationValue float64 + type AccountFeesResponse struct + Anticipation AccountAnticipationFeesResponse + CreditBureauReport AccountCreditBureauFeesResponse + Errors []ErrorResponse + Invoice AccountInvoiceFeesResponse + Notification AccountNotificationFeesResponse + Payment AccountPaymentFeesResponse + Transfer AccountTransferFeesResponse + func (a AccountFeesResponse) IsFailure() bool + func (a AccountFeesResponse) IsNoContent() bool + func (a AccountFeesResponse) IsSuccess() bool + type AccountInvoiceFeesResponse struct + FeeValue float64 + type AccountNotificationFeesResponse struct + MessagingFeeValue float64 + PhoneCallFeeValue float64 + WhatsAppFeeValue float64 + type AccountPaymentFeesResponse struct + BankSlip AccountBankSlipFeesResponse + CreditCard AccountCreditCardFeesResponse + DebitCard AccountDebitCardFeesResponse + Pix AccountPixPaymentFeesResponse + type AccountPixPaymentFeesResponse struct + CreditsReceivedOfCurrentMonth float64 + DiscountExpiration Date + FixedFeeValue float64 + FixedFeeValueWithDiscount float64 + MaximumFeeValue float64 + MinimumFeeValue float64 + MonthlyCreditsWithoutFee float64 + PercentageFee float64 + type AccountPixTransferFeesResponse struct + DiscountValue float64 + ExpirationDate Date + FeeValue float64 + type AccountRegistrationStatusResponse struct + CommercialInfo string + Documentation string + Errors []ErrorResponse + General string + Id string + func (a AccountRegistrationStatusResponse) IsFailure() bool + func (a AccountRegistrationStatusResponse) IsNoContent() bool + func (a AccountRegistrationStatusResponse) IsSuccess() bool + type AccountResponse struct + Address string + AddressNumber string + BirthDate Date + City CityResponse + CompanyName string + CompanyType CompanyType + Complement string + CpfCnpj string + DenialReason string + Email string + Errors []ErrorResponse + MobilePhone string + Name string + PersonType PersonType + Phone string + PostalCode string + Province string + Site string + Status AccountStatus + func (a AccountResponse) IsFailure() bool + func (a AccountResponse) IsNoContent() bool + func (a AccountResponse) IsSuccess() bool + type AccountStatementResponse struct + Balance float64 + BillId string + CreditBureauReportId string + Date Date + Description string + Id string + InvoiceId string + PaymentDunningId string + PaymentId string + TransferId string + Type FinanceTransType + Value float64 + type AccountStatus string + const AccountStatusApproved + const AccountStatusAwaitingActionAuthorization + const AccountStatusDenied + const AccountStatusPending + type AccountTedTransferFeesResponse struct + FeeValue float64 + type AccountTransferFeesResponse struct + MonthlyTransfersWithoutFee int + Pix AccountPixTransferFeesResponse + Ted AccountTedTransferFeesResponse + type AccountType string + const AccountTypeCheckingAccount + const AccountTypeInvestimentAccount + const AccountTypeSalaryAccount + const AccountTypeTypePaymentAccount + type AccountWalletResponse struct + Id string + type AgreementSignRequest struct + Agreed bool + type AgreementSignResponse struct + Agreed bool + Errors []ErrorResponse + func (a AgreementSignResponse) IsFailure() bool + func (a AgreementSignResponse) IsNoContent() bool + func (a AgreementSignResponse) IsSuccess() bool + type Anticipation interface + AgreementSign func(ctx context.Context, body AgreementSignRequest) (*AgreementSignResponse, error) + GetAll func(ctx context.Context, filter GetAllAnticipationsRequest) (*Pageable[AnticipationResponse], error) + GetById func(ctx context.Context, anticipationId string) (*AnticipationResponse, error) + GetLimits func(ctx context.Context) (*AnticipationLimitsResponse, error) + Request func(ctx context.Context, body AnticipationRequest) (*AnticipationResponse, error) + Simulate func(ctx context.Context, body AnticipationSimulateRequest) (*AnticipationSimulateResponse, error) + func NewAnticipation(env Env, accessToken string) Anticipation + type AnticipationLimitResponse struct + Available float64 + Total float64 + type AnticipationLimitsResponse struct + BankSlip AnticipationLimitResponse + CreditCard AnticipationLimitResponse + Errors []ErrorResponse + func (a AnticipationLimitsResponse) IsFailure() bool + func (a AnticipationLimitsResponse) IsNoContent() bool + func (a AnticipationLimitsResponse) IsSuccess() bool + type AnticipationRequest struct + Documents []*os.File + Installment string + Payment string + type AnticipationResponse struct + AnticipationDate Date + AnticipationDays int + DenialObservation string + DueDate Date + Errors []ErrorResponse + Fee float64 + Id string + Installment string + NetValue float64 + Payment string + RequestDate Date + Status AnticipationStatus + TotalValue float64 + Value float64 + func (a AnticipationResponse) IsFailure() bool + func (a AnticipationResponse) IsNoContent() bool + func (a AnticipationResponse) IsSuccess() bool + type AnticipationSimulateRequest struct + Installment string + Payment string + type AnticipationSimulateResponse struct + AnticipationDate Date + AnticipationDays int + DueDate Date + Errors []ErrorResponse + Fee float64 + Installment string + IsDocumentationRequired bool + NetValue float64 + Payment string + TotalValue float64 + Value float64 + func (a AnticipationSimulateResponse) IsFailure() bool + func (a AnticipationSimulateResponse) IsNoContent() bool + func (a AnticipationSimulateResponse) IsSuccess() bool + type AnticipationStatus string + const AnticipationStatusCancelled + const AnticipationStatusCredited + const AnticipationStatusDebited + const AnticipationStatusDenied + const AnticipationStatusOverdue + const AnticipationStatusPending + const AnticipationStatusScheduled + type BackAccountRequest struct + Account string + AccountDigit string + AccountName string + Agency string + Bank BankRequest + BankAccountType BankAccountType + CpfCnpj string + Ispb string + OwnerBirthDate Date + OwnerName string + type BackAccountResponse struct + Account string + AccountDigit string + AccountName string + Agency string + Bank BankResponse + CpfCnpj string + OwnerBirthDate Date + OwnerName string + PixAddressKey string + type BankAccountType string + const BankAccountTypeChecking + const BankAccountTypeSavings + type BankRequest struct + Code string + type BankResponse struct + Code string + Ispb string + Name string + type BillPayment interface + CancelById func(ctx context.Context, billPaymentId string) (*BillPaymentResponse, error) + Create func(ctx context.Context, body CreateBillPaymentRequest) (*BillPaymentResponse, error) + GetAll func(ctx context.Context, filter PageableDefaultRequest) (*Pageable[BillPaymentResponse], error) + GetById func(ctx context.Context, billPaymentId string) (*BillPaymentResponse, error) + Simulate func(ctx context.Context, body BillPaymentSimulateRequest) (*BillPaymentSimulateResponse, error) + func NewBillPayment(env Env, accessToken string) BillPayment + type BillPaymentBankSlipInfoResponse struct + AllowChangeValue bool + Bank string + BeneficiaryCpfCnpj string + BeneficiaryName string + CompanyName string + DiscountValue float64 + DueDate Date + FineValue float64 + IdentificationField string + InterestValue float64 + IsOverdue bool + MaxValue float64 + MinValue float64 + OriginalValue float64 + TotalAdditionalValue float64 + TotalDiscountValue float64 + Value float64 + type BillPaymentResponse struct + CanBeCancelled bool + CompanyName string + Description string + Discount float64 + DueDate Date + Errors []ErrorResponse + FailReasons string + Fee float64 + Fine float64 + Id string + IdentificationField string + Interest float64 + PaymentDate Date + ScheduleDate Date + Status BillPaymentStatus + TransactionReceiptUrl string + Value float64 + func (b BillPaymentResponse) IsFailure() bool + func (b BillPaymentResponse) IsNoContent() bool + func (b BillPaymentResponse) IsSuccess() bool + type BillPaymentSimulateRequest struct + BarCode string + IdentificationField string + type BillPaymentSimulateResponse struct + BankSlipInfo BillPaymentBankSlipInfoResponse + Errors []ErrorResponse + Fee float64 + MinimumScheduleDate Date + func (b BillPaymentSimulateResponse) IsFailure() bool + func (b BillPaymentSimulateResponse) IsNoContent() bool + func (b BillPaymentSimulateResponse) IsSuccess() bool + type BillPaymentStatus string + const BillPaymentStatusBankPaid + const BillPaymentStatusBankProcessing + const BillPaymentStatusCancelled + const BillPaymentStatusFailed + const BillPaymentStatusPending + type BillingType string + const BillingTypeBankSlip + const BillingTypeCreditCard + const BillingTypeDebitCard + const BillingTypeDeposit + const BillingTypePix + const BillingTypeTransfer + const BillingTypeUndefined + type CallbackRequest struct + AutoRedirect *bool + SuccessUrl string + type Charge interface + Create func(ctx context.Context, body CreateChargeRequest) (*ChargeResponse, error) + DeleteById func(ctx context.Context, chargeId string) (*DeleteResponse, error) + DeleteDocumentById func(ctx context.Context, chargeId, docId string) (*DeleteResponse, error) + GetAll func(ctx context.Context, filter GetAllChargesRequest) (*Pageable[ChargeResponse], error) + GetAllDocumentsById func(ctx context.Context, chargeId string, filter PageableDefaultRequest) (*Pageable[ChargeDocumentResponse], error) + GetById func(ctx context.Context, chargeId string) (*ChargeResponse, error) + GetCreationLimit func(ctx context.Context) (*ChargeCreationLimitResponse, error) + GetDocumentById func(ctx context.Context, chargeId, docId string) (*ChargeDocumentResponse, error) + GetIdentificationFieldById func(ctx context.Context, chargeId string) (*IdentificationFieldResponse, error) + GetPixQrCodeById func(ctx context.Context, chargeId string) (*ChargePixQrCodeResponse, error) + GetStatusById func(ctx context.Context, chargeId string) (*ChargeStatusResponse, error) + PayWithCreditCard func(ctx context.Context, chargeId string, body PayWithCreditCardRequest) (*ChargeResponse, error) + ReceiveInCashById func(ctx context.Context, chargeId string, body ChargeReceiveInCashRequest) (*ChargeResponse, error) + RefundById func(ctx context.Context, chargeId string, body RefundRequest) (*ChargeResponse, error) + RestoreById func(ctx context.Context, chargeId string) (*ChargeResponse, error) + UndoReceivedInCashById func(ctx context.Context, chargeId string) (*ChargeResponse, error) + UpdateById func(ctx context.Context, chargeId string, body UpdateChargeRequest) (*ChargeResponse, error) + UpdateDocumentDefinitionsById func(ctx context.Context, chargeId, docId string, ...) (*ChargeDocumentResponse, error) + UploadDocumentById func(ctx context.Context, chargeId string, body UploadChargeDocumentRequest) (*ChargeDocumentResponse, error) + func NewCharge(env Env, accessCode string) Charge + type ChargeCreationLimitResponse struct + Creation ChargeCreationResponse + Errors []ErrorResponse + func (c ChargeCreationLimitResponse) IsFailure() bool + func (c ChargeCreationLimitResponse) IsNoContent() bool + func (c ChargeCreationLimitResponse) IsSuccess() bool + type ChargeCreationResponse struct + Daily DailyCreationLimitResponse + type ChargeDocumentResponse struct + AvailableAfterPayment bool + Deleted bool + Errors []ErrorResponse + File *ChargeFileResponse + Id string + Name string + Type DocumentType + func (c ChargeDocumentResponse) IsFailure() bool + func (c ChargeDocumentResponse) IsNoContent() bool + func (c ChargeDocumentResponse) IsSuccess() bool + type ChargeFileResponse struct + DownloadUrl string + Extension string + OriginalName string + PreviewUrl string + PublicId string + Size int + type ChargePixQrCodeResponse struct + EncodedImage string + Errors []ErrorResponse + ExpirationDate Date + Payload string + func (c ChargePixQrCodeResponse) IsFailure() bool + func (c ChargePixQrCodeResponse) IsNoContent() bool + func (c ChargePixQrCodeResponse) IsSuccess() bool + type ChargeReceiveInCashRequest struct + NotifyCustomer bool + PaymentDate Date + Value float64 + type ChargeResponse struct + Anticipable bool + Anticipated bool + BankSlipUrl string + BillingType BillingType + CanBePaidAfterDueDate bool + ClientPaymentDate Date + CreditCard *CreditCardResponse + Customer string + DateCreated Date + Deleted bool + Description string + Discount *DiscountResponse + DueDate Date + Errors []ErrorResponse + ExternalReference string + Fine *FineResponse + Id string + Installment string + InstallmentNumber int + Interest *InterestResponse + InterestValue string + InvoiceNumber string + InvoiceUrl string + NetValue float64 + NossoNumero string + OriginalDueDate Date + OriginalValue string + PaymentDate Date + PaymentLink string + PixTransaction string + PostalService bool + Refunds []RefundResponse + Status ChargeStatus + TransactionReceiptUrl string + Value float64 + func (c ChargeResponse) IsFailure() bool + func (c ChargeResponse) IsNoContent() bool + func (c ChargeResponse) IsSuccess() bool + type ChargeStatus string + const ChargeStatusAwaitingChargebackReversal + const ChargeStatusAwaitingRiskAnalysis + const ChargeStatusChargebackDispute + const ChargeStatusChargebackRequested + const ChargeStatusConfirmed + const ChargeStatusDunningReceived + const ChargeStatusDunningRequested + const ChargeStatusOverdue + const ChargeStatusPending + const ChargeStatusReceived + const ChargeStatusReceivedInCash + const ChargeStatusRefundInProgress + const ChargeStatusRefundRequested + const ChargeStatusRefunded + type ChargeStatusResponse struct + Errors []ErrorResponse + Status ChargeStatus + func (c ChargeStatusResponse) IsFailure() bool + func (c ChargeStatusResponse) IsNoContent() bool + func (c ChargeStatusResponse) IsSuccess() bool + type ChargeType string + const ChargeTypeDetached + const ChargeTypeInstallment + const ChargeTypeRecurrent + type ChargebackReason string + const ChargebackReason1 + const ChargebackReason10 + const ChargebackReason11 + const ChargebackReason12 + const ChargebackReason13 + const ChargebackReason14 + const ChargebackReason15 + const ChargebackReason16 + const ChargebackReason17 + const ChargebackReason18 + const ChargebackReason19 + const ChargebackReason2 + const ChargebackReason20 + const ChargebackReason21 + const ChargebackReason22 + const ChargebackReason23 + const ChargebackReason24 + const ChargebackReason25 + const ChargebackReason26 + const ChargebackReason27 + const ChargebackReason28 + const ChargebackReason29 + const ChargebackReason3 + const ChargebackReason30 + const ChargebackReason31 + const ChargebackReason32 + const ChargebackReason4 + const ChargebackReason5 + const ChargebackReason6 + const ChargebackReason7 + const ChargebackReason8 + const ChargebackReason9 + type ChargebackStatus string + const ChargebackStatusDone + const ChargebackStatusInDispute + const ChargebackStatusLost + const ChargebackStatusRequested + const ChargebackStatusReversed + type ChargesAvailableForDunningResponse struct + BillingType BillingType + Customer string + DueDate Date + Payment string + Status ChargeStatus + TypeSimulations []NegativityTypeSimulationResponse + Value float64 + type CityResponse struct + District string + DistrictCode string + IbgeCode string + Id int + Name string + State string + type CompanyType string + const CompanyTypeAssociation + const CompanyTypeIndividual + const CompanyTypeLimited + const CompanyTypeMei + type CreateBillPaymentRequest struct + Description string + Discount float64 + DueDate Date + Fine float64 + IdentificationField string + Interest float64 + ScheduleDate Date + Value float64 + type CreateChargeRequest struct + AuthorizeOnly bool + BillingType BillingType + Callback *CallbackRequest + CreditCard *CreditCardRequest + CreditCardHolderInfo *CreditCardHolderInfoRequest + CreditCardToken string + Customer string + Description string + Discount *DiscountRequest + DueDate Date + ExternalReference string + Fine *FineRequest + InstallmentCount int + InstallmentValue float64 + Interest *InterestRequest + PostalService bool + RemoteIp string + Split []SplitRequest + Value float64 + type CreateCustomerRequest struct + AdditionalEmails string + Address string + AddressNumber string + Company string + Complement string + CpfCnpj string + Email string + ExternalReference string + GroupName string + MobilePhone string + MunicipalInscription string + Name string + NotificationDisabled bool + Observations string + Phone string + PostalCode string + Province string + StateInscription string + type CreateInvoiceSettingRequest struct + DaysBeforeDueDate int + Deductions float64 + EffectiveDatePeriod EffectiveDatePeriod + MunicipalServiceCode string + MunicipalServiceId string + MunicipalServiceName string + Observations string + ReceivedOnly bool + Taxes InvoiceTaxesRequest + UpdatePayment bool + type CreateNegativityRequest struct + CustomerAddress string + CustomerAddressNumber string + CustomerComplement string + CustomerCpfCnpj string + CustomerName string + CustomerPostalCode string + CustomerPrimaryPhone string + CustomerProvince string + CustomerSecondaryPhone string + Description string + Documents *FileRequest + Payment string + Type NegativityType + type CreatePaymentLinkRequest struct + BillingType BillingType + Callback *CallbackRequest + ChargeType ChargeType + Description string + DueDateLimitDays int + EndDate Date + MaxInstallmentCount int + Name string + NotificationEnabled bool + SubscriptionCycle SubscriptionCycle + Value float64 + type CreatePixKeyStaticRequest struct + AddressKey string + AllowsMultiplePayments *bool + Description string + ExpirationDate Datetime + ExpirationSeconds int + Format QrCodeFormat + Value float64 + type CreateSubaccountRequest struct + Address string + AddressNumber string + BirthDate Date + CompanyType CompanyType + Complement string + CpfCnpj string + Email string + LoginEmail string + MobilePhone string + Name string + Phone string + PostalCode string + Province string + Site string + Webhooks []CreateSubaccountWebhookRequest + type CreateSubaccountWebhookRequest struct + ApiVersion string + AuthToken string + Email string + Enabled bool + Interrupted bool + Type WebhookType + Url string + type CreateSubscriptionRequest struct + BillingType BillingType + CreditCard *CreditCardRequest + CreditCardHolderInfo *CreditCardHolderInfoRequest + CreditCardToken string + Customer string + Cycle SubscriptionCycle + Description string + Discount *DiscountRequest + EndDate Date + ExternalReference string + Fine *FineRequest + Interest *InterestRequest + MaxPayments int + NextDueDate Date + RemoteIp string + Split []SplitRequest + Value float64 + type CreditBureau interface + GetAllReports func(ctx context.Context, filter GetAllReportsRequest) (*Pageable[CreditBureauReportResponse], error) + GetReport func(ctx context.Context, body GetReportRequest) (*CreditBureauReportResponse, error) + GetReportById func(ctx context.Context, creditBureauReportId string) (*CreditBureauReportResponse, error) + func NewCreditBureau(env Env, accessToken string) CreditBureau + type CreditBureauReportResponse struct + CpfCnpj string + Customer string + DateCreated Date + DownloadUrl string + Errors []ErrorResponse + Id string + ReportFile string + State string + func (c CreditBureauReportResponse) IsFailure() bool + func (c CreditBureauReportResponse) IsNoContent() bool + func (c CreditBureauReportResponse) IsSuccess() bool + type CreditCard interface + Tokenize func(ctx context.Context, body CreditCardTokenizeRequest) (*CreditCardTokenizeResponse, error) + func NewCreditCard(env Env, accessToken string) CreditCard + type CreditCardHolderInfoRequest struct + AddressComplement string + AddressNumber string + CpfCnpj string + Email string + MobilePhone string + Name string + Phone string + PostalCode string + type CreditCardRequest struct + Ccv string + ExpiryMonth string + ExpiryYear string + HolderName string + Number string + type CreditCardResponse struct + CreditCardBrand string + CreditCardNumber string + CreditCardToken string + type CreditCardTokenizeRequest struct + CreditCard CreditCardRequest + CreditCardHolderInfo CreditCardHolderInfoRequest + Customer string + type CreditCardTokenizeResponse struct + CreditCardBrand string + CreditCardNumber string + CreditCardToken string + Errors []ErrorResponse + func (c CreditCardTokenizeResponse) IsFailure() bool + func (c CreditCardTokenizeResponse) IsNoContent() bool + func (c CreditCardTokenizeResponse) IsSuccess() bool + type Customer interface + Create func(ctx context.Context, body CreateCustomerRequest) (*CustomerResponse, error) + DeleteById func(ctx context.Context, customerId string) (*DeleteResponse, error) + GetAll func(ctx context.Context, filter GetAllCustomersRequest) (*Pageable[CustomerResponse], error) + GetById func(ctx context.Context, customerId string) (*CustomerResponse, error) + RestoreById func(ctx context.Context, customerId string) (*CustomerResponse, error) + UpdateById func(ctx context.Context, customerId string, body UpdateCustomerRequest) (*CustomerResponse, error) + func NewCustomer(env Env, accessToken string) Customer + type CustomerResponse struct + AdditionalEmails string + Address string + AddressNumber string + CanDelete bool + CanEdit bool + CannotBeDeletedReason string + CannotEditReason string + City int + Complement string + Country string + CpfCnpj string + DateCreated Date + Deleted bool + Email string + Errors []ErrorResponse + ExternalReference string + ForeignCustomer bool + Id string + MobilePhone string + MunicipalInscription string + Name string + NotificationDisabled bool + Observations string + PersonType PersonType + Phone string + PostalCode string + Province string + State string + StateInscription string + func (c CustomerResponse) IsFailure() bool + func (c CustomerResponse) IsNoContent() bool + func (c CustomerResponse) IsSuccess() bool + type DailyCreationLimitResponse struct + Limit int + Used int + WasReached bool + type Date time.Time + func DateNow() Date + func NewDate(year int, month time.Month, day int, loc *time.Location) Date + func (d *Date) UnmarshalJSON(b []byte) error + func (d Date) Day() int + func (d Date) Format() string + func (d Date) IsZero() bool + func (d Date) Location() *time.Location + func (d Date) MarshalJSON() ([]byte, error) + func (d Date) Month() time.Month + func (d Date) Time() time.Time + func (d Date) Year() int + type Datetime time.Time + func DatetimeNow() Datetime + func NewDatetime(year int, month time.Month, day, hour, min, sec, nSec int, loc *time.Location) Datetime + func NewDatetimePointer(year int, month time.Month, day, hour, min, sec, nSec int, loc *time.Location) Datetime + func (d Datetime) Day() int + func (d Datetime) Format() string + func (d Datetime) Hour() int + func (d Datetime) IsZero() bool + func (d Datetime) Location() *time.Location + func (d Datetime) MarshalJSON() ([]byte, error) + func (d Datetime) Minute() int + func (d Datetime) Month() time.Month + func (d Datetime) Nanosecond() int + func (d Datetime) Second() int + func (d Datetime) Time() time.Time + func (d Datetime) Year() int + type DecodePixQrCodeResponse struct + CanBeModifyChangeValue bool + CanBePaid bool + CanBePaidWithDifferentValue bool + CannotBePaidReason string + ChangeValue float64 + ConciliationIdentifier string + Description string + Discount float64 + DueDate Date + EndToEndIdentifier string + Errors []ErrorResponse + ExpirationDate Date + Finality PixTransactionFinality + Fine float64 + Interest float64 + Payer *PixPayerResponse + Payload string + PixKey string + Receiver *PixReceiverResponse + TotalValue float64 + TransactionOriginType PixTransactionOriginType + Type PixTransactionType + Value float64 + func (d DecodePixQrCodeResponse) IsFailure() bool + func (d DecodePixQrCodeResponse) IsNoContent() bool + func (d DecodePixQrCodeResponse) IsSuccess() bool + type DeleteNumericResponse struct + Deleted bool + Errors []ErrorResponse + Id int + func (d DeleteNumericResponse) IsFailure() bool + func (d DeleteNumericResponse) IsNoContent() bool + func (d DeleteNumericResponse) IsSuccess() bool + type DeleteResponse struct + Deleted bool + Errors []ErrorResponse + Id string + func (d DeleteResponse) IsFailure() bool + func (d DeleteResponse) IsNoContent() bool + func (d DeleteResponse) IsSuccess() bool + type DeleteWhiteLabelSubaccountRequest struct + RemoveReason string + type DeleteWhiteLabelSubaccountResponse struct + Errors []ErrorResponse + Observations string + func (d DeleteWhiteLabelSubaccountResponse) IsFailure() bool + func (d DeleteWhiteLabelSubaccountResponse) IsNoContent() bool + func (d DeleteWhiteLabelSubaccountResponse) IsSuccess() bool + type DiscountRequest struct + DueDateLimitDays int + Type DiscountType + Value float64 + type DiscountResponse struct + DueDateLimitDays int + Type DiscountType + Value float64 + type DiscountType string + const DiscountTypeFixed + const DiscountTypePercentage + type DocumentResponsibleResponse struct + Name string + Type string + type DocumentType string + const DocumentTypeContract + const DocumentTypeDocument + const DocumentTypeInvoice + const DocumentTypeOther + const DocumentTypeProgram + const DocumentTypeSpreadsheet + type EffectiveDatePeriod string + const EffectiveDatePeriodBeforePaymentDueDate + const EffectiveDatePeriodOnDueDateMonth + const EffectiveDatePeriodOnNextMonth + const EffectiveDatePeriodOnPaymentConfirmation + const EffectiveDatePeriodOnPaymentDueDate + type Env int + const EnvProduction + const EnvSandbox + func (a Env) BaseUrl() string + func (a Env) String() string + type ErrorResponse struct + Code string + Description string + type FileMimeType string + const FileMimeTypeAvif + const FileMimeTypeCss + const FileMimeTypeGif + const FileMimeTypeHtml + const FileMimeTypeJpeg + const FileMimeTypeJs + const FileMimeTypeJson + const FileMimeTypePdf + const FileMimeTypePng + const FileMimeTypeSvg + const FileMimeTypeText + const FileMimeTypeWasm + const FileMimeTypeWebp + const FileMimeTypeXml + func (f FileMimeType) String() string + type FileRequest struct + Data []byte + Mime FileMimeType + Name string + func (f FileRequest) MarshalJSON() ([]byte, error) + type FileTextPlainResponse struct + Data string + Errors []ErrorResponse + func (f FileTextPlainResponse) IsFailure() bool + func (f FileTextPlainResponse) IsNoContent() bool + func (f FileTextPlainResponse) IsSuccess() bool + type FinanceTransType string + const FinanceTransTypeAsaasCardBalanceRefund + const FinanceTransTypeAsaasCardBillPayment + const FinanceTransTypeAsaasCardBillPaymentRefund + const FinanceTransTypeAsaasCardCashback + const FinanceTransTypeAsaasCardRecharge + const FinanceTransTypeAsaasCardRechargeReversal + const FinanceTransTypeAsaasCardTransaction + const FinanceTransTypeAsaasCardTransactionFee + const FinanceTransTypeAsaasCardTransactionFeeRefund + const FinanceTransTypeAsaasCardTransactionPartialRefundCancellation + const FinanceTransTypeAsaasCardTransactionRefund + const FinanceTransTypeAsaasCardTransactionRefundCancellation + const FinanceTransTypeAsaasDebitCardRequestFee + const FinanceTransTypeAsaasMoneyPaymentAnticipationFee + const FinanceTransTypeAsaasMoneyPaymentAnticipationFeeRefund + const FinanceTransTypeAsaasMoneyPaymentCompromisedBalance + const FinanceTransTypeAsaasMoneyPaymentCompromisedBalanceRefund + const FinanceTransTypeAsaasMoneyPaymentFinancingFee + const FinanceTransTypeAsaasMoneyPaymentFinancingFeeRefund + const FinanceTransTypeAsaasMoneyTransactionCashback + const FinanceTransTypeAsaasMoneyTransactionCashbackRefund + const FinanceTransTypeAsaasMoneyTransactionChargeback + const FinanceTransTypeAsaasMoneyTransactionChargebackReversal + const FinanceTransTypeAsaasPrepaidCardRequestFee + const FinanceTransTypeBacenJudicialLock + const FinanceTransTypeBacenJudicialTransfer + const FinanceTransTypeBacenJudicialUnlock + const FinanceTransTypeBillPayment + const FinanceTransTypeBillPaymentCancelled + const FinanceTransTypeBillPaymentFee + const FinanceTransTypeBillPaymentFeeCancelled + const FinanceTransTypeBillPaymentRefunded + const FinanceTransTypeCancelMobilePhoneRecharge + const FinanceTransTypeChargeback + const FinanceTransTypeChargebackReversal + const FinanceTransTypeChargedFeeRefund + const FinanceTransTypeChildAccountKnownYourCustomerBatchFee + const FinanceTransTypeConsumerInvoiceFee + const FinanceTransTypeContractedCustomerPlanFee + const FinanceTransTypeContractualEffectSettlement + const FinanceTransTypeContractualEffectSettlementReversal + const FinanceTransTypeCredit + const FinanceTransTypeCreditBureauReport + const FinanceTransTypeCustomerCommissionSettlementCredit + const FinanceTransTypeCustomerCommissionSettlementDebit + const FinanceTransTypeDebit + const FinanceTransTypeDebitReversal + const FinanceTransTypeDebtRecoveryNegotiationFinancialCharges + const FinanceTransTypeExternalSettlementContractualEffectBatchCredit + const FinanceTransTypeExternalSettlementContractualEffectBatchReversal + const FinanceTransTypeFreePaymentUse + const FinanceTransTypeInstantTextMessageFee + const FinanceTransTypeInternalTransferCredit + const FinanceTransTypeInternalTransferDebit + const FinanceTransTypeInternalTransferReversal + const FinanceTransTypeInvoiceFee + const FinanceTransTypeMobilePhoneRecharge + const FinanceTransTypePartialPayment + const FinanceTransTypePaymentCustodyBlock + const FinanceTransTypePaymentCustodyBlockReversal + const FinanceTransTypePaymentDunningCancellationFee + const FinanceTransTypePaymentDunningReceivedFee + const FinanceTransTypePaymentDunningReceivedInCashFee + const FinanceTransTypePaymentDunningRequestFee + const FinanceTransTypePaymentFee + const FinanceTransTypePaymentFeeReversal + const FinanceTransTypePaymentInstantTextMessageFee + const FinanceTransTypePaymentMessagingNotificationFee + const FinanceTransTypePaymentReceived + const FinanceTransTypePaymentRefundCancelled + const FinanceTransTypePaymentReversal + const FinanceTransTypePaymentSmsNotificationFee + const FinanceTransTypePhoneCallNotificationFee + const FinanceTransTypePixTransactionCredit + const FinanceTransTypePixTransactionCreditFee + const FinanceTransTypePixTransactionCreditRefund + const FinanceTransTypePixTransactionCreditRefundCancellation + const FinanceTransTypePixTransactionDebit + const FinanceTransTypePixTransactionDebitFee + const FinanceTransTypePixTransactionDebitRefund + const FinanceTransTypePostalServiceFee + const FinanceTransTypeProductInvoiceFee + const FinanceTransTypePromotionalCodeCredit + const FinanceTransTypePromotionalCodeDebit + const FinanceTransTypeReceivableAnticipationDebit + const FinanceTransTypeReceivableAnticipationFee + const FinanceTransTypeReceivableAnticipationGrossCredit + const FinanceTransTypeReceivableAnticipationPartnerSettlement + const FinanceTransTypeRefundMobilePhoneRecharge + const FinanceTransTypeRefundRequestCancelled + const FinanceTransTypeRefundRequestFee + const FinanceTransTypeRefundRequestFeeReversal + const FinanceTransTypeReversal + const FinanceTransTypeTransfer + const FinanceTransTypeTransferFee + const FinanceTransTypeTransferReversal + type FineRequest struct + Type FineType + Value float64 + type FineResponse struct + Type FineType + Value float64 + type FineType string + const FineTypeFixed + const FineTypePercentage + type FiscalInfo interface + Get func(ctx context.Context) (*FiscalInfoResponse, error) + GetAllServices func(ctx context.Context, filter GetAllServicesRequest) (*Pageable[FiscalInfoServiceResponse], error) + GetMunicipalSettings func(ctx context.Context) (*MunicipalSettingsResponse, error) + Save func(ctx context.Context, body SaveFiscalInfoRequest) (*FiscalInfoResponse, error) + func NewFiscalInfo(env Env, accessToken string) FiscalInfo + type FiscalInfoResponse struct + AccessTokenSent bool + CertificateSent bool + Cnae string + CulturalProjectsPromoter bool + Email string + Errors []ErrorResponse + LoteNumber int + MunicipalInscription string + PasswordSent bool + RpsNumber int + RpsSerie string + ServiceListItem string + SimplesNacional bool + SpecialTaxRegime string + UseNationalPortal bool + Username string + func (f FiscalInfoResponse) IsFailure() bool + func (f FiscalInfoResponse) IsNoContent() bool + func (f FiscalInfoResponse) IsSuccess() bool + type FiscalInfoServiceResponse struct + Description string + Id string + IssTax float64 + type GetAccountStatementRequest struct + FinishDate Date + Limit int + Offset int + Order Order + StartDate Date + type GetAllAnticipationsRequest struct + Installment string + Limit int + Offset int + Payment string + Status AnticipationStatus + type GetAllChargesBySubscriptionRequest struct + Status ChargeStatus + type GetAllChargesRequest struct + Anticipated *bool + BillingType BillingType + Customer string + CustomerGroupName string + DateCreatedGe Date + DateCreatedLe Date + DueDateGe Date + DueDateLe Date + EstimatedCreditDate Date + EstimatedCreditDateGE Date + EstimatedCreditDateLE Date + ExternalReference string + Installment string + InvoiceStatus InvoiceStatus + Limit int + Offset int + PaymentDate Date + PaymentDateGe Date + PaymentDateLe Date + PixQrCodeId string + Status ChargeStatus + Subscription string + User string + type GetAllCustomersRequest struct + CpfCnpj string + Email string + ExternalReference string + GroupName string + Limit int + Name string + Offset int + type GetAllInvoicesRequest struct + Customer string + EffectiveDateGE Date + EffectiveDateLE Date + ExternalReference string + Installment string + Limit int + Offset int + Payment string + Status InvoiceStatus + type GetAllNegativitiesRequest struct + Limit int + Offset int + Payment string + RequestEndDate Date + RequestStartDate Date + Status NegativityStatus + Type NegativityType + type GetAllPaymentLinksRequest struct + Active *bool + IncludeDeleted *bool + Limit int + Name string + Offset int + type GetAllPixKeysRequest struct + Limit int + Offset int + Status PixKeyStatus + StatusList string + type GetAllPixTransactionsRequest struct + EndToEndIdentifier string + Limit int + Offset int + Status PixTransactionStatus + Type PixTransactionType + type GetAllReportsRequest struct + EndDate Date + Limit int + Offset int + StartDate Date + type GetAllServicesRequest struct + Description string + Limit int + Offset int + type GetAllSubaccountsRequest struct + CpfCnpj string + Email string + Limit int + Name string + Offset int + WalletId string + type GetAllSubscriptionInvoicesRequest struct + Customer string + EffectiveDateGE Date + EffectiveDateLE Date + ExternalReference string + Limit int + Offset int + Status InvoiceStatus + type GetAllSubscriptionsRequest struct + BillingType BillingType + Customer string + CustomerGroupName string + DeletedOnly bool + ExternalReference string + IncludeDeleted bool + Limit int + Offset int + Order Order + Sort SortSubscriptionField + Status SubscriptionStatus + type GetAllTransfersRequest struct + DateCreatedGe Date + DateCreatedLe Date + TransferDateGe Date + TransferDateLe Date + Type TransferType + type GetPaymentStatisticRequest struct + Anticipated *bool + BillingType BillingType + Customer string + DateCreatedGe Date + DateCreatedLe Date + DueDateGe Date + DueDateLe Date + EstimatedCreditDateGe Date + EstimatedCreditDateLe Date + ExternalReference string + Status ChargeStatus + type GetReportRequest struct + CpfCnpj string + Customer string + State string + type IdentificationFieldResponse struct + BarCode string + Errors []ErrorResponse + IdentificationField string + NossoNumero string + func (i IdentificationFieldResponse) IsFailure() bool + func (i IdentificationFieldResponse) IsNoContent() bool + func (i IdentificationFieldResponse) IsSuccess() bool + type Installment interface + DeleteById func(ctx context.Context, installmentId string) (*DeleteNumericResponse, error) + GetAll func(ctx context.Context, filter PageableDefaultRequest) (*Pageable[InstallmentResponse], error) + GetById func(ctx context.Context, installmentId string) (*InstallmentResponse, error) + GetPaymentBookById func(ctx context.Context, installmentId string, ...) (*FileTextPlainResponse, error) + RefundById func(ctx context.Context, installmentId string) (*InstallmentResponse, error) + UpdateSplitsById func(ctx context.Context, installmentId string, body UpdateSplitsRequest) (*UpdateInstallmentSplitsResponse, error) + func NewInstallment(env Env, accessToken string) Installment + type InstallmentChargebackResponse struct + Reason ChargebackReason + Status ChargebackStatus + type InstallmentPaymentBookRequest struct + Order Order + Sort SortPaymentBookField + type InstallmentResponse struct + BillingType BillingType + Chargeback *InstallmentChargebackResponse + Customer string + DateCreated Date + Deleted bool + Description string + Errors []ErrorResponse + ExpirationDay int + Id string + InstallmentCount int + NetValue float64 + PaymentDate Date + PaymentLink string + PaymentValue float64 + TransactionReceiptUrl string + Value float64 + func (i InstallmentResponse) IsFailure() bool + func (i InstallmentResponse) IsNoContent() bool + func (i InstallmentResponse) IsSuccess() bool + type InterestRequest struct + Value float64 + type InterestResponse struct + Type InterestType + Value float64 + type InterestType string + const InterestTypeFixed + const InterestTypePercentage + type Invoice interface + AuthorizeById func(ctx context.Context, invoiceId string) (*InvoiceResponse, error) + CancelById func(ctx context.Context, invoiceId string) (*InvoiceResponse, error) + GetAll func(ctx context.Context, filter GetAllInvoicesRequest) (*Pageable[InvoiceResponse], error) + GetById func(ctx context.Context, invoiceId string) (*InvoiceResponse, error) + Schedule func(ctx context.Context, body ScheduleInvoiceRequest) (*InvoiceResponse, error) + UpdateById func(ctx context.Context, invoiceId string, body UpdateInvoiceRequest) (*InvoiceResponse, error) + func NewInvoice(env Env, accessToken string) Invoice + type InvoiceCustomizationResponse struct + Enabled bool + Errors []ErrorResponse + FontColor string + InfoBackgroundColor string + LogoBackgroundColor string + LogoUrl string + Observations string + Status string + func (i InvoiceCustomizationResponse) IsFailure() bool + func (i InvoiceCustomizationResponse) IsNoContent() bool + func (i InvoiceCustomizationResponse) IsSuccess() bool + type InvoiceDaysBeforeDueDate int + const InvoiceDaysBeforeDuedateFifteen + const InvoiceDaysBeforeDuedateFive + const InvoiceDaysBeforeDuedateSixty + const InvoiceDaysBeforeDuedateTen + const InvoiceDaysBeforeDuedateThirty + type InvoiceResponse struct + Customer string + Deductions float64 + EffectiveDate Date + Errors []ErrorResponse + EstimatedTaxesDescription string + ExternalReference string + Id string + Installment string + MunicipalServiceCode string + MunicipalServiceId string + MunicipalServiceName string + Number string + Observations string + Payment string + PdfUrl string + RpsNumber string + RpsSerie string + ServiceDescription string + Status InvoiceStatus + StatusDescription string + Taxes *InvoiceTaxesResponse + Type string + ValidationCode string + Value float64 + XmlUrl string + func (i InvoiceResponse) IsFailure() bool + func (i InvoiceResponse) IsNoContent() bool + func (i InvoiceResponse) IsSuccess() bool + type InvoiceSettingResponse struct + DaysBeforeDueDate int + Deductions float64 + Errors []ErrorResponse + InvoiceCreationPeriod string + MunicipalServiceCode string + MunicipalServiceId string + MunicipalServiceName string + Observations string + ReceivedOnly bool + Taxes *InvoiceTaxesResponse + func (i InvoiceSettingResponse) IsFailure() bool + func (i InvoiceSettingResponse) IsNoContent() bool + func (i InvoiceSettingResponse) IsSuccess() bool + type InvoiceStatus string + const InvoiceStatusAuthorized + const InvoiceStatusCanceled + const InvoiceStatusCancellationDenied + const InvoiceStatusError + const InvoiceStatusProcessingCancellation + const InvoiceStatusScheduled + const InvoiceStatusSynchronized + type InvoiceTaxesRequest struct + Confins float64 + Csll float64 + Inss float64 + Ir float64 + Iss float64 + Pis float64 + RetainIss bool + type InvoiceTaxesResponse struct + Confins float64 + Csll float64 + Inss float64 + Ir float64 + Iss float64 + Pis float64 + RetainIss bool + type MobilePhone interface + CancelRechargeById func(ctx context.Context, rechargeId string) (*MobilePhoneRechargeResponse, error) + GetAllRecharges func(ctx context.Context, filter PageableDefaultRequest) (*Pageable[MobilePhoneRechargeResponse], error) + GetProviderByPhoneNumber func(ctx context.Context, phoneNumber string) (*MobilePhoneProviderResponse, error) + GetRechargeById func(ctx context.Context, rechargeId string) (*MobilePhoneRechargeResponse, error) + Recharge func(ctx context.Context, body MobilePhoneRechargeRequest) (*MobilePhoneRechargeResponse, error) + func NewMobilePhone(env Env, accessToken string) MobilePhone + type MobilePhoneProviderResponse struct + Errors []ErrorResponse + Name string + Values []MobilePhoneProviderValueResponse + func (m MobilePhoneProviderResponse) IsFailure() bool + func (m MobilePhoneProviderResponse) IsNoContent() bool + func (m MobilePhoneProviderResponse) IsSuccess() bool + type MobilePhoneProviderValueResponse struct + Bonus string + Description string + MaxValue float64 + MinValue float64 + Name string + type MobilePhoneRechargeRequest struct + PhoneNumber string + Value float64 + type MobilePhoneRechargeResponse struct + CanBeCancelled bool + Errors []ErrorResponse + Id string + OperatorName string + PhoneNumber string + Status MobilePhoneRechargeStatus + Value float64 + func (m MobilePhoneRechargeResponse) IsFailure() bool + func (m MobilePhoneRechargeResponse) IsNoContent() bool + func (m MobilePhoneRechargeResponse) IsSuccess() bool + type MobilePhoneRechargeStatus string + const MobilePhoneRechargeStatusCancelled + const MobilePhoneRechargeStatusConfirmed + const MobilePhoneRechargeStatusPending + const MobilePhoneRechargeStatusWaitingCriticalAction + type MunicipalSettingsResponse struct + AccessTokenHelp string + AuthenticationType string + DigitalCertificatedHelp string + Errors []ErrorResponse + MunicipalInscriptionHelp string + MunicipalServiceCodeHelp string + ServiceListItemHelp string + SpecialTaxRegimeHelp string + SpecialTaxRegimesList []SpecialTaxRegimeResponse + SupportsCancellation bool + UsesServiceListItem bool + UsesSpecialTaxRegimes bool + func (f MunicipalSettingsResponse) IsFailure() bool + func (f MunicipalSettingsResponse) IsNoContent() bool + func (f MunicipalSettingsResponse) IsSuccess() bool + type Negativity interface + CancelById func(ctx context.Context, negativityId string) (*NegativityResponse, error) + Create func(ctx context.Context, body CreateNegativityRequest) (*NegativityResponse, error) + GetAll func(ctx context.Context, filter GetAllNegativitiesRequest) (*Pageable[NegativityResponse], error) + GetById func(ctx context.Context, negativityId string) (*NegativityResponse, error) + GetChargesAvailableForDunning func(ctx context.Context, filter PageableDefaultRequest) (*Pageable[ChargesAvailableForDunningResponse], error) + GetHistoryById func(ctx context.Context, negativityId string, filter PageableDefaultRequest) (*Pageable[NegativityHistoryResponse], error) + GetPaymentsById func(ctx context.Context, negativityId string, filter PageableDefaultRequest) (*Pageable[NegativityPaymentsResponse], error) + ResendDocumentsById func(ctx context.Context, negativityId string, ...) (*NegativityResponse, error) + Simulate func(ctx context.Context, chargeId string) (*NegativitySimulateResponse, error) + func NewNegativity(env Env, accessToken string) Negativity + type NegativityHistoryResponse struct + Description string + EventDate Date + Status NegativityStatus + type NegativityPaymentsResponse struct + Description string + PaymentDate Date + Value float64 + type NegativityResendDocumentsRequest struct + Documents *os.File + type NegativityResponse struct + CanBeCancelled bool + CancellationFeeValue float64 + CannotBeCancelledReason string + DenialReason string + Description string + DunningNumber int + Errors []ErrorResponse + FeeValue float64 + Id string + IsNecessaryResendDocumentation bool + NetValue float64 + Payment string + ReceivedInCashFeeValue float64 + RequestDate Date + Status NegativityStatus + Type NegativityType + Value float64 + func (n NegativityResponse) IsFailure() bool + func (n NegativityResponse) IsNoContent() bool + func (n NegativityResponse) IsSuccess() bool + type NegativitySimulateResponse struct + Errors []ErrorResponse + Payment string + TypeSimulations []NegativityTypeSimulationResponse + Value float64 + func (n NegativitySimulateResponse) IsFailure() bool + func (n NegativitySimulateResponse) IsNoContent() bool + func (n NegativitySimulateResponse) IsSuccess() bool + type NegativityStatus string + const NegativityStatusAwaitingApproval + const NegativityStatusAwaitingCancellation + const NegativityStatusCancelled + const NegativityStatusDenied + const NegativityStatusPaid + const NegativityStatusPartiallyPaid + const NegativityStatusPending + const NegativityStatusProcessed + type NegativityType string + const NegativityTypeCreditBureau + type NegativityTypeSimulationResponse struct + FeeValue float64 + IsAllowed bool + NetValue float64 + NotAllowedReason string + StartDate Date + Type NegativityType + type Notification interface + GetAllByCustomer func(ctx context.Context, customerId string) (*Pageable[NotificationResponse], error) + UpdateById func(ctx context.Context, notificationId string, body UpdateNotificationRequest) (*NotificationResponse, error) + UpdateManyByCustomer func(ctx context.Context, body UpdateManyNotificationsRequest) (*UpdateManyNotificationsResponse, error) + func NewNotification(env Env, accessToken string) Notification + type NotificationEvent string + const NotificationEventPaymentCreated + const NotificationEventPaymentDuedateWarning + const NotificationEventPaymentOverdue + const NotificationEventPaymentReceived + const NotificationEventPaymentUpdated + const NotificationEventSendLinhaDigitavel + type NotificationResponse struct + Customer string + Deleted bool + EmailEnabledForCustomer bool + EmailEnabledForProvider bool + Enabled bool + Errors []ErrorResponse + Event NotificationEvent + Id string + PhoneCallEnabledForCustomer bool + ScheduleOffset int + SmsEnabledForCustomer bool + SmsEnabledForProvider bool + WhatsappEnabledForCustomer bool + func (n NotificationResponse) IsFailure() bool + func (n NotificationResponse) IsNoContent() bool + func (n NotificationResponse) IsSuccess() bool + type Order string + const OrderAsc + const OrderDesc + type Pageable struct + Data []T + Errors []ErrorResponse + HasMore bool + Limit int + Offset int + TotalCount int + func (p Pageable[T]) IsFailure() bool + func (p Pageable[T]) IsNoContent() bool + func (p Pageable[T]) IsSuccess() bool + type PageableDefaultRequest struct + Limit int + Offset int + type PayPixQrCodeRequest struct + Description string + QrCode PixQrCodeRequest + ScheduleDate Date + Value float64 + type PayWithCreditCardRequest struct + CreditCard *CreditCardRequest + CreditCardHolderInfo *CreditCardHolderInfoRequest + CreditCardToken string + type PaymentImageDataLink struct + DownloadUrl string + Extension string + OriginalName string + PreviewUrl string + Size int + type PaymentLink interface + Create func(ctx context.Context, body CreatePaymentLinkRequest) (*PaymentLinkResponse, error) + DeleteById func(ctx context.Context, paymentLinkId string) (*DeleteResponse, error) + DeleteImageById func(ctx context.Context, paymentLinkId, imageId string) (*DeleteResponse, error) + GetAll func(ctx context.Context, filter GetAllPaymentLinksRequest) (*Pageable[PaymentLinkResponse], error) + GetById func(ctx context.Context, paymentLinkId string) (*PaymentLinkResponse, error) + GetImageById func(ctx context.Context, paymentLinkId, imageId string) (*PaymentLinkImageResponse, error) + GetImagesById func(ctx context.Context, paymentLinkId string) (*Pageable[PaymentLinkImageResponse], error) + RestoreById func(ctx context.Context, paymentLinkId string) (*PaymentLinkResponse, error) + SendImageById func(ctx context.Context, paymentLinkId string, body SendImagePaymentLinksRequest) (*PaymentLinkImageResponse, error) + UpdateById func(ctx context.Context, paymentLinkId string, body UpdatePaymentLinkRequest) (*PaymentLinkResponse, error) + UpdateImageAsMainById func(ctx context.Context, paymentLinkId, imageId string) (*PaymentLinkImageResponse, error) + func NewPaymentLink(env Env, accessToken string) PaymentLink + type PaymentLinkImageResponse struct + Errors []ErrorResponse + Id string + Image PaymentImageDataLink + Main bool + func (p PaymentLinkImageResponse) IsFailure() bool + func (p PaymentLinkImageResponse) IsNoContent() bool + func (p PaymentLinkImageResponse) IsSuccess() bool + type PaymentLinkResponse struct + Active bool + BillingType BillingType + ChargeType ChargeType + Description string + DueDateLimitDays int + EndDate Date + Errors []ErrorResponse + Id string + MaxInstallmentCount int + Name string + NotificationEnabled bool + SubscriptionCycle SubscriptionCycle + Url string + Value float64 + func (p PaymentLinkResponse) IsFailure() bool + func (p PaymentLinkResponse) IsNoContent() bool + func (p PaymentLinkResponse) IsSuccess() bool + type PaymentStatisticResponse struct + Errors []ErrorResponse + NetValue float64 + Quantity int + Value float64 + func (s PaymentStatisticResponse) IsFailure() bool + func (s PaymentStatisticResponse) IsNoContent() bool + func (s PaymentStatisticResponse) IsSuccess() bool + type PersonType string + const PersonTypeJuridical + const PersonTypePhysical + type Pix interface + CancelTransactionById func(ctx context.Context, pixTransactionId string) (*PixCancelTransactionResponse, error) + CreateKey func(ctx context.Context) (*PixKeyResponse, error) + CreateStaticKey func(ctx context.Context, body CreatePixKeyStaticRequest) (*QrCodeResponse, error) + DecodeQrCode func(ctx context.Context, body PixQrCodeRequest) (*DecodePixQrCodeResponse, error) + DeleteKeyById func(ctx context.Context, pixKeyId string) (*PixKeyResponse, error) + GetAllKeys func(ctx context.Context, filter GetAllPixKeysRequest) (*Pageable[PixKeyResponse], error) + GetAllTransactions func(ctx context.Context, filter GetAllPixTransactionsRequest) (*Pageable[PixTransactionResponse], error) + GetKeyById func(ctx context.Context, pixKeyId string) (*PixKeyResponse, error) + GetTransactionById func(ctx context.Context, pixTransactionId string) (*PixTransactionResponse, error) + PayQrCode func(ctx context.Context, body PayPixQrCodeRequest) (*PixTransactionResponse, error) + func NewPix(env Env, accessToken string) Pix + type PixCancelTransactionResponse struct + CanBeCanceled bool + ChangeValue float64 + Description string + EffectiveDate Date + EndToEndIdentifier string + Errors []ErrorResponse + ExternalAccount *PixExternalAccountResponse + Finality PixTransactionFinality + Id string + OriginType PixTransactionOriginType + OriginalTransaction string + Payment string + QrCode string + RefundedValue float64 + RefusalReason string + ScheduledDate Date + Status PixTransactionStatus + TransactionReceiptUrl string + Type PixTransactionType + Value float64 + func (p PixCancelTransactionResponse) IsFailure() bool + func (p PixCancelTransactionResponse) IsNoContent() bool + func (p PixCancelTransactionResponse) IsSuccess() bool + type PixExternalAccountResponse struct + AddressKey string + AddressKeyType string + CpfCnpj string + Ispb int + IspbName string + Name string + type PixKeyQrCodeResponse struct + EncodedImage string + Payload string + type PixKeyResponse struct + CanBeDeleted bool + CannotBeDeletedReason string + DateCreated Date + Errors []ErrorResponse + Id string + Key string + QrCode *PixKeyQrCodeResponse + Status PixKeyStatus + Type PixKeyType + func (p PixKeyResponse) IsFailure() bool + func (p PixKeyResponse) IsNoContent() bool + func (p PixKeyResponse) IsSuccess() bool + type PixKeyStatus string + const PixKeyStatusAwaitingAccountDeletion + const PixKeyStatusAwaitingActivation + const PixKeyStatusAwaitingActive + const PixKeyStatusAwaitingDeleted + const PixKeyStatusAwaitingDeletion + const PixKeyStatusAwaitingError + type PixKeyType string + const PixKeyTypeCnpj + const PixKeyTypeCpf + const PixKeyTypeEmail + const PixKeyTypeEvp + const PixKeyTypePhone + type PixPayerResponse struct + CpfCnpj string + Name string + type PixQrCodeRequest struct + ChangeValue float64 + Payload string + type PixQrCodeResponse struct + ConciliationIdentifier string + Discount float64 + DueDate Date + ExpirationDate Date + Fine float64 + Interest float64 + OriginalValue float64 + Payer *PixPayerResponse + type PixQrCodeType string + const PixQrCodeTypeDynamic + const PixQrCodeTypeStatic + type PixReceiverResponse struct + Account string + AccountType AccountType + Agency string + CpfCnpj string + Ispb int + IspbName string + Name string + PersonType PersonType + TradingName string + type PixTransactionFinality string + const PixTransactionFinalityChange + const PixTransactionFinalityWithdrawal + type PixTransactionOriginType string + const PixTransactionOriginAddressKey + const PixTransactionOriginDynamicQrcode + const PixTransactionOriginExternalDebit + const PixTransactionOriginManual + const PixTransactionOriginStaticQrcode + type PixTransactionResponse struct + CanBeCanceled bool + ChangeValue float64 + Description string + EffectiveDate Date + EndToEndIdentifier string + Errors []ErrorResponse + ExternalAccount *PixExternalAccountResponse + Finality PixTransactionFinality + Id string + OriginType PixTransactionOriginType + OriginalTransaction string + Payment string + QrCode *PixQrCodeResponse + RefundedValue float64 + RefusalReason string + ScheduledDate Date + Status PixTransactionStatus + TransactionReceiptUrl string + Type PixTransactionType + Value float64 + func (p PixTransactionResponse) IsFailure() bool + func (p PixTransactionResponse) IsNoContent() bool + func (p PixTransactionResponse) IsSuccess() bool + type PixTransactionStatus string + const PixTransactionStatusAwaitingRequest + const PixTransactionStatusCancelled + const PixTransactionStatusDone + const PixTransactionStatusError + const PixTransactionStatusRefused + const PixTransactionStatusRequested + const PixTransactionStatusScheduled + type PixTransactionType string + const PixTransactionTypeCredit + const PixTransactionTypeCreditRefund + const PixTransactionTypeDebit + const PixTransactionTypeDebitRefund + const PixTransactionTypeDebitRefundCancellation + type QrCodeFormat string + const QrCodeFormatAll + const QrCodeFormatImage + const QrCodeFormatPayload + type QrCodeResponse struct + AllowsMultiplePayments bool + EncodedImage string + Errors []ErrorResponse + ExpirationDate Date + Id string + Payload string + func (q QrCodeResponse) IsFailure() bool + func (q QrCodeResponse) IsNoContent() bool + func (q QrCodeResponse) IsSuccess() bool + type RefundRequest struct + Description string + Value float64 + type RefundResponse struct + DateCreated Date + Description string + Status RefundStatus + TransactionReceiptUrl string + Value float64 + type RefundStatus string + const RefundStatusCancelled + const RefundStatusDone + const RefundStatusPending + type Request interface + func NewRequest[T any](ctx context.Context, env Env, accessToken string) Request[T] + type SaveFiscalInfoRequest struct + AccessToken *string + CertificateFile *os.File + CertificatePassword *string + Cnae *string + CulturalProjectsPromoter *bool + Email string + LoteNumber *int + MunicipalInscription *string + Password *string + RpsNumber *int + RpsSerie *string + ServiceListItem *string + SimplesNacional *bool + SpecialTaxRegime *string + Username *string + type SaveInvoiceCustomizationRequest struct + Enabled bool + FontColor string + InfoBackgroundColor string + LogoBackgroundColor string + LogoFile *os.File + type SaveWebhookSettingRequest struct + ApiVersion string + AuthToken string + Email string + Enabled *bool + Interrupted *bool + Url string + type ScheduleInvoiceRequest struct + Customer string + Deductions float64 + EffectiveDate Date + ExternalReference string + Installment string + MunicipalServiceCode string + MunicipalServiceId string + MunicipalServiceName string + Observations string + Payment string + ServiceDescription string + Taxes InvoiceTaxesRequest + UpdatePayment bool + Value float64 + type SendImagePaymentLinksRequest struct + Image *os.File + Main bool + type SendWhiteLabelDocumentRequest struct + DocumentFile *os.File + Type SubaccountDocumentType + type SortPaymentBookField string + type SortSubscriptionField string + const SortSubscriptionFieldDateCreated + type SpecialTaxRegimeResponse struct + Label string + Value string + type SplitRefusalReason string + const SplitRefusalReason1 + type SplitRequest struct + FixedValue float64 + PercentualValue float64 + TotalFixedValue float64 + WalletId string + type SplitResponse struct + FixedValue float64 + Id string + PercentualValue float64 + RefusalReason SplitRefusalReason + Status SplitStatus + TotalValue float64 + WalletId string + type SplitStatisticResponse struct + Errors []ErrorResponse + Income float64 + Outcome float64 + func (s SplitStatisticResponse) IsFailure() bool + func (s SplitStatisticResponse) IsNoContent() bool + func (s SplitStatisticResponse) IsSuccess() bool + type SplitStatus string + const SplitStatusAwaitingCredit + const SplitStatusCancelled + const SplitStatusDone + const SplitStatusPending + const SplitStatusRefused + type Subaccount interface + Create func(ctx context.Context, body CreateSubaccountRequest) (*SubaccountResponse, error) + DeleteWhiteLabelDocumentSentById func(ctx context.Context, documentSentId string) (*DeleteResponse, error) + GetAll func(ctx context.Context, filter GetAllSubaccountsRequest) (*Pageable[SubaccountResponse], error) + GetById func(ctx context.Context, subaccountId string) (*SubaccountResponse, error) + GetDocumentSentById func(ctx context.Context, documentSentId string) (*SubaccountDocumentSentResponse, error) + GetPendingDocuments func(ctx context.Context) (*SubaccountDocumentsResponse, error) + SendWhiteLabelDocument func(ctx context.Context, documentId string, body SendWhiteLabelDocumentRequest) (*SubaccountDocumentSentResponse, error) + UpdateWhiteLabelDocumentSentById func(ctx context.Context, documentSentId string, ...) (*SubaccountDocumentSentResponse, error) + func NewSubaccount(env Env, accessToken string) Subaccount + type SubaccountDocumentResponse struct + Description string + Documents []any + Id string + Responsible DocumentResponsibleResponse + Status SubaccountDocumentStatus + Title string + Type SubaccountDocumentType + type SubaccountDocumentSentResponse struct + Errors []ErrorResponse + Id string + Status SubaccountDocumentStatus + func (s SubaccountDocumentSentResponse) IsFailure() bool + func (s SubaccountDocumentSentResponse) IsNoContent() bool + func (s SubaccountDocumentSentResponse) IsSuccess() bool + type SubaccountDocumentStatus string + const SubaccountDocumentStatusApproved + const SubaccountDocumentStatusNotSent + const SubaccountDocumentStatusPending + const SubaccountDocumentStatusRejected + type SubaccountDocumentType string + const SubaccountDocumentTypeCustom + const SubaccountDocumentTypeEntrepreneurRequirement + const SubaccountDocumentTypeIdentification + const SubaccountDocumentTypeMinutesOfElection + const SubaccountDocumentTypeSocialContract + type SubaccountDocumentsResponse struct + Data []SubaccountDocumentResponse + Errors []ErrorResponse + RejectReasons string + func (s SubaccountDocumentsResponse) IsFailure() bool + func (s SubaccountDocumentsResponse) IsNoContent() bool + func (s SubaccountDocumentsResponse) IsSuccess() bool + type SubaccountResponse struct + AccountNumber AccountBankInfoResponse + Address string + AddressNumber string + ApiKey string + BirthDate Date + City int + CompanyType CompanyType + Complement string + Country string + CpfCnpj string + Email string + Errors []ErrorResponse + Id string + LoginEmail string + MobilePhone string + Name string + PersonType PersonType + Phone string + PostalCode string + Province string + Site string + WalletId string + func (s SubaccountResponse) IsFailure() bool + func (s SubaccountResponse) IsNoContent() bool + func (s SubaccountResponse) IsSuccess() bool + type Subscription interface + Create func(ctx context.Context, body CreateSubscriptionRequest) (*SubscriptionResponse, error) + CreateInvoiceSettingById func(ctx context.Context, subscriptionId string, body CreateInvoiceSettingRequest) (*InvoiceSettingResponse, error) + DeleteById func(ctx context.Context, subscriptionId string) (*DeleteResponse, error) + DeleteInvoiceSettingById func(ctx context.Context, subscriptionId string) (*DeleteResponse, error) + GetAll func(ctx context.Context, filter GetAllSubscriptionsRequest) (*Pageable[SubscriptionResponse], error) + GetAllChargesBySubscription func(ctx context.Context, subscriptionId string, ...) (*Pageable[ChargeResponse], error) + GetAllInvoicesBySubscription func(ctx context.Context, subscriptionId string, ...) (*Pageable[InvoiceResponse], error) + GetById func(ctx context.Context, subscriptionId string) (*SubscriptionResponse, error) + GetInvoiceSettingById func(ctx context.Context, subscriptionId string) (*InvoiceSettingResponse, error) + GetPaymentBookById func(ctx context.Context, subscriptionId string, ...) (*FileTextPlainResponse, error) + UpdateById func(ctx context.Context, subscriptionId string, body UpdateSubscriptionRequest) (*SubscriptionResponse, error) + UpdateInvoiceSettingsById func(ctx context.Context, subscriptionId string, body UpdateInvoiceSettingRequest) (*InvoiceSettingResponse, error) + func NewSubscription(env Env, accessToken string) Subscription + type SubscriptionCycle string + const SubscriptionCycleBimonthly + const SubscriptionCycleBiweekly + const SubscriptionCycleMonthly + const SubscriptionCycleQuarterly + const SubscriptionCycleSemiannually + const SubscriptionCycleWeekly + const SubscriptionCycleYearly + type SubscriptionPaymentBookRequest struct + Month int + Order Order + Sort SortPaymentBookField + Year int + type SubscriptionResponse struct + BillingType BillingType + Customer string + Cycle SubscriptionCycle + DateCreated Date + Deleted bool + Description string + Discount *DiscountResponse + EndDate Date + Errors []ErrorResponse + ExternalReference string + Fine *FineResponse + Id string + Interest *InterestResponse + MaxPayments int + NextDueDate Date + Refunds []RefundResponse + Status SubscriptionStatus + Value float64 + func (s SubscriptionResponse) IsFailure() bool + func (s SubscriptionResponse) IsNoContent() bool + func (s SubscriptionResponse) IsSuccess() bool + type SubscriptionStatus string + const SubscriptionStatusActive + const SubscriptionStatusExpired + const SubscriptionStatusInactive + type Transfer interface + CancelById func(ctx context.Context, transferId string) (*TransferResponse, error) + GetAll func(ctx context.Context, filter GetAllTransfersRequest) (*Pageable[TransferResponse], error) + GetById func(ctx context.Context, transferId string) (*TransferResponse, error) + TransferToAsaas func(ctx context.Context, body TransferToAssasRequest) (*TransferResponse, error) + TransferToBank func(ctx context.Context, body TransferToBankRequest) (*TransferResponse, error) + func NewTransfer(env Env, accessToken string) Transfer + type TransferAsaasStatus string + type TransferOperationType string + const TransferOperationTypeInternal + const TransferOperationTypePix + const TransferOperationTypeTed + type TransferResponse struct + Authorized bool + BackAccount *BackAccountResponse + DateCreated Date + Description string + EffectiveDate Date + EndToEndIdentifier string + Errors []ErrorResponse + FailReason string + Id string + NetValue float64 + OperationType TransferOperationType + ScheduleDate Date + Status TransferStatus + TransactionReceiptUrl string + TransferFee float64 + Type TransferType + Value float64 + WalletId string + func (t TransferResponse) IsFailure() bool + func (t TransferResponse) IsNoContent() bool + func (t TransferResponse) IsSuccess() bool + type TransferStatus string + const TransferStatusBankProcessing + const TransferStatusCancelled + const TransferStatusDone + const TransferStatusFailed + const TransferStatusPending + type TransferToAssasRequest struct + Value float64 + WalletId string + type TransferToBankRequest struct + BankAccount BackAccountRequest + Description string + OperationType TransferOperationType + PixAddressKey string + PixAddressKeyType PixKeyType + ScheduleDate Date + Value float64 + type TransferType string + const TransferTypeAsaasAccount + const TransferTypeBankAccount + type UpdateAccountRequest struct + Address *string + AddressNumber *string + BirthDate Date + CompanyType *CompanyType + Complement *string + CpfCnpj string + Email string + MobilePhone *string + PersonType PersonType + Phone *string + PostalCode string + Province *string + Site *string + type UpdateChargeDocumentDefinitionsRequest struct + AvailableAfterPayment bool + Type DocumentType + type UpdateChargeRequest struct + BillingType BillingType + Callback *CallbackRequest + Customer string + Description *string + Discount *DiscountRequest + DueDate Date + ExternalReference *string + Fine *FineRequest + InstallmentCount int + InstallmentValue float64 + Interest *InterestRequest + PostalService *bool + Split []SplitRequest + Value float64 + type UpdateCustomerRequest struct + AdditionalEmails *string + Address *string + AddressNumber *string + Company *string + Complement *string + CpfCnpj *string + Email *string + ExternalReference *string + GroupName *string + MobilePhone *string + MunicipalInscription *string + Name string + NotificationDisabled *bool + Observations *string + Phone *string + PostalCode *string + Province *string + StateInscription *string + type UpdateInstallmentSplitsResponse struct + Errors []ErrorResponse + Splits []SplitResponse + func (u UpdateInstallmentSplitsResponse) IsFailure() bool + func (u UpdateInstallmentSplitsResponse) IsNoContent() bool + func (u UpdateInstallmentSplitsResponse) IsSuccess() bool + type UpdateInvoiceRequest struct + Deductions *float64 + EffectiveDate Date + ExternalReference *string + MunicipalServiceCode *string + MunicipalServiceId *string + MunicipalServiceName *string + Observations string + ServiceDescription string + Taxes *InvoiceTaxesRequest + UpdatePayment *bool + Value float64 + type UpdateInvoiceSettingRequest struct + DaysBeforeDueDate *int + Deductions *float64 + EffectiveDatePeriod EffectiveDatePeriod + Observations *string + ReceivedOnly *bool + Taxes InvoiceTaxesRequest + type UpdateManyNotificationRequest struct + EmailEnabledForCustomer *bool + EmailEnabledForProvider *bool + Enabled *bool + Id string + PhoneCallEnabledForCustomer *bool + ScheduleOffset *int + SmsEnabledForCustomer *bool + SmsEnabledForProvider *bool + WhatsappEnabledForCustomer *bool + type UpdateManyNotificationsRequest struct + Customer string + Notifications []UpdateManyNotificationRequest + type UpdateManyNotificationsResponse struct + Errors []ErrorResponse + Notifications []NotificationResponse + func (u UpdateManyNotificationsResponse) IsFailure() bool + func (u UpdateManyNotificationsResponse) IsNoContent() bool + func (u UpdateManyNotificationsResponse) IsSuccess() bool + type UpdateNotificationRequest struct + EmailEnabledForCustomer *bool + EmailEnabledForProvider *bool + Enabled *bool + PhoneCallEnabledForCustomer *bool + ScheduleOffset *int + SmsEnabledForCustomer *bool + SmsEnabledForProvider *bool + WhatsappEnabledForCustomer *bool + type UpdatePaymentLinkRequest struct + BillingType BillingType + Callback *CallbackRequest + ChargeType ChargeType + Description *string + DueDateLimitDays int + EndDate Date + MaxInstallmentCount int + Name string + NotificationEnabled *bool + SubscriptionCycle *SubscriptionCycle + Value *float64 + type UpdateSplitsRequest struct + Splits []SplitRequest + type UpdateSubscriptionRequest struct + BillingType BillingType + Cycle SubscriptionCycle + Description *string + Discount *DiscountRequest + EndDate Date + ExternalReference string + Fine *FineRequest + Interest *InterestRequest + NextDueDate Date + Status SubscriptionStatus + UpdatePendingPayments bool + Value float64 + type UpdateWhiteLabelDocumentSentRequest struct + DocumentFile *os.File + type UploadChargeDocumentRequest struct + AvailableAfterPayment bool + File *os.File + Type DocumentType + type Webhook interface + GetSetting func(ctx context.Context, typeWebhook WebhookType) (*WebhookResponse, error) + SaveSetting func(ctx context.Context, typeWebhook WebhookType, body SaveWebhookSettingRequest) (*WebhookResponse, error) + func NewWebhook(env Env, accessToken string) Webhook + type WebhookResponse struct + ApiVersion int + AuthToken string + Email string + Enabled bool + Errors []ErrorResponse + Interrupted bool + Type WebhookType + Url string + func (w WebhookResponse) IsFailure() bool + func (w WebhookResponse) IsNoContent() bool + func (w WebhookResponse) IsSuccess() bool + type WebhookType string + const WebhookTypeAccountStatus + const WebhookTypeBill + const WebhookTypeInvoice + const WebhookTypeMobilePhoneRecharge + const WebhookTypePayment + const WebhookTypeReceivableAnticipation + const WebhookTypeTransfer + func (t WebhookType) PathUrl() string v1.0.0-alpha Dec 1, 2023