Skip to content

ChargebackService.md

Latest commit

 

History

History
163 lines (114 loc) · 6.39 KB

ChargebackService.md

File metadata and controls

163 lines (114 loc) · 6.39 KB

ChargebackService

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

Methods Description
createAChargebackDispute
listChargebacks This method returns a paginated list of all chargebacks for the specified filter.
retrieveASingleChargeback This endpoint retrieves a specific chargeback based on the payment or installment ID.

createAChargebackDispute

  • HTTP Method: POST
  • Endpoint: /v3/chargebacks/{id}/dispute

Parameters

Name Type Required Description
id String ✅ Unique identifier of chargeback for which the dispute will be created.
apiChargebackSaveDisputeRequestDto ApiChargebackSaveDisputeRequestDto ❌ Request Body
_filename String ✅ Filename for the uploaded file

Return Type

ApiChargebackSaveDisputeResponseDto

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.ApiChargebackSaveDisputeRequestDto;
import com.asaas.apisdk.models.ApiChargebackSaveDisputeResponseDto;

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

    ApiChargebackSaveDisputeRequestDto apiChargebackSaveDisputeRequestDto = ApiChargebackSaveDisputeRequestDto.builder()
      .files(files)
      .build();
    ApiChargebackSaveDisputeRequestDto apiChargebackSaveDisputeRequestDto = ApiChargebackSaveDisputeRequestDto.builder()
      .files(files)
      .build();

    ApiChargebackSaveDisputeResponseDto response = asaasSdk.chargeback.createAChargebackDispute(
      "8e784c3e-afe8-4844-bb93-6b445763",
      apiChargebackSaveDisputeRequestDto,
      apiChargebackSaveDisputeRequestDto
    );

    System.out.println(response);
  }
}

listChargebacks

This method returns a paginated list of all chargebacks for the specified filter.

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

Parameters

Name Type Required Description
requestParameters ListChargebacksParameters ❌ Request Parameters Object

Return Type

ApiChargebackListResponseDto

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.ApiChargebackListRequestChargebackStatus;
import com.asaas.apisdk.models.ApiChargebackListRequestCreditCardBrand;
import com.asaas.apisdk.models.ApiChargebackListResponseDto;
import com.asaas.apisdk.models.ListChargebacksParameters;

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

    ListChargebacksParameters requestParameters = ListChargebacksParameters.builder()
      .offset(4L)
      .limit(10L)
      .creditCardBrand(ApiChargebackListRequestCreditCardBrand.VISA)
      .originDisputeDateLe("2024-12-05")
      .originDisputeDateGe("2023-11-01")
      .originTransactionDateLe("2024-12-05")
      .originTransactionDateGe("2024-10-10")
      .status(ApiChargebackListRequestChargebackStatus.REQUESTED)
      .build();

    ApiChargebackListResponseDto response = asaasSdk.chargeback.listChargebacks(requestParameters);

    System.out.println(response);
  }
}

retrieveASingleChargeback

This endpoint retrieves a specific chargeback based on the payment or installment ID.

  • HTTP Method: GET
  • Endpoint: /v3/payments/{id}/chargeback

Parameters

Name Type Required Description
id String ✅ Unique identifier of the payment or installment for which the chargeback will be retrieved.

Return Type

ApiPaymentChargebackResponseDto

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

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

    ApiPaymentChargebackResponseDto response = asaasSdk.chargeback.retrieveASingleChargeback("pay_s02s330x4pox1x0y");

    System.out.println(response);
  }
}