Skip to content

brunobarros/jassinaturas

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

138 Commits

gradle/wrapper

gradle/wrapper

 
 

src

src

 
 

.gitignore

.gitignore

 
 

.travis.yml

.travis.yml

 
 

LICENSE

LICENSE

 
 

README.md

README.md

 
 

build.gradle

build.gradle

 
 

gradlew

gradlew

 
 

gradlew.bat

gradlew.bat

 
 

wercker.yml

wercker.yml

 
 

Repository files navigation

jassinaturas Client Library for Java

Coverage Status Build Status Build Status wercker status

============================================

Client library to integrate Moip Assinaturas in Java.

Moip Assinaturas is a Moip's project that makes recurrence charges. It allows to create plans, customers, subscriptions and so on.

API documentation is available at: http://moiplabs.github.io/assinaturas-docs/api.html

Dependencies

  • Feign Client - 6.0.1

Maven dependency

<dependency>
  <groupId>com.github.paniko0</groupId>
  <artifactId>jassinaturas</artifactId>
  <version>1.1.0</version>
</dependency>

=====================

Using

First of all, you'll have to instanciate a new Assinaturas passing your credentials and the environment you want to connect.

	Assinaturas assinaturas = new Assinaturas(new Authentication("YOUR_TOKEN", "YOUR_SECRET"), new (SandboxCommunicator|ProductionCommunicator)());

=====================

Plans

Creating a new plan:

	Plan toCreate = new Plan();
	toCreate
		.withCode("YOR_PLAN_CODE")
		.withDescription("YOUR_PLAN_DESCRIPTION")
		.withName("YOUR_PLAN_NAME")
		.withAmount(1000)
        .withSetupFee(100)
        .withBillingCycles(1)
        .withPlanStatus(PlanStatus.ACTIVE)
        .withMaxQty(10)
        .withInterval(new Interval()
			.withLength(10)
			.withUnit(Unit.MONTH))
        .withTrial(new Trial()
			.withDays(10)
			.enabled());

After that you have to call following method:

	Plan created = assinaturas.plan().create(toCreate);

Listing all plans:

	List<Plan> plans = assinaturas.plan().list();

Getting a single plan:

	Plan plan = assinaturas.plan().show("YOUR_PLAN_CODE");

Updating a plan:

To update a plan, you should inform your new plan params, creating a new object of Plan and passing it to update method

	Plan toUpdate = new Plan();
    toUpdate.withCode("PLAN_CODE_TO_UPDATE")
		.withDescription("PLAN_NEW_DESCRIPTION")
		.withName("PLAN_NEW_NAME")
        .withAmount(10000)
        .withSetupFee(1000)
        .withBillingCycles(10)
        .withPlanStatus(PlanStatus.INACTIVE)
        .withMaxQty(100)
        .withInterval(new Interval()
        	.withLength(100)
        	.withUnit(Unit.DAY))
        .withTrial(new Trial()
        	.withDays(5)
        	.disabled());

After informing what you want to update, just call the following method:

    Plan plan = assinaturas.plan().update(toUpdate);

Activating a plan:

	Plan plan = assinaturas.plan().active("YOUR_PLAN_CODE");

Inactivating a plan:

	Plan plan = assinaturas.plan().inactive(toInactivate);

=====================

Subscriptions

Creating a new subscription

	Subscription toBeCreated = new Subscription();
    toBeCreated
        .withCode("YOUR_SUBSCRIPTION_CODE")
        .withAmount(100)
        .withPlan(
            new Plan()
    			.withCode("YOUR_PLAN_CODE"))
        .withCustomer(
            new Customer()
                .withCode("YOUR_CUSTOMER_CODE")
                .withBirthdate(
                    new Birthdate()
                        .withDay(13)
                        .withMonth(Month.OCTOBER)
                        .withYear(1989))
                .withCpf("CPF_NUMBER")
                .withEmail("some@email.com")
                .withFullname("CUSTOMER_NAME")
                .withPhoneAreaCode("CUSTOMER_PHONE_AREA_CODE")
                .withPhoneNumber("CUSTOMER_PHONE_NUMBER")
                .withAddress(
                    new Address()
                        .withCity("São Paulo")
                        .withComplement("Apto")
                        .withCountry(Country.BRA)
                        .withDistrict("Centro")
                        .withNumber("1000")
                        .withState(State.SP)
                        .withStreet("Some Street")
                        .withZipcode("00000-000"))
                .withBillingInfo(
                    new BillingInfo()
                    	.withCreditCard(new CreditCard()
                        	.withExpirationMonth("10")
                            .withExpirationYear("18")
                            .withHolderName("Some Name")
                            .withNumber("4111111111111111"))));

