Skip to content

Repository files navigation

Asaas Java SDK 1.0.3

Welcome to the official Asaas API Sdk documentation.

This guide will help you get started with integrating and using the Asaas SDK in your project.

You can find the dependency on Sonatype here.

This SDK was generated by liblab

Versions

  • API version: 3.0.0
  • SDK version: 1.0.3

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.3</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.3

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:

importcom.asaas.apisdk.AsaasSdk;
importcom.asaas.apisdk.config.ApiKeyAuthConfig;
importcom.asaas.apisdk.config.AsaasSdkConfig;
publicclassMain {
publicstaticvoidmain(String[] args) {
ApiKeyAuthConfigapiKeyAuthConfig = ApiKeyAuthConfig.builder()
.apiKey("YOUR_API_KEY")
.apiKeyHeader("YOUR_API_KEY_HEADER")
.build();
AsaasSdkConfigconfig = AsaasSdkConfig.builder().apiKeyAuthConfig(apiKeyAuthConfig).build();
AsaasSdkasaasSdk = newAsaasSdk(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:

importcom.asaas.apisdk.AsaasSdk;
importcom.asaas.apisdk.config.AsaasSdkConfig;
importcom.asaas.apisdk.http.Environment;
publicclassMain {
publicstaticvoidmain(String[] args) {
AsaasSdkConfigconfig = AsaasSdkConfig.builder().build();
AsaasSdkasaasSdk = newAsaasSdk(config);
asaasSdk.setEnvironment(Environment.DEFAULT);
}
}

Setting a Custom Timeout

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

importcom.asaas.apisdk.AsaasSdk;
importcom.asaas.apisdk.config.AsaasSdkConfig;
publicclassMain {
publicstaticvoidmain(String[] args) {
AsaasSdkConfigconfig = AsaasSdkConfig.builder().timeout(10000).build();
AsaasSdkasaasSdk = newAsaasSdk(config);
}
}

Sample Usage

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

importcom.asaas.apisdk.AsaasSdk;
importcom.asaas.apisdk.config.ApiKeyAuthConfig;
importcom.asaas.apisdk.config.AsaasSdkConfig;
importcom.asaas.apisdk.exceptions.ApiError;
importcom.asaas.apisdk.models.ListPaymentsParameters;
importcom.asaas.apisdk.models.PaymentListRequestBillingType;
importcom.asaas.apisdk.models.PaymentListRequestInvoiceStatus;
importcom.asaas.apisdk.models.PaymentListRequestPaymentStatus;
importcom.asaas.apisdk.models.PaymentListResponseDto;
publicclassMain {
publicstaticvoidmain(String[] args) {
AsaasSdkConfigconfig = AsaasSdkConfig.builder()
.apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
.build();
AsaasSdkasaasSdk = newAsaasSdk(config);
ListPaymentsParametersrequestParameters = ListPaymentsParameters.builder()
.installment("installment")
.offset(8L)
.limit(10L)
.customer("customer")
.customerGroupName("customerGroupName")
.billingType(PaymentListRequestBillingType.UNDEFINED)
.status(PaymentListRequestPaymentStatus.PENDING)
.subscription("subscription")
.externalReference("externalReference")
.paymentDate("paymentDate")
.invoiceStatus(PaymentListRequestInvoiceStatus.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 {
PaymentListResponseDtoresponse = asaasSdk.payment.listPayments(requestParameters);
System.out.println(response);
} catch (ApiErrore) {
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:
NameDescription
PaymentListResponseDto
PaymentListRequestBillingTypeFilter by billing type
PaymentListRequestPaymentStatusFilter by status
PaymentListRequestInvoiceStatusFilter to return charges that have or do not have an invoice
PaymentSaveRequestDto
PaymentGetResponseDto
PaymentSaveWithCreditCardRequestDto
PaymentPayWithCreditCardRequestDto
PaymentBillingInfoResponseDto
PaymentViewingInfoResponseDto
PaymentUpdateRequestDto
PaymentDeleteResponseDto
PaymentStatusResponseDto
PaymentRefundRequestDto
PaymentIdentificationFieldResponseDto
PaymentPixQrCodeResponseDtoPayment data related to pix
PaymentReceiveInCashRequestDto
PaymentSimulateRequestDto
PaymentSimulateResponseDto
PaymentEscrowGetResponseDtoPayment escrow in the Escrow Account information
PaymentLimitsResponseDto
PaymentLeanListResponseDto
PaymentLeanGetResponseDto
PaymentLeanSaveWithCreditCardResponseDto
CreditCardTokenizeRequestDto
CreditCardTokenizeResponseDto
PaymentRefundListResponseDto
PaymentBankSlipRefundResponseDto
PaymentSplitGetResponseDtoSplit Settings
PaymentSplitListResponseDto
PaymentSplitListPaidRequestPaymentSplitStatusFilter by status
PaymentSplitListReceivedRequestPaymentSplitStatusFilter by status
PaymentDocumentListResponseDto
PaymentDocumentSaveRequestDto
PaymentDocumentGetResponseDto
PaymentDocumentUpdateRequestDto
PaymentDocumentDeleteResponseDto
CustomerListResponseDto
CustomerSaveRequestDto
CustomerGetResponseDto
CustomerUpdateRequestDto
CustomerDeleteResponseDto
NotificationListResponseDto
NotificationUpdateRequestDtoList of notification information
NotificationGetResponseDtoList of notification information
NotificationBatchUpdateRequestDto
NotificationBatchUpdateResponseDto
InstallmentListResponseDto
InstallmentSaveRequestDto
InstallmentGetResponseDto
InstallmentSaveWithCreditCardRequestDto
InstallmentDeleteResponseDto
InstallmentListPaymentsRequestPaymentStatusFilter by payment status
InstallmentUpdateSplitRequestDto
InstallmentUpdateSplitResponseDto
SubscriptionListResponseDto
SubscriptionListRequestBillingTypeFilter by billing type
SubscriptionListRequestSubscriptionStatusFilter by status
SubscriptionSaveRequestDto
SubscriptionGetResponseDto
SubscriptionSaveWithCreditCardRequestDto
SubscriptionSaveWithCreditCardResponseDto
SubscriptionUpdateRequestDto
SubscriptionDeleteResponseDto
SubscriptionUpdateCreditCardRequestDto
SubscriptionListPaymentsRequestPaymentStatusFilter by payment status
SubscriptionInvoiceConfigGetResponseDto
SubscriptionConfigureInvoiceRequestDto
SubscriptionInvoiceConfigUpdateRequestDto
SubscriptionDeleteInvoiceConfigResponseDto
InvoiceListResponseDto
SubscriptionGetInvoicesRequestInvoiceStatusFilter by invoice status
PixAddressKeyListResponseDto
PixAddressKeyListRequestPixAddressKeyStatusFilter by current key status
PixAddressKeySaveRequestDto
PixAddressKeyGetResponseDto
PixQrCodeSaveRequestDto
PixQrCodeSaveResponseDto
PixQrCodeDeleteResponseDto
PixTokenBucketGetAddressKeyResponseDto
PixTransactionSaveRequestDto
PixTransactionGetResponseDto
PixQrCodeDecodeRequestDto
PixQrCodeDecodeResponseDto
PixTransactionListResponseDto
PixTransactionListRequestPixTransactionStatusFilter by transaction status
PixTransactionListRequestPixTransactionTypeFilter by transaction type
AnticipationGetResponseDto
AnticipationListResponseDto
AnticipationListRequestAnticipationStatusFilter by status
AnticipationSaveRequestDto
AnticipationSimulateRequestDto
AnticipationSimulateResponseDto
AnticipationConfigurationGetResponseDto
AnticipationConfigurationUpdateRequestDto
AnticipationLimitsResponseDto
PixRecurringTransactionListResponseDto
RecurringPixTransactionListRequestPixRecurringTransactionStatusFilter by recurrence status
PixRecurringTransactionGetResponseDto
RecurringPixTransactionListItemsResponseDto
PixRecurringTransactionGetItemResponseDto
PaymentLinkListResponseDto
PaymentLinkSaveRequestDto
PaymentLinkGetResponseDto
PaymentLinkUpdateRequestDto
PaymentLinkDeleteResponseDto
PaymentLinkFileListResponseDto
PaymentLinkFileSaveRequestDto
PaymentLinkFileGetResponseDto
PaymentLinkFileDeleteResponseDto
CheckoutSessionSaveRequestDto
CheckoutSessionResponseDto
TransferListResponseDto
TransferSaveRequestDto
TransferGetResponseDto
TransferSaveInternalTransferRequestDto
TransferSaveInternalTransferResponseDto
PaymentDunningListResponseDto
PaymentDunningListRequestPaymentDunningStatusFilter by payment dunning status
PaymentDunningListRequestPaymentDunningTypeFilter by type of payment dunning
PaymentDunningSaveRequestDto
PaymentDunningShowResponseDto
PaymentDunningSimulateResponseDto
PaymentDunningListHistoryResponseDto
PaymentDunningListPartialPaymentsResponseDto
PaymentDunningPaymentsAvailableForDunningResponseDto
PaymentDunningSaveDocumentsRequestDto
PaymentDunningSaveDocumentsResponseDto
PaymentDunningCancelResponseDto
BillListResponseDto
BillSaveRequestDto
BillGetResponseDto
BillSimulateRequestDto
BillSimulateResponseDto
MobilePhoneRechargeListResponseDto
MobilePhoneRechargeSaveRequestDto
MobilePhoneRechargeGetResponseDto
MobilePhoneRechargeFindProviderResponseDto
CreditBureauReportListResponseDto
CreditBureauReportSaveRequestDto
CreditBureauReportGetResponseDto
FinancialTransactionListResponseDto
FinanceBalanceResponseDto
FinanceGetPaymentStatisticsResponseDto
FinanceGetPaymentStatisticsRequestBillingTypeFilter by payment method
FinanceGetPaymentStatisticsRequestPaymentStatusFilter by status
FinanceGetSplitStatisticsResponseDto
AccountInfoGetResponseDto
AccountInfoSaveRequestDto
PaymentCheckoutConfigGetResponseDto
PaymentCheckoutConfigSaveRequestDto
MyAccountGetAccountNumberResponseDto
MyAccountGetAccountFeesResponseDto
MyAccountGetStatusResponseDto
WalletShowResponseDto
MyAccountDisableAccountResponseDto
InvoiceListRequestInvoiceStatusFilter by situation
InvoiceSaveRequestDto
InvoiceGetResponseDto
InvoiceUpdateRequestDto
InvoiceCancelRequestDto
FiscalInfoMunicipalOptionsGetResponseDto
FiscalInfoGetResponseDto
FiscalInfoSaveRequestDto
FiscalInfoListMunicipalServicesResponseDto
FiscalInfoListInvoiceNbsCodesResponseDto
FiscalInfoUpdateUseNationalPortalRequestDto
FiscalInfoUpdateUseNationalPortalResponseDto
WebhookConfigListResponseDto
WebhookConfigSaveRequestDtoArray with desired Webhooks settings
WebhookConfigGetResponseDto
WebhookConfigUpdateRequestDto
WebhookConfigDeleteResponseDto
AccountListResponseDto
AccountSaveRequestDto
AccountSaveResponseDto
AccountGetResponseDto
AccountPaymentEscrowConfigDto
AccountSaveOrUpdatePaymentEscrowConfigRequestDto
AccountDocumentShowResponseDto
AccountDocumentSaveRequestDto
AccountDocumentGetResponseDto
AccountDocumentUpdateRequestDto
AccountDocumentDeleteResponseDto
ChargebackSaveDisputeRequestDto
ChargebackSaveDisputeResponseDto
ChargebackListResponseDto
ChargebackListRequestCreditCardBrandFilter by used card brand.
ChargebackListRequestChargebackStatusFilter by chargeback status.
PaymentChargebackResponseDto
PaymentGetResponseBillingTypePayment billing type
PaymentSaveWithCreditCardCreditCardDtoCredit card information
PaymentGetResponsePaymentStatusPayment status
PaymentDiscountDtoDiscount information
PaymentFineResponseDtoFine information for payment after due date
PaymentInterestResponseDtoInterest information for payment after due date
PaymentRefundGetResponseDtoRefunds information
PaymentSaveWithCreditCardCreditCardCreditCardBrandFlag of the card used
PaymentDiscountDiscountTypeDiscount type
PaymentSplitGetResponsePaymentSplitCancellationReasonReason for canceling the split
PaymentSplitGetResponsePaymentSplitStatusSplit status
PaymentChargebackResponseChargebackStatusChargeback status
PaymentChargebackResponseChargebackReasonChargeback reason
ChargebackCreditCardResponseDtoCredit card information
PaymentChargebackResponseChargebackDisputeStatusChargeback dispute status.
ChargebackCreditCardResponseCreditCardBrandFlag of the card used
PaymentEscrowGetResponsePaymentEscrowStatusPayment escrow status
PaymentEscrowGetResponsePaymentEscrowFinishReasonPayment escrow finish reason
PaymentRefundGetResponsePaymentRefundStatusRefund status
PaymentRefundedSplitResponseDtoRefunded Splits, if any
PaymentSaveRequestBillingTypePayment billing type
PaymentInterestRequestDtoInterest information for payment after due date
PaymentFineRequestDtoFine information for payment after due date
PaymentSplitRequestDtoSplit Settings
PaymentCallbackRequestDtoAutomatic redirection information after the payment of the link payment
PaymentFineRequestFineTypeFine type
PaymentSaveWithCreditCardRequestBillingTypePayment billing type
CreditCardRequestDtoCredit card information
CreditCardHolderInfoRequestDtoCredit card holder information
BankSlipBillingInfoResponseDtoPayment data related to bank slip
CreditCardTokenizeResponseCreditCardBrandBrand of the card used
PaymentUpdateRequestBillingTypePayment billing type
PaymentStatusResponsePaymentStatusPayment status
PaymentSimulateRequestBillingTypeForm of payment
PaymentSimulateCreditCardResponseDtoCard fees
PaymentSimulateBankSlipResponseDtoBoleto fees
PaymentSimulatePixResponseDtoPIX fees
PaymentSimulateInstallmentResponseDtoInstallment information
PaymentLimitsResponseCreationDtoBreeding limits
PaymentLimitsResponseCreationDailyDtoDaily limits
PaymentLeanGetResponseBillingTypePayment billing type
PaymentLeanGetResponsePaymentStatusPayment status
PaymentLeanSaveWithCreditCardResponseBillingTypePayment billing type
PaymentLeanSaveWithCreditCardResponsePaymentStatusPayment status
PaymentDocumentGetResponsePaymentDocumentTypeDocument type
PaymentDocumentFileResponseDtoFile object
PaymentDocumentSaveRequestPaymentDocumentTypeDocument type
PaymentDocumentUpdateRequestPaymentDocumentTypeDocument type
CustomerGetResponsePersonTypeKind of person
NotificationGetResponseNotificationEventKind of event
InstallmentGetResponseBillingTypeForm of payment
InstallmentRefundResponseDtoRefunds information
InstallmentRefundResponsePaymentRefundStatusRefund status
InstallmentSaveRequestBillingTypePayment billing type
InstallmentSplitRequestDtoSplit Settings
InstallmentSaveWithCreditCardRequestBillingTypePayment billing type
InstallmentSplitGetResponseDtoSplit array
InstallmentSplitGetResponsePaymentSplitCancellationReasonReason for canceling the split
InstallmentSplitGetResponsePaymentSplitStatusSplit status
SubscriptionGetResponseBillingTypeBilling type
SubscriptionGetResponseCycleBilling frequency
SubscriptionGetResponseSubscriptionStatusSubscription status
SubscriptionSplitResponseDtoSplit information
SubscriptionSplitResponseSubscriptionSplitStatusSubscription split status
SubscriptionSplitResponseSubscriptionSplitDisabledReasonReason why subscription split was disabled
SubscriptionSaveRequestBillingTypeBilling type
SubscriptionSaveRequestCycleBilling frequency
SubscriptionSplitRequestDtoSplit information
SubscriptionSaveWithCreditCardRequestBillingTypeBilling type
SubscriptionSaveWithCreditCardRequestCycleBilling frequency
SubscriptionSaveWithCreditCardResponseBillingTypeBilling type
SubscriptionSaveWithCreditCardResponseCycleBilling frequency
SubscriptionSaveWithCreditCardResponseSubscriptionStatusSubscription status
SubscriptionUpdateRequestBillingTypeBilling type
SubscriptionUpdateRequestSubscriptionStatusSubscription status
SubscriptionUpdateRequestCycleBilling frequency
InvoiceTaxesDtoInvoice taxes
InvoiceGetResponseInvoiceStatusInvoice status
PixAddressKeyGetResponsePixAddressKeyTypePix key type
PixAddressKeyGetResponsePixAddressKeyStatusKey status
PixAddressKeyQrCodeGetResponseDtoPix key QRCode
PixAddressKeySaveRequestPixAddressKeyTypePix key type
PixTransactionQrCodeSaveRequestDtoQRCode payload for payment
PixTransactionGetResponsePixTransactionCashValueFinalityUsed to indicate whether it is a Withdrawal or Change
PixTransactionGetResponsePixTransactionStatusTransaction status
PixTransactionGetResponsePixTransactionTypeTransaction type
PixTransactionGetResponsePixTransactionOriginTypeIndicates the origin of the transaction
PixOriginalTransactionResponseDtoOriginal transaction information if a chargeback has occurred
PixTransactionExternalAccountResponseDtoInformation about the recipient
PixTransactionQrCodeResponseDtoInformation about QrCode
PixTransactionGetResponsePixAddressKeyTypePix key type
PixTransactionExternalAccountResponsePixAddressKeyTypePix key type
PixTransactionQrCodePayerResponseDtoInformation about the payer
PixQrCodeDecodeResponsePixQrCodeTypeQRCode Type
PixQrCodeDecodeResponsePixTransactionOriginTypeTransaction origin
PixQrCodeDecodeResponsePixTransactionCashValueFinalityUsed to indicate whether it is a Withdrawal or Change
PixQrCodeDecodeReceiverDtoInformation about the receiver
PixQrCodeDecodeReceiverPersonTypePerson type
PixQrCodeDecodeReceiverPixAccountTypeReceiver account type
AnticipationGetResponseAnticipationStatusAnticipation status
AnticipationLimitsInfoResponseDtoCredit card anticipation limits
PixRecurringTransactionGetResponsePixRecurringTransactionStatusRecurrence status
PixRecurringTransactionGetResponsePixRecurringTransactionOriginIndicates the origin of the recurrence
PixRecurringTransactionGetResponsePixRecurringTransactionFrequencyRecurrence frequency
PixRecurringTransactionExternalAccountDtoReceiver information
PixRecurringTransactionGetItemResponsePixRecurringTransactionItemStatusRecurrence item status
PaymentLinkGetResponseChargeTypeCharge type
PaymentLinkGetResponseBillingTypeAllowed payment method
PaymentLinkGetResponseCycleBilling frequency, if the chargeType is RECURRENT
PaymentLinkSaveRequestBillingTypeAllowed payment method
PaymentLinkSaveRequestChargeTypeCharge type
PaymentLinkSaveRequestCycleBilling frequency, if the chargeType is RECURRENT
PaymentLinkUpdateRequestBillingTypeAllowed payment method
PaymentLinkUpdateRequestChargeTypeCharge type
PaymentLinkUpdateRequestCycleBilling frequency, if the chargeType is RECURRENT
PaymentLinkFileImageResponseDtoPayments link image information
CheckoutSessionSaveRequestBillingTypePayment methods
CheckoutSessionSaveRequestChargeTypeCharge types
CheckoutSessionCallbackDtoAutomatic redirection information after payment on the checkout screen
CheckoutSessionItemsDtoList of items at checkout
CheckoutSessionCustomerDataDtoCustomer data
CheckoutSessionSubscriptionDtoSubscription details, required if chargeTypes includes RECURRENT
CheckoutSessionInstallmentDtoInstallment details. If informed, it will be mandatory to include the INSTALLMENT chargeType
CheckoutSessionSplitDtoSplit Settings
CheckoutSessionSubscriptionCycleBilling frequency
CheckoutSessionResponseBillingTypePayment methods
CheckoutSessionResponseChargeTypeCharge types
TransferGetResponseTransferStatusTransfer status
TransferGetResponseTransferTypeTransfer method
TransferBankAccountGetResponseDtoBank account details
TransferBankGetResponseDtoBank account name
TransferBankAccountSaveRequestDtoEnter your account details if it is a transfer to a bank account
TransferSaveRequestTransferTypeTransfer modality. If not informed and the receiving institution is a Pix participant, the transfer is via Pix. Otherwise via TED.
TransferSaveRequestPixAddressKeyTypeEnter the type of key if it is a transfer to a Pix key
TransferRecurringSaveRequestDtoRecurrence information. Only for Pix transfers
TransferBankSaveRequestDtoDetails of the bank account to which the transfer will be made
TransferBankAccountSaveRequestBankAccountTypeAccount type
TransferRecurringSaveRequestRecurringCheckoutScheduleFrequencyFrequency
TransferSaveInternalTransferResponseTransferStatusTransfer status
TransferSaveInternalTransferResponseTransferTypeTransfer method
TransferSaveInternalTransferAccountDtoTarget account basic information
PaymentDunningShowResponsePaymentDunningStatusPayment dunning status
PaymentDunningShowResponsePaymentDunningTypeType of payment dunning
PaymentDunningSaveRequestPaymentDunningTypeType of payment dunning
PaymentDunningSimulateResponseTypeSimulationItemDtoSimulation of denial request for each type of denial available
PaymentDunningSimulateResponseTypeSimulationItemPaymentDunningTypeType of payment dunning
PaymentDunningListHistoryResponseDataDtoList of objects
PaymentDunningListHistoryResponseDataPaymentDunningHistoryStatusNegotiation status
PaymentDunningListPartialPaymentsResponseDataDtoList of objects
PaymentDunningPaymentsAvailableForDunningResponseDataDtoList of objects
PaymentDunningPaymentsAvailableForDunningResponseDataPaymentStatusBilling status
PaymentDunningPaymentsAvailableForDunningResponseDataBillingTypeForm of payment
PaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemDtoSimulation of denial request for each type of payment dunning available
PaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemPaymentDunningTypeType of payment dunning
PaymentDunningSaveDocumentsResponsePaymentDunningStatusPayment dunning status
PaymentDunningSaveDocumentsResponsePaymentDunningTypeType of payment dunning
PaymentDunningCancelResponsePaymentDunningStatusPayment dunning status
PaymentDunningCancelResponsePaymentDunningTypeType of payment dunning
BillGetResponseBillStatusBill payment status
BillSimulateBankSlipInfoResponseDtoInformation about the bill to be paid
MobilePhoneRechargeGetResponseMobilePhoneRechargeStatusRecharge status
MobilePhoneRechargeFindProviderResponseValuesDtoAmounts available for recharge
FinancialTransactionGetResponseDtoList of objects
FinancialTransactionGetResponseFinancialTransactionTypeTransaction type
AccountInfoGetResponseStatusAccount status
AccountInfoGetResponsePersonTypePerson Type
AccountInfoGetResponseCompanyTypeType of company (only when Legal Entity)
AccountInfoCityDtoCity information registered in your account
AccountInfoCommercialInfoExpirationResponseDtoInformation about the expiration of commercial data
AccountInfoCityStateState abbreviation (SP, RJ, SC, ...)
AccountInfoSaveRequestPersonTypePerson Type
AccountInfoSaveRequestCompanyTypeType of company (only when Legal Entity)
PaymentCheckoutConfigGetResponseInvoiceConfigStatusInvoice personalization status
MyAccountGetAccountFeesPaymentDtoBilling fees
MyAccountGetAccountFeesTransferDtoTransfer fees
MyAccountGetAccountFeesNotificationDtoNotification fees
MyAccountGetAccountFeesCreditBureauReportDtoSerasa consultation fees
MyAccountGetAccountFeesInvoiceDtoInvoice fees
MyAccountGetAccountFeesAnticipationDtoAnticipation fees
MyAccountGetAccountFeesPaymentBankSlipDtoBoleto fees
MyAccountGetAccountFeesPaymentCreditCardDtoCredit card fees
MyAccountGetAccountFeesPaymentDebitCardDtoDebit card fees
MyAccountGetAccountFeesPaymentPixDtoPix Fees
MyAccountGetAccountFeesTransferTedDtoFees for TED transfers
MyAccountGetAccountFeesTransferPixDtoFees for Pix transfers
MyAccountGetAccountFeesAnticipationCreditCardDtoCredit card anticipation fee
MyAccountGetAccountFeesAnticipationBankSlipDtoAnticipation fee on boletos
MyAccountGetStatusResponseStatusStatus of sent business data
WalletGetResponseDtoList of objects
FiscalInfoMunicipalOptionsGetResponseEnotasTipoAutenticacaoType of authentication required at city hall
FiscalInfoMunicipalOptionsSpecialTaxRegimesDtoTax calculation regime options
FiscalInfoMunicipalOptionsNationalPortalTaxCalculationRegimeDtoSpecial taxation regime options
FiscalInfoListMunicipalServicesResponseDataDtoList of objects
FiscalInfoListInvoiceNbsCodesResponseDataDtoList of objects
WebhookConfigGetResponseWebhookSendTypeSequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)
WebhookConfigGetResponseWebhookEventList of events this Webhook will observe
WebhookConfigSaveRequestWebhookSendTypeSequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)
WebhookConfigSaveRequestWebhookEventList of events this Webhook will observe
WebhookConfigUpdateRequestWebhookSendTypeSequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)
WebhookConfigUpdateRequestWebhookEventList of events this Webhook will observe
AccountGetResponsePersonTypeKind of person
AccountGetResponseCompanyTypeType of company (only when Legal Entity)
AccountNumberDtoSubaccount number in Asaas
AccountSaveRequestCompanyTypeType of company (only when Legal Entity)
AccountSaveResponsePersonTypeKind of person
AccountSaveResponseCompanyTypeType of company (only when Legal Entity)
AccountDocumentGroupResponseDtoList of objects
AccountDocumentGroupResponseAccountDocumentStatusDocument group status
AccountDocumentGroupResponseAccountDocumentTypeType of documents
AccountDocumentResponsibleResponseDtoWho is responsible for sending these documents
AccountDocumentResponsibleResponseAccountDocumentResponsibleTypeResponsible type
AccountDocumentGetResponseAccountDocumentStatusDocument approval status
AccountDocumentSaveRequestAccountDocumentTypeDocument Type
ChargebackSaveDisputeResponseChargebackDisputeStatusDispute status.
ListPaymentsParameters
ListPaymentsWithSummaryDataParameters
ListPaidSplitsParameters
ListReceivedSplitsParameters
ListCustomersParameters
ListInstallmentsParameters
ListPaymentsOfAInstallmentParameters
GenerateInstallmentBookletParameters
ListSubscriptionsParameters
ListPaymentsOfASubscriptionParameters
GenerateSubscriptionBookletParameters
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
ErrorResponseDto
ErrorResponseItemDtoList of objects

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

About

No description, website, or topics provided.

Resources

Stars

5 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages