Skip to content

RecurringPixService.md

Latest commit

 

History

History
247 lines (172 loc) · 7.82 KB

RecurringPixService.md

File metadata and controls

247 lines (172 loc) · 7.82 KB

RecurringPixService

A list of all methods in the RecurringPixService service. Click on the method name to view detailed information about that method.

Methods Description
listRecurrences
retrieveASingleRecurrence
cancelARecurrence
listRecurrenceItems
cancelARecurrenceItem

listRecurrences

  • HTTP Method: GET
  • Endpoint: /v3/pix/transactions/recurrings

Parameters

Name Type Required Description
requestParameters ListRecurrencesParameters ❌ Request Parameters Object

Return Type

ApiPixTransactionRecurringCheckoutScheduleListResponseDto

Example Usage Code Snippet

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.models.ApiPixTransactionRecurringCheckoutScheduleListRequestRecurringCheckoutScheduleStatus;
import com.asaas.apisdk.models.ApiPixTransactionRecurringCheckoutScheduleListResponseDto;
import com.asaas.apisdk.models.ListRecurrencesParameters;

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);

    ListRecurrencesParameters requestParameters = ListRecurrencesParameters.builder()
      .offset(7L)
      .limit(10L)
      .status(
        ApiPixTransactionRecurringCheckoutScheduleListRequestRecurringCheckoutScheduleStatus.AWAITING_CRITICAL_ACTION_AUTHORIZATION
      )
      .value(100D)
      .searchText("searchText")
      .build();

    ApiPixTransactionRecurringCheckoutScheduleListResponseDto response = asaasSdk.recurringPix.listRecurrences(
      requestParameters
    );

    System.out.println(response);
  }
}

retrieveASingleRecurrence

  • HTTP Method: GET
  • Endpoint: /v3/pix/transactions/recurrings/{id}

Parameters

Name Type Required Description
id String ✅ Unique recurrence identifier in Asaas

Return Type

ApiPixTransactionRecurringCheckoutScheduleGetResponseDto

Example Usage Code Snippet

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

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);

    ApiPixTransactionRecurringCheckoutScheduleGetResponseDto response = asaasSdk.recurringPix.retrieveASingleRecurrence(
      "35363f6e-93e2-11ec-b9d9-96f4053b1bd4"
    );

    System.out.println(response);
  }
}

cancelARecurrence

  • HTTP Method: POST
  • Endpoint: /v3/pix/transactions/recurrings/{id}/cancel

Parameters

Name Type Required Description
id String ✅ Unique recurrence identifier in Asaas
input Object ❌ Request Body

Return Type

ApiPixTransactionRecurringCheckoutScheduleGetResponseDto

Example Usage Code Snippet

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

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);

    ApiPixTransactionRecurringCheckoutScheduleGetResponseDto response = asaasSdk.recurringPix.cancelARecurrence(
      "35363f6e-93e2-11ec-b9d9-96f4053b1bd4",
      new Object()
    );

    System.out.println(response);
  }
}

listRecurrenceItems

  • HTTP Method: GET
  • Endpoint: /v3/pix/transactions/recurrings/{id}/items

Parameters

Name Type Required Description
id String ✅ Unique recurrence identifier in Asaas
requestParameters ListRecurrenceItemsParameters ❌ Request Parameters Object

Return Type

ApiPixTransactionRecurringCheckoutScheduleListItemsResponseDto

Example Usage Code Snippet

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.models.ApiPixTransactionRecurringCheckoutScheduleListItemsResponseDto;
import com.asaas.apisdk.models.ListRecurrenceItemsParameters;

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);

    ListRecurrenceItemsParameters requestParameters = ListRecurrenceItemsParameters.builder()
      .offset(6L)
      .limit(10L)
      .build();

    ApiPixTransactionRecurringCheckoutScheduleListItemsResponseDto response = asaasSdk.recurringPix.listRecurrenceItems(
      "35363f6e-93e2-11ec-b9d9-96f4053b1bd4",
      requestParameters
    );

    System.out.println(response);
  }
}

cancelARecurrenceItem

  • HTTP Method: POST
  • Endpoint: /v3/pix/transactions/recurrings/items/{id}/cancel

Parameters

Name Type Required Description
id String ✅ Unique recurrence item identifier in Asaas
input Object ❌ Request Body

Return Type

ApiPixTransactionRecurringCheckoutScheduleGetItemResponseDto

Example Usage Code Snippet

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

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);

    ApiPixTransactionRecurringCheckoutScheduleGetItemResponseDto response = asaasSdk.recurringPix.cancelARecurrenceItem(
      "71ae9d73-468f-4d04-8b87-a541128f9c46",
      new Object()
    );

    System.out.println(response);
  }
}