You can also create a subscription just informing an already created customer:

	Subscription toBeCreated = new Subscription();
    toBeCreated
        .withCode("SUBSCRIPTION_CODE")
		.withAmount(100)
        .withCustomer(new Customer()
			.withCode("YOUR_CUSTOMER_CODE"))
        .withPlan(new Plan()
			.withCode("YOUR_PLAN_CODE"));

You also can use boleto bancário:

	Subscription toBeCreated = new Subscription();
    toBeCreated
        .withCode("SUBSCRIPTION_CODE")
		.withAmount(100)
		.withPaymentMethod("BOLETO")
        .withCustomer(new Customer()
			.withCode("YOUR_CUSTOMER_CODE"))
        .withPlan(new Plan()
			.withCode("YOUR_PLAN_CODE"));

Then you'll need to call the following method:

	Subscription created = assinaturas.subscription().create(toBeCreated);

Updating a subscription

	Subscription toUpdate = new Subscription();
    toUpdate
    	.withCode("SUBSCRIPTION_CODE")
    	.withPlan(new Plan()
			.withCode("plano01"))
    	.withAmount(990)
        .withNextInvoiceDate(new NextInvoiceDate()
			.withDay(20)
			.withMonth(Month.OCTOBER)
			.withYear(2015));

Then call the following method:

	Subscription subscription = assinaturas.subscription().update(toUpdate);

Activating a subscription:

	Subscription subscription = assinaturas.subscription().activate("SUBSCRIPTION_CODE");

Cancelling a subscription:

	Subscription subscription = assinaturas.subscription().cancel("SUBSCRIPTION_CODE");

Suspending a subscription:

	Subscription subscription = assinaturas.subscription().suspend("SUBSCRIPTION_CODE");

Getting a single subscription:

	Subscription subscription = assinaturas.subscription().show("SUBSCRIPTION_CODE");

Listing all subscriptions:

	List<Subscription> subscriptions = assinaturas.subscription().list();

Listing invoices from a subscription:

	List<Invoice> invoices = assinaturas.subscription().invoices("SUBSCRIPTION_CODE");

=====================

Customers

Creating a new customer:

    Customer toCreate = new Customer();
    toCreate.withCode("CUSTOMER_CODE")
        .withBirthdate(
            new Birthdate()
                .withDay(13)
                .withMonth(Month.OCTOBER)
                .withYear(1989))
        .withCpf("CUSTOMER_CPF")
        .withEmail("CUSTOMER_EMAIL")
        .withFullname("CUSTOMER_NAME")
        .withPhoneAreaCode("CUSTOMER_PHONE_AREA_CODE")
        .withPhoneNumber("CUSTOMER_PHONE_NUMBER")
        .withAddress(
            new Address()
                .withCity("CUSTOMER_CITY")
                .withComplement("CUSTOMER_COMPLEMENT")
                .withCountry(Country.BRA)
                .withDistrict("CUSTOMER_DISTRICT")
                .withNumber("CUSTOMER_ADDRESS_NUMBER")
                .withState(State.SP)
                .withStreet("CUSTOMER_STREET")
                .withZipcode("CUSTOMER_ZIPCODE"))
        .withBillingInfo(
            new BillingInfo()
                .withCreditCard(
                    new CreditCard()
                        .withExpirationMonth("10")
                        .withExpirationYear("18")
                        .withHolderName("CARD_HOLDER_NAME")
                        .withNumber("4111111111111111")));

You can also create a customer without credit card information:

    Customer toCreate = new Customer();
    toCreate.withCode("CUSTOMER_CODE")
        .withBirthdate(
            new Birthdate()
                .withDay(13)
                .withMonth(Month.OCTOBER)
                .withYear(1989))
        .withCpf("CUSTOMER_CPF")
        .withEmail("CUSTOMER_EMAIL")
        .withFullname("CUSTOMER_NAME")
        .withPhoneAreaCode("CUSTOMER_PHONE_AREA_CODE")
        .withPhoneNumber("CUSTOMER_PHONE_NUMBER")
        .withAddress(
            new Address()
                .withCity("CUSTOMER_CITY")
                .withComplement("CUSTOMER_COMPLEMENT")
                .withCountry(Country.BRA)
                .withDistrict("CUSTOMER_DISTRICT")
                .withNumber("CUSTOMER_ADDRESS_NUMBER")
                .withState(State.SP)
                .withStreet("CUSTOMER_STREET")
                .withZipcode("CUSTOMER_ZIPCODE"));

