Skip to content

README.md

Latest commit

 

History

History
712 lines (638 loc) · 161 KB

README.md

File metadata and controls

712 lines (638 loc) · 161 KB

AsaasSdk Java SDK 1.0.1

Welcome to the AsaasSdk SDK documentation. This guide will help you get started with integrating and using the AsaasSdk SDK in your project.

This SDK was generated by liblab

Versions

  • API version: 3.0.0
  • SDK version: 1.0.1

About the API

API pública de integração com a plataforma Asaas.

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Java >= 1.8

Installation

If you use Maven, place the following within the dependency tag in your pom.xml file:

<dependency>
    <groupId>com.asaas</groupId>
    <artifactId>api-sdk</artifactId>
    <version>1.0.1</version>
</dependency>

If you use Gradle, paste the next line inside the dependencies block of your build.gradle file:

implementation group: com.asaas, name: api-sdk, version: 1.0.1

If you use JAR files, package the SDK by running the following command:

mvn compile assembly:single

Then, add the JAR file to your project's classpath.

Authentication

API Key Authentication

The AsaasSdk API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;

public class Main {

  public static void main(String[] args) {
    ApiKeyAuthConfig apiKeyAuthConfig = ApiKeyAuthConfig.builder()
      .apiKey("YOUR_API_KEY")
      .apiKeyHeader("YOUR_API_KEY_HEADER")
      .build();

    AsaasSdkConfig config = AsaasSdkConfig.builder().apiKeyAuthConfig(apiKeyAuthConfig).build();

    AsaasSdk asaasSdk = new AsaasSdk(config);
  }
}

If you need to set or update the API key after initializing the SDK, you can use:

asaasSdk.setApiKey('YOUR_API_KEY');
asaasSdk.setApiKeyHeader('YOUR_API_KEY_HEADER');

Environments

The SDK supports different environments for various stages of development and deployment.

Here are the available environments:

DEFAULT("https://api.asaas.com/"),
PRODUCTION("https://api.asaas.com/"),
SANDBOX("https://api-sandbox.asaas.com/");

Setting an Environment

To configure the SDK to use a specific environment, you can set the base URL as follows:

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.http.Environment;

public class Main {

  public static void main(String[] args) {
    AsaasSdkConfig config = AsaasSdkConfig.builder().build();
    AsaasSdk asaasSdk = new AsaasSdk(config);

    asaasSdk.setEnvironment(Environment.DEFAULT);
  }
}

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.AsaasSdkConfig;

public class Main {

  public static void main(String[] args) {
    AsaasSdkConfig config = AsaasSdkConfig.builder().timeout(10000).build();
    AsaasSdk asaasSdk = new AsaasSdk(config);
  }
}

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.exceptions.ApiError;
import com.asaas.apisdk.models.ApiPaymentListRequestBillingType;
import com.asaas.apisdk.models.ApiPaymentListRequestInvoiceStatus;
import com.asaas.apisdk.models.ApiPaymentListRequestPaymentStatus;
import com.asaas.apisdk.models.ApiPaymentListResponseDto;
import com.asaas.apisdk.models.ListPaymentsParameters;

public class Main {

