Skip to content

MobilePhoneRechargeService.md

Latest commit

 

History

History
237 lines (161 loc) · 8.42 KB

MobilePhoneRechargeService.md

File metadata and controls

237 lines (161 loc) · 8.42 KB

MobilePhoneRechargeService

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

Methods Description
listMobileRecharges
requestRecharge
recoverASingleCellphoneRecharge
cancelACellphoneRecharge Allows canceling the cell phone top-up. Use the canBeCancelled property to verify if the top-up can be canceled. When canceled, the top-up will not be executed.
searchForCellPhoneProvider

listMobileRecharges

  • HTTP Method: GET
  • Endpoint: /v3/mobilePhoneRecharges

Parameters

Name Type Required Description
requestParameters ListMobileRechargesParameters ❌ Request Parameters Object

Return Type

ApiMobilePhoneRechargeListResponseDto

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.ApiMobilePhoneRechargeListResponseDto;
import com.asaas.apisdk.models.ListMobileRechargesParameters;

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

    ListMobileRechargesParameters requestParameters = ListMobileRechargesParameters.builder()
      .offset(2L)
      .limit(10L)
      .build();

    ApiMobilePhoneRechargeListResponseDto response = asaasSdk.mobilePhoneRecharge.listMobileRecharges(
      requestParameters
    );

    System.out.println(response);
  }
}

requestRecharge

  • HTTP Method: POST
  • Endpoint: /v3/mobilePhoneRecharges

Parameters

Name Type Required Description
apiMobilePhoneRechargeSaveRequestDto ApiMobilePhoneRechargeSaveRequestDto ❌ Request Body

Return Type

ApiMobilePhoneRechargeGetResponseDto

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.ApiMobilePhoneRechargeGetResponseDto;
import com.asaas.apisdk.models.ApiMobilePhoneRechargeSaveRequestDto;

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

    ApiMobilePhoneRechargeSaveRequestDto apiMobilePhoneRechargeSaveRequestDto =
      ApiMobilePhoneRechargeSaveRequestDto.builder().value(15D).phoneNumber("63997365512").build();

    ApiMobilePhoneRechargeGetResponseDto response = asaasSdk.mobilePhoneRecharge.requestRecharge(
      apiMobilePhoneRechargeSaveRequestDto
    );

    System.out.println(response);
  }
}

recoverASingleCellphoneRecharge

  • HTTP Method: GET
  • Endpoint: /v3/mobilePhoneRecharges/{id}

Parameters

Name Type Required Description
id String ✅ Unique identifier for cell phone recharge on Asaas

Return Type

ApiMobilePhoneRechargeGetResponseDto

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.ApiMobilePhoneRechargeGetResponseDto;

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

    ApiMobilePhoneRechargeGetResponseDto response = asaasSdk.mobilePhoneRecharge.recoverASingleCellphoneRecharge(
      "37c22147-4194-11ec-8061-0242ac120002"
    );

    System.out.println(response);
  }
}

cancelACellphoneRecharge

Allows canceling the cell phone top-up. Use the canBeCancelled property to verify if the top-up can be canceled. When canceled, the top-up will not be executed.

  • HTTP Method: POST
  • Endpoint: /v3/mobilePhoneRecharges/{id}/cancel

Parameters

Name Type Required Description
id String ✅ Unique identifier for cell phone recharge on Asaas
input Object ❌ Request Body

Return Type

ApiMobilePhoneRechargeGetResponseDto

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.ApiMobilePhoneRechargeGetResponseDto;

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

    ApiMobilePhoneRechargeGetResponseDto response = asaasSdk.mobilePhoneRecharge.cancelACellphoneRecharge(
      "37c22147-4194-11ec-8061-0242ac120002",
      new Object()
    );

    System.out.println(response);
  }
}

searchForCellPhoneProvider

  • HTTP Method: GET
  • Endpoint: /v3/mobilePhoneRecharges/{phoneNumber}/provider

Parameters

Name Type Required Description
phoneNumber String ✅ Cell phone number that will be consulted.

Return Type

ApiMobilePhoneRechargeFindProviderResponseDto

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.ApiMobilePhoneRechargeFindProviderResponseDto;

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

    ApiMobilePhoneRechargeFindProviderResponseDto response = asaasSdk.mobilePhoneRecharge.searchForCellPhoneProvider(
      "63997365512"
    );

    System.out.println(response);
  }
}