Skip to content

CreditBureauReportService.md

Latest commit

 

History

History
149 lines (102 loc) · 4.66 KB

CreditBureauReportService.md

File metadata and controls

149 lines (102 loc) · 4.66 KB

CreditBureauReportService

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

Methods Description
listCreditBureauReports
makeConsultation
retrieveACreditBureauReport

listCreditBureauReports

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

Parameters

Name Type Required Description
requestParameters ListCreditBureauReportsParameters ❌ Request Parameters Object

Return Type

CreditBureauReportListResponseDto

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.CreditBureauReportListResponseDto;
import com.asaas.apisdk.models.ListCreditBureauReportsParameters;

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

    ListCreditBureauReportsParameters requestParameters = ListCreditBureauReportsParameters.builder()
      .offset(3L)
      .limit(10L)
      .startDate("startDate")
      .endDate("endDate")
      .build();

    CreditBureauReportListResponseDto response = asaasSdk.creditBureauReport.listCreditBureauReports(requestParameters);

    System.out.println(response);
  }
}

makeConsultation

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

Parameters

Name Type Required Description
creditBureauReportSaveRequestDto CreditBureauReportSaveRequestDto ❌ Request Body

Return Type

CreditBureauReportGetResponseDto

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.CreditBureauReportGetResponseDto;
import com.asaas.apisdk.models.CreditBureauReportSaveRequestDto;

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

    CreditBureauReportSaveRequestDto creditBureauReportSaveRequestDto = CreditBureauReportSaveRequestDto.builder()
      .customer("customer")
      .cpfCnpj("05666663755")
      .build();

    CreditBureauReportGetResponseDto response = asaasSdk.creditBureauReport.makeConsultation(
      creditBureauReportSaveRequestDto
    );

    System.out.println(response);
  }
}

retrieveACreditBureauReport

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

Parameters

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

Return Type

CreditBureauReportGetResponseDto

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

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

    CreditBureauReportGetResponseDto response = asaasSdk.creditBureauReport.retrieveACreditBureauReport(
      "6c5e73fa-9efd-4a75-b60c-1cafb8d1c7ed"
    );

    System.out.println(response);
  }
}