  public static void main(String[] args) {
    AsaasSdkConfig config = AsaasSdkConfig.builder()
      .apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
      .build();

    AsaasSdk asaasSdk = new AsaasSdk(config);

    ListPaymentsParameters requestParameters = ListPaymentsParameters.builder()
      .installment("installment")
      .offset(8L)
      .limit(10L)
      .customer("customer")
      .customerGroupName("customerGroupName")
      .billingType(ApiPaymentListRequestBillingType.UNDEFINED)
      .status(ApiPaymentListRequestPaymentStatus.PENDING)
      .subscription("subscription")
      .externalReference("externalReference")
      .paymentDate("paymentDate")
      .invoiceStatus(ApiPaymentListRequestInvoiceStatus.SCHEDULED)
      .estimatedCreditDate("estimatedCreditDate")
      .pixQrCodeId("pixQrCodeId")
      .anticipated(false)
      .anticipable(true)
      .dateCreatedGe("dateCreated[ge]")
      .dateCreatedLe("dateCreated[le]")
      .paymentDateGe("paymentDate[ge]")
      .paymentDateLe("paymentDate[le]")
      .estimatedCreditDateGe("estimatedCreditDate[ge]")
      .estimatedCreditDateLe("estimatedCreditDate[le]")
      .dueDateGe("dueDate[ge]")
      .dueDateLe("dueDate[le]")
      .user("user")
      .build();

    try {
      ApiPaymentListResponseDto response = asaasSdk.payment.listPayments(requestParameters);

      System.out.println(response);
    } catch (ApiError e) {
      e.printStackTrace();
    }

    System.exit(0);
  }
}

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:
Name
PaymentService
SandboxActionsService
PaymentWithSummaryDataService
CreditCardService
PaymentRefundService
PaymentSplitService
EscrowAccountService
PaymentDocumentService
CustomerService
NotificationService
InstallmentService
SubscriptionService
PixService
PixTransactionService
AnticipationService
RecurringPixService
PaymentLinkService
CheckoutService
TransferService
PaymentDunningService
BillService
MobilePhoneRechargeService
CreditBureauReportService
FinancialTransactionService
FinanceService
AccountInfoService
InvoiceService
FiscalInfoService
WebhookService
SubaccountService
AccountDocumentService
ChargebackService

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:
Name Description
ApiPaymentListResponseDto
ApiPaymentListRequestBillingType Filter by billing type
ApiPaymentListRequestPaymentStatus Filter by status
ApiPaymentListRequestInvoiceStatus Filter to return charges that have or do not have an invoice
ApiPaymentSaveRequestDto
ApiPaymentGetResponseDto
ApiPaymentSaveWithCreditCardRequestDto
ApiPaymentPayWithCreditCardRequestDto
ApiPaymentBillingInfoResponseDto
ApiPaymentViewingInfoResponseDto
ApiPaymentUpdateRequestDto
ApiPaymentDeleteResponseDto
ApiPaymentStatusResponseDto
ApiPaymentRefundRequestDto
ApiPaymentIdentificationFieldResponseDto
ApiPaymentPixQrCodeResponseDto
ApiPaymentReceiveInCashRequestDto
ApiPaymentSimulateRequestDto
ApiPaymentSimulateResponseDto
ApiPaymentCustodyGetResponseDto
ApiPaymentLimitsResponseDto
ApiPaymentLeanListResponseDto
ApiPaymentLeanGetResponseDto
ApiPaymentLeanSaveWithCreditCardResponseDto
ApiCreditCardTokenizeRequestDto
ApiCreditCardTokenizeResponseDto
ApiPaymentRefundListResponseDto
ApiPaymentBankSlipRefundResponseDto
ApiPaymentSplitGetResponseDto
ApiPaymentSplitListResponseDto
ApiPaymentSplitListPaidRequestPaymentSplitStatus Filter by status
ApiPaymentSplitListReceivedRequestPaymentSplitStatus Filter by status
ApiPaymentDocumentListResponseDto
ApiPaymentDocumentSaveRequestDto
ApiPaymentDocumentGetResponseDto
ApiPaymentDocumentUpdateRequestDto
ApiPaymentDocumentDeleteResponseDto
ApiCustomerAccountListResponseDto
ApiCustomerAccountSaveRequestDto
ApiCustomerAccountGetResponseDto
ApiCustomerAccountUpdateRequestDto
ApiCustomerAccountDeleteResponseDto
ApiNotificationListResponseDto
ApiNotificationUpdateRequestDto
ApiNotificationGetResponseDto
ApiNotificationBatchUpdateRequestDto
ApiNotificationBatchUpdateResponseDto
ApiInstallmentListResponseDto
ApiInstallmentSaveRequestDto
ApiInstallmentGetResponseDto
ApiInstallmentSaveWithCreditCardRequestDto
ApiInstallmentDeleteResponseDto
ApiInstallmentListPaymentsRequestPaymentStatus Filter by payment status
ApiInstallmentUpdateSplitRequestDto
ApiInstallmentUpdateSplitResponseDto
ApiSubscriptionListResponseDto
ApiSubscriptionListRequestBillingType Filter by billing type
ApiSubscriptionListRequestSubscriptionStatus Filter by status
ApiSubscriptionSaveRequestDto
ApiSubscriptionGetResponseDto
ApiSubscriptionSaveWithCreditCardRequestDto
ApiSubscriptionSaveWithCreditCardResponseDto
ApiSubscriptionUpdateRequestDto
ApiSubscriptionDeleteResponseDto
ApiSubscriptionUpdateCreditCardRequestDto
ApiSubscriptionListPaymentsRequestPaymentStatus Filter by payment status
ApiSubscriptionInvoiceConfigGetResponseDto
ApiSubscriptionConfigureInvoiceRequestDto
ApiSubscriptionInvoiceConfigUpdateRequestDto
ApiSubscriptionDeleteInvoiceConfigResponseDto
ApiCustomerInvoiceListResponseDto
ApiSubscriptionGetInvoicesRequestInvoiceStatus Filter by invoice status
ApiPixAddressKeyListResponseDto
ApiPixAddressKeyListRequestPixAddressKeyStatus Filter by current key status
ApiPixAddressKeySaveRequestDto
ApiPixAddressKeyGetResponseDto
ApiPixQrCodeSaveRequestDto
ApiPixQrCodeSaveResponseDto
ApiPixQrCodeDeleteResponseDto
ApiPixTokenBucketGetAddressKeyResponseDto
ApiPixTransactionSaveRequestDto
ApiPixTransactionGetResponseDto
ApiPixQrCodeDecodeRequestDto
ApiPixQrCodeDecodeResponseDto
ApiPixTransactionListResponseDto
ApiPixTransactionListRequestPixTransactionStatus Filter by transaction status
ApiPixTransactionListRequestPixTransactionType Filter by transaction type
ApiReceivableAnticipationGetResponseDto
ApiReceivableAnticipationListResponseDto
ApiReceivableAnticipationListRequestReceivableAnticipationStatus Filter by status
ApiReceivableAnticipationSaveRequestDto
ApiReceivableAnticipationSimulateRequestDto
ApiReceivableAnticipationSimulateResponseDto
ApiReceivableAnticipationConfigurationGetResponseDto
ApiReceivableAnticipationConfigurationUpdateRequestDto
ApiReceivableAnticipationLimitsResponseDto
ApiPixTransactionRecurringCheckoutScheduleListResponseDto
ApiPixTransactionRecurringCheckoutScheduleListRequestRecurringCheckoutScheduleStatus Filter by recurrence status
ApiPixTransactionRecurringCheckoutScheduleGetResponseDto
ApiPixTransactionRecurringCheckoutScheduleListItemsResponseDto
ApiPixTransactionRecurringCheckoutScheduleGetItemResponseDto
ApiPaymentCampaignListResponseDto
ApiPaymentCampaignSaveRequestDto
ApiPaymentCampaignGetResponseDto
ApiPaymentCampaignUpdateRequestDto
ApiPaymentCampaignDeleteResponseDto
ApiPaymentCampaignFileListResponseDto
ApiPaymentCampaignFileSaveRequestDto
ApiPaymentCampaignFileGetResponseDto
ApiPaymentCampaignFileDeleteResponseDto
ApiCheckoutSessionSaveRequestDto
ApiCheckoutSessionResponseDto
ApiTransferListResponseDto
ApiTransferSaveRequestDto
ApiTransferGetResponseDto
ApiTransferSaveInternalTransferRequestDto
ApiTransferSaveInternalTransferResponseDto
ApiPaymentDunningListResponseDto
ApiPaymentDunningListRequestPaymentDunningStatus Filter by payment dunning status
ApiPaymentDunningListRequestPaymentDunningType Filter by type of payment dunning
ApiPaymentDunningSaveRequestDto
ApiPaymentDunningShowResponseDto
ApiPaymentDunningSimulateResponseDto
ApiPaymentDunningListHistoryResponseDto
ApiPaymentDunningListPartialPaymentsResponseDto
ApiPaymentDunningPaymentsAvailableForDunningResponseDto
ApiPaymentDunningSaveDocumentsRequestDto
ApiPaymentDunningSaveDocumentsResponseDto
ApiPaymentDunningCancelResponseDto
ApiBillListResponseDto
ApiBillSaveRequestDto
ApiBillGetResponseDto
ApiBillSimulateRequestDto
ApiBillSimulateResponseDto
ApiMobilePhoneRechargeListResponseDto
ApiMobilePhoneRechargeSaveRequestDto
ApiMobilePhoneRechargeGetResponseDto
ApiMobilePhoneRechargeFindProviderResponseDto
ApiCreditBureauReportListResponseDto
ApiCreditBureauReportSaveRequestDto
ApiCreditBureauReportGetResponseDto
ApiFinancialTransactionListResponseDto
ApiFinanceBalanceResponseDto
ApiFinanceGetPaymentStatisticsResponseDto
ApiFinanceGetPaymentStatisticsRequestBillingType Filter by payment method
ApiFinanceGetPaymentStatisticsRequestPaymentStatus Filter by status
ApiFinanceGetSplitStatisticsResponseDto
ApiCustomerUpdateRequestGetResponseDto
ApiCustomerUpdateRequestSaveRequestDto
ApiPaymentCheckoutConfigGetResponseDto
ApiPaymentCheckoutConfigSaveRequestDto
ApiMyAccountGetAccountNumberResponseDto
ApiMyAccountGetAccountFeesResponseDto
ApiMyAccountGetStatusResponseDto
ApiWalletShowResponseDto
ApiMyAccountDisableAccountResponseDto
ApiCustomerInvoiceListRequestInvoiceStatus Filter by situation
ApiCustomerInvoiceSaveRequestDto
ApiCustomerInvoiceGetResponseDto
ApiCustomerInvoiceUpdateRequestDto
ApiCustomerInvoiceCancelRequestDto
ApiCustomerFiscalInfoMunicipalOptionsGetResponseDto
ApiCustomerFiscalInfoGetResponseDto
ApiCustomerFiscalInfoSaveRequestDto
ApiCustomerFiscalInfoListMunicipalServicesResponseDto
ApiCustomerFiscalInfoListInvoiceNbsCodesResponseDto
ApiCustomerFiscalInfoUpdateUseNationalPortalRequestDto
ApiCustomerFiscalInfoUpdateUseNationalPortalResponseDto
ApiPushNotificationConfigListResponseDto
ApiPushNotificationConfigSaveRequestDto
ApiPushNotificationConfigGetResponseDto
ApiPushNotificationConfigUpdateRequestDto
ApiPushNotificationConfigDeleteResponseDto
ApiCustomerListResponseDto
ApiCustomerSaveRequestDto
ApiCustomerSaveResponseDto
ApiCustomerGetResponseDto
ApiCustomerPaymentCustodyConfigDto
ApiCustomerSaveOrUpdatePaymentCustodyConfigRequestDto
ApiAccountDocumentShowResponseDto
ApiAccountDocumentSaveRequestDto
ApiAccountDocumentGetResponseDto
ApiAccountDocumentUpdateRequestDto
ApiAccountDocumentDeleteResponseDto
ApiChargebackSaveDisputeRequestDto
ApiChargebackSaveDisputeResponseDto
ApiChargebackListResponseDto
ApiChargebackListRequestCreditCardBrand Filter by used card brand.
ApiChargebackListRequestChargebackStatus Filter by chargeback status.
ApiPaymentChargebackResponseDto
ApiPaymentGetResponseBillingType Payment billing type
ApiPaymentSaveWithCreditCardCreditCardDto
ApiPaymentGetResponsePaymentStatus Payment status
ApiPaymentDiscountDto
ApiPaymentFineResponseDto
ApiPaymentInterestResponseDto
ApiPaymentRefundGetResponseDto
ApiPaymentSaveWithCreditCardCreditCardCreditCardBrand Flag of the card used
ApiPaymentDiscountDiscountType Discount type
ApiPaymentSplitGetResponsePaymentSplitCancellationReason Reason for canceling the split
ApiPaymentSplitGetResponsePaymentSplitStatus Split status
ApiPaymentChargebackResponseChargebackStatus Chargeback status
ApiPaymentChargebackResponseChargebackReason Chargeback reason
ApiChargebackCreditCardResponseDto
ApiPaymentChargebackResponseChargebackDisputeStatus Chargeback dispute status.
ApiChargebackCreditCardResponseCreditCardBrand Flag of the card used
ApiPaymentCustodyGetResponsePaymentCustodyStatus Payment escrow status
ApiPaymentCustodyGetResponsePaymentCustodyFinishReason Payment escrow finish reason
ApiPaymentRefundGetResponsePaymentRefundStatus Refund status
ApiPaymentRefundedSplitResponseDto
ApiPaymentSaveRequestBillingType Payment billing type
ApiPaymentInterestRequestDto
ApiPaymentFineRequestDto
ApiPaymentSplitRequestDto
ApiPaymentCallbackRequestDto
ApiPaymentFineRequestFineType Fine type
ApiPaymentSaveWithCreditCardRequestBillingType Payment billing type
ApiCreditCardRequestDto
ApiCreditCardHolderInfoRequestDto
ApiBankSlipBillingInfoResponseDto
ApiCreditCardTokenizeResponseCreditCardBrand Brand of the card used
ApiPaymentUpdateRequestBillingType Payment billing type
ApiPaymentStatusResponsePaymentStatus Payment status
ApiPaymentSimulateCreditCardResponseDto
ApiPaymentSimulateBankSlipResponseDto
ApiPaymentSimulatePixResponseDto
ApiPaymentSimulateInstallmentResponseDto
ApiPaymentLimitsResponseCreationDto
ApiPaymentLimitsResponseCreationDailyDto
ApiPaymentLeanGetResponseBillingType Payment billing type
ApiPaymentLeanGetResponsePaymentStatus Payment status
ApiPaymentLeanSaveWithCreditCardResponseBillingType Payment billing type
ApiPaymentLeanSaveWithCreditCardResponsePaymentStatus Payment status
ApiPaymentDocumentGetResponsePaymentDocumentType Document type
ApiPaymentDocumentFileResponseDto
ApiPaymentDocumentSaveRequestPaymentDocumentType Document type
ApiPaymentDocumentUpdateRequestPaymentDocumentType Document type
ApiCustomerAccountGetResponsePersonType Kind of person
ApiNotificationGetResponseNotificationEvent Kind of event
ApiInstallmentGetResponseBillingType Form of payment
ApiInstallmentRefundResponseDto
ApiInstallmentRefundResponsePaymentRefundStatus Refund status
ApiInstallmentSaveRequestBillingType Payment billing type
ApiInstallmentSplitRequestDto
ApiInstallmentSaveWithCreditCardRequestBillingType Payment billing type
ApiInstallmentSplitGetResponseDto
ApiInstallmentSplitGetResponsePaymentSplitCancellationReason Reason for canceling the split
ApiInstallmentSplitGetResponsePaymentSplitStatus Split status
ApiSubscriptionGetResponseBillingType Billing type
ApiSubscriptionGetResponseCycle Billing frequency
ApiSubscriptionGetResponseSubscriptionStatus Subscription status
ApiSubscriptionSplitResponseDto
ApiSubscriptionSplitResponseSubscriptionSplitStatus Subscription split status
ApiSubscriptionSplitResponseSubscriptionSplitDisabledReason Reason why subscription split was disabled
ApiSubscriptionSaveRequestBillingType Billing type
ApiSubscriptionSaveRequestCycle Billing frequency
ApiSubscriptionSplitRequestDto
ApiSubscriptionSaveWithCreditCardRequestBillingType Billing type
ApiSubscriptionSaveWithCreditCardRequestCycle Billing frequency
ApiSubscriptionSaveWithCreditCardResponseBillingType Billing type
ApiSubscriptionSaveWithCreditCardResponseCycle Billing frequency
ApiSubscriptionSaveWithCreditCardResponseSubscriptionStatus Subscription status
ApiSubscriptionUpdateRequestBillingType Billing type
ApiSubscriptionUpdateRequestSubscriptionStatus Subscription status
ApiSubscriptionUpdateRequestCycle Billing frequency
ApiCustomerInvoiceTaxesDto
ApiCustomerInvoiceGetResponseInvoiceStatus Invoice status
ApiPixAddressKeyGetResponsePixAddressKeyType Pix key type
ApiPixAddressKeyGetResponsePixAddressKeyStatus Key status
ApiPixAddressKeyQrCodeGetResponseDto
ApiPixAddressKeySaveRequestPixAddressKeyType Pix key type
ApiPixTransactionQrCodeSaveRequestDto
ApiPixTransactionGetResponsePixTransactionCashValueFinality Used to indicate whether it is a Withdrawal or Change
ApiPixTransactionGetResponsePixTransactionStatus Transaction status
ApiPixTransactionGetResponsePixTransactionType Transaction type
ApiPixTransactionGetResponsePixTransactionOriginType Indicates the origin of the transaction
ApiPixOriginalTransactionResponseDto
ApiPixTransactionExternalAccountResponseDto
ApiPixTransactionQrCodeResponseDto
ApiPixTransactionGetResponsePixAddressKeyType Pix key type
ApiPixTransactionExternalAccountResponsePixAddressKeyType Pix key type
ApiPixTransactionQrCodePayerResponseDto
ApiPixQrCodeDecodeResponsePixQrCodeType QRCode Type
ApiPixQrCodeDecodeResponsePixTransactionOriginType Transaction origin
ApiPixQrCodeDecodeResponsePixTransactionCashValueFinality Used to indicate whether it is a Withdrawal or Change
ApiPixQrCodeDecodeReceiverDto
ApiPixQrCodeDecodeReceiverPersonType Person type
ApiPixQrCodeDecodeReceiverPixAccountType Receiver account type
ApiReceivableAnticipationGetResponseReceivableAnticipationStatus Anticipation status
ApiReceivableAnticipationLimitsInfoResponseDto
ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleStatus Recurrence status
ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleOrigin Indicates the origin of the recurrence
ApiPixTransactionRecurringCheckoutScheduleGetResponseRecurringCheckoutScheduleFrequency Recurrence frequency
ApiPixTransactionRecurringCheckoutScheduleExternalAccountDto
ApiPixTransactionRecurringCheckoutScheduleGetItemResponseRecurringCheckoutSchedulePixItemStatus Recurrence item status
ApiPaymentCampaignGetResponseChargeType Charge type
ApiPaymentCampaignGetResponseBillingType Allowed payment method
ApiPaymentCampaignGetResponseCycle Billing frequency, if the chargeType is RECURRENT
ApiPaymentCampaignSaveRequestBillingType Allowed payment method
ApiPaymentCampaignSaveRequestChargeType Charge type
ApiPaymentCampaignSaveRequestCycle Billing frequency, if the chargeType is RECURRENT
ApiPaymentCampaignUpdateRequestBillingType Allowed payment method
ApiPaymentCampaignUpdateRequestChargeType Charge type
ApiPaymentCampaignUpdateRequestCycle Billing frequency, if the chargeType is RECURRENT
ApiPaymentCampaignFileImageResponseDto
ApiCheckoutSessionCallbackDto
ApiCheckoutSessionItemsDto
ApiCheckoutSessionCustomerDataDto
ApiCheckoutSessionSubscriptionDto
ApiCheckoutSessionInstallmentDto
ApiCheckoutSessionSplitDto
ApiCheckoutSessionSubscriptionCycle Billing frequency
ApiTransferGetResponseTransferStatus Transfer status
ApiTransferGetResponseTransferType Transfer method
ApiTransferBankAccountGetResponseDto
ApiTransferBankGetResponseDto
ApiTransferBankAccountSaveRequestDto
ApiTransferSaveRequestTransferType Transfer modality. If not informed and the receiving institution is a Pix participant, the transfer is via Pix. Otherwise via TED.
ApiTransferSaveRequestPixAddressKeyType Enter the type of key if it is a transfer to a Pix key
ApiTransferRecurringSaveRequestDto
ApiTransferBankSaveRequestDto
ApiTransferBankAccountSaveRequestBankAccountType Account type
ApiTransferRecurringSaveRequestRecurringCheckoutScheduleFrequency Frequency
ApiTransferSaveInternalTransferResponseTransferStatus Transfer status
ApiTransferSaveInternalTransferResponseTransferType Transfer method
ApiTransferSaveInternalTransferAccountDto
ApiPaymentDunningShowResponsePaymentDunningStatus Payment dunning status
ApiPaymentDunningShowResponsePaymentDunningType Type of payment dunning
ApiPaymentDunningSaveRequestPaymentDunningType Type of payment dunning
ApiPaymentDunningSimulateResponseTypeSimulationItemDto
ApiPaymentDunningSimulateResponseTypeSimulationItemPaymentDunningType Type of payment dunning
ApiPaymentDunningListHistoryResponseDataDto
ApiPaymentDunningListHistoryResponseDataPaymentDunningHistoryStatus Negotiation status
ApiPaymentDunningListPartialPaymentsResponseDataDto
ApiPaymentDunningPaymentsAvailableForDunningResponseDataDto
ApiPaymentDunningPaymentsAvailableForDunningResponseDataPaymentStatus Billing status
ApiPaymentDunningPaymentsAvailableForDunningResponseDataBillingType Form of payment
ApiPaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemDto
ApiPaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemPaymentDunningType Type of payment dunning
ApiPaymentDunningSaveDocumentsResponsePaymentDunningStatus Payment dunning status
ApiPaymentDunningSaveDocumentsResponsePaymentDunningType Type of payment dunning
ApiPaymentDunningCancelResponsePaymentDunningStatus Payment dunning status
ApiPaymentDunningCancelResponsePaymentDunningType Type of payment dunning
ApiBillGetResponseBillStatus Bill payment status
ApiBillSimulateBankSlipInfoResponseDto
ApiMobilePhoneRechargeGetResponseMobilePhoneRechargeStatus Recharge status
ApiMobilePhoneRechargeFindProviderResponseValuesDto
ApiFinancialTransactionGetResponseDto
ApiFinancialTransactionGetResponseFinancialTransactionType Transaction type
ApiCustomerUpdateRequestGetResponseStatus Account status
ApiCustomerUpdateRequestGetResponsePersonType Person Type
ApiCustomerUpdateRequestGetResponseCompanyType Type of company (only when Legal Entity)
ApiCustomerUpdateRequestCityDto
ApiCustomerUpdateRequestCommercialInfoExpirationResponseDto
ApiCustomerUpdateRequestCityState State abbreviation (SP, RJ, SC, ...)
ApiCustomerUpdateRequestSaveRequestPersonType Person Type
ApiCustomerUpdateRequestSaveRequestCompanyType Type of company (only when Legal Entity)
ApiPaymentCheckoutConfigGetResponseCustomerInvoiceConfigStatus Invoice personalization status
ApiMyAccountGetAccountFeesPaymentDto
ApiMyAccountGetAccountFeesTransferDto
ApiMyAccountGetAccountFeesNotificationDto
ApiMyAccountGetAccountFeesCreditBureauReportDto
ApiMyAccountGetAccountFeesInvoiceDto
ApiMyAccountGetAccountFeesAnticipationDto
ApiMyAccountGetAccountFeesPaymentBankSlipDto
ApiMyAccountGetAccountFeesPaymentCreditCardDto
ApiMyAccountGetAccountFeesPaymentDebitCardDto
ApiMyAccountGetAccountFeesPaymentPixDto
ApiMyAccountGetAccountFeesTransferTedDto
ApiMyAccountGetAccountFeesTransferPixDto
ApiMyAccountGetAccountFeesAnticipationCreditCardDto
ApiMyAccountGetAccountFeesAnticipationBankSlipDto
ApiMyAccountGetStatusResponseStatus Status of sent business data
ApiWalletGetResponseDto
ApiCustomerFiscalInfoMunicipalOptionsGetResponseEnotasTipoAutenticacao Type of authentication required at city hall
ApiCustomerFiscalInfoMunicipalOptionsSpecialTaxRegimesDto
ApiCustomerFiscalInfoMunicipalOptionsNationalPortalTaxCalculationRegimeDto
ApiCustomerFiscalInfoListMunicipalServicesResponseDataDto
ApiCustomerFiscalInfoListInvoiceNbsCodesResponseDataDto
ApiPushNotificationConfigGetResponsePushNotificationSendType Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)
ApiPushNotificationConfigSaveRequestPushNotificationSendType Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)
ApiPushNotificationConfigUpdateRequestPushNotificationSendType Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)
ApiCustomerGetResponsePersonType Kind of person
ApiCustomerGetResponseCompanyType Type of company (only when Legal Entity)
ApiCustomerAccountNumberDto
ApiCustomerSaveRequestCompanyType Type of company (only when Legal Entity)
ApiCustomerSaveResponsePersonType Kind of person
ApiCustomerSaveResponseCompanyType Type of company (only when Legal Entity)
ApiAccountDocumentGroupResponseDto
ApiAccountDocumentGroupResponseCustomerDocumentStatus Document group status
ApiAccountDocumentGroupResponseCustomerDocumentType Type of documents
ApiAccountDocumentGroupResponsibleResponseDto
ApiAccountDocumentGetResponseCustomerDocumentStatus Document approval status
ApiAccountDocumentSaveRequestCustomerDocumentType Document Type
ApiChargebackSaveDisputeResponseChargebackDisputeStatus Dispute status.
ListPaymentsParameters
ListPaymentsWithSummaryDataParameters
ListPaidSplitsParameters
ListReceivedSplitsParameters
ListCustomersParameters
ListInstallmentsParameters
ListPaymentsOfAInstallmentParameters
GenerateInstallmentBookletParameters
ListSubscriptionsParameters
ListPaymentsOfASubscriptionParameters
GenerateSignatureBookletParameters
ListInvoicesForSubscriptionChargesParameters
ListKeysParameters
ListTransactionsParameters
ListAnticipationsParameters
ListRecurrencesParameters
ListRecurrenceItemsParameters
ListPaymentsLinksParameters
ListTransfersParameters
ListPaymentDunningsParameters
SimulateAPaymentDunningParameters
EventHistoryListsParameters
ListPaymentsReceivedParameters
ListPaymentsAvailableForPaymentDunningParameters
ListBillPaymentsParameters
ListMobileRechargesParameters
ListCreditBureauReportsParameters
RetrieveExtractParameters
BillingStatisticsParameters
DeleteWhiteLabelSubaccountParameters
ListInvoicesParameters
ListMunicipalServicesParameters
ListNbsCodesParameters
ListWebhooksParameters
ListSubaccountsParameters
ListChargebacksParameters
ApiErrorResponseDto
ApiErrorResponseItemDto

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.