Skip to content

PaymentLinkService.md

Latest commit

 

History

History
556 lines (395 loc) · 18.4 KB

PaymentLinkService.md

File metadata and controls

556 lines (395 loc) · 18.4 KB

PaymentLinkService

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

Methods Description
listPaymentsLinks
createAPaymentsLink
retrieveASinglePaymentsLink
updateAPaymentsLink
removeAPaymentsLink
restoreAPaymentsLink
listImagesFromAPaymentsLink
addAnImageToAPaymentsLink
retrieveASinglePaymentsLinkImage
removeAnImageFromPaymentsLink
setPaymentsLinkMainImage

listPaymentsLinks

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

Parameters

Name Type Required Description
requestParameters ListPaymentsLinksParameters ❌ Request Parameters Object

Return Type

ApiPaymentCampaignListResponseDto

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.ApiPaymentCampaignListResponseDto;
import com.asaas.apisdk.models.ListPaymentsLinksParameters;

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

    ListPaymentsLinksParameters requestParameters = ListPaymentsLinksParameters.builder()
      .offset(2L)
      .limit(10L)
      .active(true)
      .includeDeleted(false)
      .name("name")
      .externalReference("externalReference")
      .build();

    ApiPaymentCampaignListResponseDto response = asaasSdk.paymentLink.listPaymentsLinks(requestParameters);

    System.out.println(response);
  }
}

createAPaymentsLink

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

Parameters

Name Type Required Description
apiPaymentCampaignSaveRequestDto ApiPaymentCampaignSaveRequestDto ❌ Request Body

Return Type

ApiPaymentCampaignGetResponseDto

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.ApiPaymentCallbackRequestDto;
import com.asaas.apisdk.models.ApiPaymentCampaignGetResponseDto;
import com.asaas.apisdk.models.ApiPaymentCampaignSaveRequestBillingType;
import com.asaas.apisdk.models.ApiPaymentCampaignSaveRequestChargeType;
import com.asaas.apisdk.models.ApiPaymentCampaignSaveRequestCycle;
import com.asaas.apisdk.models.ApiPaymentCampaignSaveRequestDto;

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

    ApiPaymentCallbackRequestDto apiPaymentCallbackRequestDto = ApiPaymentCallbackRequestDto.builder()
      .successUrl("successUrl")
      .autoRedirect(true)
      .build();

    ApiPaymentCampaignSaveRequestDto apiPaymentCampaignSaveRequestDto = ApiPaymentCampaignSaveRequestDto.builder()
      .name("Book sales")
      .description("Any book for just R$: 50.00")
      .endDate("2024-09-05")
      .value(50D)
      .billingType(ApiPaymentCampaignSaveRequestBillingType.UNDEFINED)
      .chargeType(ApiPaymentCampaignSaveRequestChargeType.DETACHED)
      .dueDateLimitDays(10L)
      .subscriptionCycle(ApiPaymentCampaignSaveRequestCycle.WEEKLY)
      .maxInstallmentCount(1L)
      .externalReference("1287")
      .notificationEnabled(false)
      .callback(apiPaymentCallbackRequestDto)
      .isAddressRequired(true)
      .build();

    ApiPaymentCampaignGetResponseDto response = asaasSdk.paymentLink.createAPaymentsLink(
      apiPaymentCampaignSaveRequestDto
    );

    System.out.println(response);
  }
}

retrieveASinglePaymentsLink

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

Parameters

Name Type Required Description
id String ✅ Unique identifier for your payments link in Asaas

Return Type

ApiPaymentCampaignGetResponseDto

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

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

    ApiPaymentCampaignGetResponseDto response = asaasSdk.paymentLink.retrieveASinglePaymentsLink("725104409743");

    System.out.println(response);
  }
}

updateAPaymentsLink

  • HTTP Method: PUT
  • Endpoint: /v3/paymentLinks/{id}

Parameters

Name Type Required Description
id String ✅ Unique identifier for your payments link in Asaas
apiPaymentCampaignUpdateRequestDto ApiPaymentCampaignUpdateRequestDto ❌ Request Body

Return Type

ApiPaymentCampaignGetResponseDto

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.ApiPaymentCallbackRequestDto;
import com.asaas.apisdk.models.ApiPaymentCampaignGetResponseDto;
import com.asaas.apisdk.models.ApiPaymentCampaignUpdateRequestBillingType;
import com.asaas.apisdk.models.ApiPaymentCampaignUpdateRequestChargeType;
import com.asaas.apisdk.models.ApiPaymentCampaignUpdateRequestCycle;
import com.asaas.apisdk.models.ApiPaymentCampaignUpdateRequestDto;

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

    ApiPaymentCallbackRequestDto apiPaymentCallbackRequestDto = ApiPaymentCallbackRequestDto.builder()
      .successUrl("successUrl")
      .autoRedirect(true)
      .build();

    ApiPaymentCampaignUpdateRequestDto apiPaymentCampaignUpdateRequestDto = ApiPaymentCampaignUpdateRequestDto.builder()
      .name("Book sales")
      .description("Any book for just R$: 50.00")
      .endDate("2024-09-05")
      .value(50D)
      .active(true)
      .billingType(ApiPaymentCampaignUpdateRequestBillingType.UNDEFINED)
      .chargeType(ApiPaymentCampaignUpdateRequestChargeType.DETACHED)
      .dueDateLimitDays(10L)
      .subscriptionCycle(ApiPaymentCampaignUpdateRequestCycle.WEEKLY)
      .maxInstallmentCount(1L)
      .externalReference("2323")
      .notificationEnabled(false)
      .callback(apiPaymentCallbackRequestDto)
      .build();

    ApiPaymentCampaignGetResponseDto response = asaasSdk.paymentLink.updateAPaymentsLink(
      "725104409743",
      apiPaymentCampaignUpdateRequestDto
    );

    System.out.println(response);
  }
}