After creating the customer object, you'll have to call the following method:

    Customer created = assinaturas.customer().create(toCreate);

Updating a customer:

    Customer toUpdate = new Customer();
    toUpdate
        .withCode("CUSTOMER_CODE")
        .withBirthdate(
            new Birthdate()
                .withDay(13)
                .withMonth(Month.OCTOBER)
                .withYear(1989))
        .withCpf("CUSTOMER_CPF")
        .withEmail("NEW_EMAIL")
        .withFullname("CUSTOMER_NAME")
        .withPhoneAreaCode("PHONE_AREA_CODE")
        .withPhoneNumber("PHONE_NUMBER")
        .withAddress(
            new Address()
                .withStreet("CUSTOMER_STREET_NAME")
                .withCity("CUSTOMER_CITY")
                .withComplement("CUSTOMER_COMPLEMENT_IF_EXISTS")
                .withCountry(Country.BRA)
                .withDistrict("CUSTOMER_DISTRICT")
                .withNumber("CUSTOMER_STREET_NUMBER")
                .withState(State.SP)
                .withZipcode("CUSTOMER_ZIP_CODE"));

After that just call the method:

    Customer created = assinaturas.customer().update(toUpdate);

Updating only credit card vault:

    Customer toUpdate = new Customer();
    toUpdate
        .withCode("CUSTOMER_CODE")
        .withBillingInfo(
            new BillingInfo()
                .withCreditCard(
                    new CreditCard()
                        .withExpirationMonth("10")
                        .withExpirationYear("18")
                        .withHolderName("CARD_HOLDER_NAME")
                        .withNumber("4111111111111111")));

After that just call the method:

    Customer updated = assinaturas.customer().updateVault(toUpdate);

Listing all customers:

    List<Customer> customers = assinaturas.customer().list();

Showing a single customer:

    Customer customer = assinaturas.customer().show("CUSTOMER_CODE");

=====================

Invoices

Getting single invoice:

    Invoice invoice = assinaturas.invoices().show(INVOICE_ID);

Getting payments from an invoice:

    List<Payment> payments = assinaturas.invoices().payments(INVOICE_ID);

Retring an invoice:

    Invoice invoice = assinaturas.invoices().retry(INVOICE_ID);

Gerar um novo boleto para uma fatura (invoice). Please see https://dev.moip.com.br/v1.5/reference#retentativa-de-pagamento-de-uma-fatura-por-boleto:

    Invoice invoice = assinaturas.invoices().newBoleto(INVOICE_ID, vencimentoBoleto);

=====================

Coupons

Creating coupon:

    toBeCreated.withCode("COUPON_CODE")
            .withName("COUPON_NAME")
            .withDescription("COUPON_DESCRIPTION")
            .withDiscount(new Discount()
                        .withValue(1000)
                        .withType(DiscountType.PERCENT))
            .withStatus(CouponStatus.ACTIVE)
            .withDuration(new Duration()
                    .withType(DurationType.REPEATING)
                    .withOccurrences(1))
            .withExpirationDate(new ExpirationDate()
                    .withDay(10)
                    .withMonth(Month.OCTOBER)
                    .withYear(2020))
            .withMaxRedemptions(1000);

Then call:

    Coupon coupon = assinaturas.coupons().create(toBeCreated);

To activate a coupon:

    Coupon coupon = assinaturas.coupons().inactivate(couponCode);

To inactive a coupon:

    Coupon coupon = assinaturas.coupons().inactivate(couponCode);

====================

Thanks

  • Rodrigo Saito - @rodrigosaito
  • Breno Oliveira - @brenooliveira
  • Fernando Petroni - @febpetroni

wercker status

====================

Contributing

====================

License

== Copyright

Copyright (c) 2014 Danillo Souza. Distributed under the MIT license. See LICENSE for details.

About

Moip Assinaturas Client Library for Java

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 5

1.2.3.2 Latest
Dec 14, 2020
+ 4 releases

Packages

No packages published

Languages

  • Java 100.0%