removeAPaymentsLink

  • HTTP Method: DELETE
  • Endpoint: /v3/paymentLinks/{id}

Parameters

Name Type Required Description
id String ✅ Unique identifier for your payments link in Asaas

Return Type

ApiPaymentCampaignDeleteResponseDto

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

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

    ApiPaymentCampaignDeleteResponseDto response = asaasSdk.paymentLink.removeAPaymentsLink("725104409743");

    System.out.println(response);
  }
}

restoreAPaymentsLink

  • HTTP Method: POST
  • Endpoint: /v3/paymentLinks/{id}/restore

Parameters

Name Type Required Description
id String ✅ Unique identifier for your payments link in Asaas
input Object ❌ Request Body

Return Type

ApiPaymentCampaignGetResponseDto

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

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

    ApiPaymentCampaignGetResponseDto response = asaasSdk.paymentLink.restoreAPaymentsLink("725104409743", new Object());

    System.out.println(response);
  }
}

listImagesFromAPaymentsLink

  • HTTP Method: GET
  • Endpoint: /v3/paymentLinks/{id}/images

Parameters

Name Type Required Description
id String ✅ Unique identifier for your payments link in Asaas

Return Type

ApiPaymentCampaignFileListResponseDto

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

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

    ApiPaymentCampaignFileListResponseDto response = asaasSdk.paymentLink.listImagesFromAPaymentsLink("725104409743");

    System.out.println(response);
  }
}

addAnImageToAPaymentsLink

  • HTTP Method: POST
  • Endpoint: /v3/paymentLinks/{id}/images

Parameters

Name Type Required Description
id String ✅ Unique identifier for your payments link in Asaas
apiPaymentCampaignFileSaveRequestDto ApiPaymentCampaignFileSaveRequestDto ❌ Request Body
_filename String ✅ Filename for the uploaded file

Return Type

ApiPaymentCampaignFileGetResponseDto

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.ApiPaymentCampaignFileGetResponseDto;
import com.asaas.apisdk.models.ApiPaymentCampaignFileSaveRequestDto;

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

		ApiPaymentCampaignFileSaveRequestDto apiPaymentCampaignFileSaveRequestDto = ApiPaymentCampaignFileSaveRequestDto.builder()
			.main(true)
			.image(ipsum nulla m)
			.build();
		ApiPaymentCampaignFileSaveRequestDto apiPaymentCampaignFileSaveRequestDto = ApiPaymentCampaignFileSaveRequestDto.builder()
			.main(true)
			.image(ipsum nulla m)
			.build();

		ApiPaymentCampaignFileGetResponseDto response = asaasSdk.paymentLink.addAnImageToAPaymentsLink("725104409743", apiPaymentCampaignFileSaveRequestDto, apiPaymentCampaignFileSaveRequestDto);

		System.out.println(response);
    }
}

retrieveASinglePaymentsLinkImage

  • HTTP Method: GET
  • Endpoint: /v3/paymentLinks/{paymentLinkId}/images/{imageId}

Parameters

Name Type Required Description
paymentLinkId String ✅ Unique identifier for your payments link in Asaas
imageId String ✅ Unique payment link image identifier in Asaas

Return Type

ApiPaymentCampaignFileGetResponseDto

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

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

    ApiPaymentCampaignFileGetResponseDto response = asaasSdk.paymentLink.retrieveASinglePaymentsLinkImage(
      "725104409743",
      "417d1fe7-f530-4368-935f-699045f2bf5d"
    );

    System.out.println(response);
  }
}

removeAnImageFromPaymentsLink

  • HTTP Method: DELETE
  • Endpoint: /v3/paymentLinks/{paymentLinkId}/images/{imageId}

Parameters

Name Type Required Description
paymentLinkId String ✅ Unique identifier for your payments link in Asaas
imageId String ✅ Unique payment link image identifier in Asaas

Return Type

ApiPaymentCampaignFileDeleteResponseDto

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

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

    ApiPaymentCampaignFileDeleteResponseDto response = asaasSdk.paymentLink.removeAnImageFromPaymentsLink(
      "725104409743",
      "417d1fe7-f530-4368-935f-699045f2bf5d"
    );

    System.out.println(response);
  }
}

setPaymentsLinkMainImage

  • HTTP Method: PUT
  • Endpoint: /v3/paymentLinks/{paymentLinkId}/images/{imageId}/setAsMain

Parameters

Name Type Required Description
paymentLinkId String ✅ Unique identifier for your payments link in Asaas
imageId String ✅ Unique payment link image identifier in Asaas
input Object ❌ Request Body

Return Type

ApiPaymentCampaignFileGetResponseDto

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

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

    ApiPaymentCampaignFileGetResponseDto response = asaasSdk.paymentLink.setPaymentsLinkMainImage(
      "725104409743",
      "417d1fe7-f530-4368-935f-699045f2bf5d",
      new Object()
    );

    System.out.println(response);
  }
}