Skip to content
This repository has been archived by the owner on Apr 14, 2021. It is now read-only.

sentenial/nuapay-rest-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

122 Commits
src
src
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 

Repository files navigation

NuaPay REST Client (DEPRECATED)

DEPRECATED PROJECT DO NOT USE

This code is no longer maintained please generate client code by using swagger code gen off our swagger specifications instead. see https://developer.nuapay.com

Requirements

Java 6 or later.

Dependencies

  • Apache Commons IO
  • Apache Commons Codec
  • Apache HttpComponents
  • Jackson
  • slf4j
  • log4j

Usage

Released versions of the library is accessible through Maven Central, so you can easily include in your building scripts.

E.g. for maven:

<dependency>
    <groupId>com.sentenial</groupId>
    <artifactId>nuapay-rest-client</artifactId>
    <version>[VERSION].RELEASE</version>
</dependency>

Building from sources

  • Download source project
  • Generate jar file using mvn clean package command, then
  • Ensure the jar is on your classpath
  • Ensure you have the dependency jars on your classpath

Tips

  • If for debug purposes you need to print content of HTTP requests / responses, then you can set following loggin level:
log4j.logger.org.apache.http=DEBUG

Example

Simple code to create mandate:

import com.sentenial.rest.client.api.common.dto.Account;
import com.sentenial.rest.client.api.common.dto.Address;
import com.sentenial.rest.client.api.common.service.SentenialException;
import com.sentenial.rest.client.api.common.service.ServiceConfiguration;
import com.sentenial.rest.client.api.mandate.MandateService;
import com.sentenial.rest.client.api.mandate.MandateServiceDefault;
import com.sentenial.rest.client.api.mandate.dto.CreateMandateRequest;
import com.sentenial.rest.client.api.mandate.dto.CreateMandateResponse;
import com.sentenial.rest.client.api.mandate.dto.Debtor;
import com.sentenial.rest.client.api.mandate.dto.Mandate;
import com.sentenial.rest.client.api.mandate.dto.MandateInfo;
import com.sentenial.rest.client.api.mandate.dto.MandateType;
import com.sentenial.rest.client.utils.DateUtils;

public class RestClientSampleApp {

	public static void main(String[] args) {
		
		ServiceConfiguration serviceConfiguration = new ServiceConfiguration();
		serviceConfiguration.setApiKey("Your-APIKEY-here");

		MandateService mandateService = new MandateServiceDefault(serviceConfiguration);
		
		CreateMandateRequest createMandateRequest = 
				new CreateMandateRequest()
					.withMandate(
						new Mandate()
							.withDebtor(
									new Debtor()
										.withName("Debtor Name")
										.withAddress(
												new Address()
													.withLine1("Debtor Address Line1")
													.withLine2("Debtor Address Line2")
													.withTown("Debtor Town")
													.withPostCode("123123")
													.withState("Debtor State")
													.withCountry("IE")
												)
										.withLanguage("fr_BE")
										.withEmail("debtor@email.com")
										.withPhoneNumber("0360123123123")
										.withMobileNumber("0360321312312")
										)
							.withMandateInfo(
									new MandateInfo()
										.withMandateId("1234567899")
										.withContractReference("Contract Reference")
										.withSignatureLocation("Signature Location")
										.withSignatureDate(DateUtils.toDate("2015-07-21"))
										.withMandateType(MandateType.RCUR)
										)
							.withDebtorAccount(
									new Account()
										.withIban("GB94SELN00999976543215")
									)
							.withCreditorAccount(
									new Account()
										.withIban("GB47SELN00999912345678")
									)
						);

		try{
			CreateMandateResponse createMandateResponse = 
						mandateService.createMandate("ybo8lg392q", createMandateRequest);
			System.out.println(createMandateResponse.getData());
		} catch (SentenialException ex){
			ex.printStackTrace();
		}
	}
}

Example with Proxy

Simple code to list creditor schemes:

package com.sentenial.core.processing.enrichment.credittransfer;

import com.sentenial.rest.client.api.common.dto.BasicAccount;
import com.sentenial.rest.client.api.common.service.SentenialException;
import com.sentenial.rest.client.api.common.service.ServiceConfiguration;
import com.sentenial.rest.client.api.creditorscheme.CreditorSchemeService;
import com.sentenial.rest.client.api.creditorscheme.CreditorSchemeServiceDefault;
import com.sentenial.rest.client.api.creditorscheme.dto.ListCreditorSchemesResponse;
import com.sentenial.rest.client.api.mandate.dto.CreateMandateRequest;
import com.sentenial.rest.client.api.mandate.dto.Debtor;
import com.sentenial.rest.client.api.mandate.dto.Mandate;

public class RestClientProxySampleApp {

    public static void main(String[] args) {

        ServiceConfiguration serviceConfiguration = new ServiceConfiguration();
        serviceConfiguration.setApiKey("Your-APIKEY-here");
        // proxy configuration, set all 3 values
        serviceConfiguration.setProxyHost("Your-Host");
        serviceConfiguration.setProxyPort(1234);        
        serviceConfiguration.setProxyScheme("http");

        CreditorSchemeService csService = new CreditorSchemeServiceDefault(serviceConfiguration);
      
        CreateMandateRequest createMandateRequest = 
                new CreateMandateRequest()
                    .withMandate(
                        new Mandate()
                            .withDebtor(
                                    new Debtor()
                                        .withName("Debtor Name")                                       
                                        )                            
                            .withDebtorAccount(
                                    new BasicAccount()
                                        .withIban("IE44BOFI90387502070002")
                                    )
                            
                        );

        try {         
        	ListCreditorSchemesResponse createMandateResponse = csService.listCreditorSchemes();
            System.out.println(createMandateResponse.getData());
        } catch (SentenialException ex){
            ex.printStackTrace();
        }
    }
}

Example

Simple code to create mandate and single direct debit:

import java.math.BigDecimal;

import com.sentenial.rest.client.api.common.dto.Address;
import com.sentenial.rest.client.api.common.dto.BasicAccount;
import com.sentenial.rest.client.api.common.dto.CommunicationLanguage;
import com.sentenial.rest.client.api.common.service.SentenialException;
import com.sentenial.rest.client.api.common.service.ServiceConfiguration;
import com.sentenial.rest.client.api.directdebit.DirectDebitService;
import com.sentenial.rest.client.api.directdebit.DirectDebitServiceDefault;
import com.sentenial.rest.client.api.directdebit.dto.CreateDirectDebitAndMandateRequest;
import com.sentenial.rest.client.api.directdebit.dto.CreateDirectDebitAndMandateResponse;
import com.sentenial.rest.client.api.mandate.dto.Debtor;
import com.sentenial.rest.client.api.mandate.dto.Mandate;
import com.sentenial.rest.client.api.mandate.dto.MandateInfo;
import com.sentenial.rest.client.api.mandate.dto.MandateType;
import com.sentenial.rest.client.utils.DateUtils;

public class RestClientSampleApp {

	public static void main(String[] args) {
		
		ServiceConfiguration serviceConfiguration = new ServiceConfiguration();
		serviceConfiguration.setApiKey("Your-APIKEY-here");

		DirectDebitService directDebitService = new DirectDebitServiceDefault(serviceConfiguration);
		
		CreateDirectDebitAndMandateRequest createDirectDebitAndMandateRequest = 
			new CreateDirectDebitAndMandateRequest().withMandate(
				new Mandate().withDebtor(
					new Debtor()
						.withName("Debtor Name")
						.withAddress(
								new Address()
									.withLine1("Debtor Address Line1")
									.withLine2("Debtor Address Line2")
									.withTown("Debtor Town")
									.withPostCode("123123")
									.withState("Debtor State")
									.withCountry("IE")
								)
						.withLanguage(CommunicationLanguage.fr_BE)
						.withEmail("debtor@email.com")
						.withPhoneNumber("0360123123123")
						.withMobileNumber("0360321312312")
						)
				.withMandateInfo(
					new MandateInfo()
						.withMandateId("1234567899")
						.withContractReference("Contract Reference")
						.withSignatureLocation("Signature Location")
						.withSignatureDate(DateUtils.toDate("2015-07-21"))
						.withMandateType(MandateType.RCUR)
						)
				.withDebtorAccount(
					new BasicAccount()
						.withIban("GB94SELN00999976543215")
					)
				.withCreditorAccount(
					new BasicAccount()
						.withIban("GB47SELN00999912345678")
					)
				);
		createDirectDebitAndMandateRequest
					.withRequestedCollectionDate(DateUtils.toDate("2017-10-30"))
					.withPaymentAmount(new BigDecimal("5000.01"))
					.withEndToEndId("5234567876543230007")
					.withRemittanceInformation("Remittance Information");

		try{
			CreateDirectDebitAndMandateResponse createDirectDebitAndMandateResponse = 
					directDebitService.createDirectDebitAndMandate("ybo8lg392q", createDirectDebitAndMandateRequest);
			System.out.println(createDirectDebitAndMandateResponse.getData());
		} catch (SentenialException ex){
			ex.printStackTrace();
		}
	}
}

Example

Simple code to create mandate and payment schedule:

import java.math.BigDecimal;

import com.sentenial.rest.client.api.common.dto.Address;
import com.sentenial.rest.client.api.common.dto.BasicAccount;
import com.sentenial.rest.client.api.common.dto.CommunicationLanguage;
import com.sentenial.rest.client.api.common.service.SentenialException;
import com.sentenial.rest.client.api.common.service.ServiceConfiguration;
import com.sentenial.rest.client.api.mandate.dto.Debtor;
import com.sentenial.rest.client.api.mandate.dto.Mandate;
import com.sentenial.rest.client.api.mandate.dto.MandateInfo;
import com.sentenial.rest.client.api.mandate.dto.MandateType;
import com.sentenial.rest.client.api.paymentschedule.PaymentScheduleService;
import com.sentenial.rest.client.api.paymentschedule.PaymentScheduleServiceDefault;
import com.sentenial.rest.client.api.paymentschedule.dto.CreatePaymentScheduleAndMandateRequest;
import com.sentenial.rest.client.api.paymentschedule.dto.CreatePaymentScheduleAndMandateResponse;
import com.sentenial.rest.client.api.paymentschedule.dto.PaymentFrequency;
import com.sentenial.rest.client.api.paymentschedule.dto.PaymentSchedule;
import com.sentenial.rest.client.api.paymentschedule.dto.PaymentType;
import com.sentenial.rest.client.utils.DateUtils;

public class RestClientSampleApp {

	public static void main(String[] args) {
		
		ServiceConfiguration serviceConfiguration = new ServiceConfiguration();
		serviceConfiguration.setApiKey("Your-APIKEY-here");

		PaymentScheduleService paymentScheduleService = new PaymentScheduleServiceDefault(serviceConfiguration);
		
		CreatePaymentScheduleAndMandateRequest createPaymentScheduleAndMandateRequest = 
			new CreatePaymentScheduleAndMandateRequest().withMandate(
				new Mandate().withDebtor(
					new Debtor()
						.withName("Debtor Name")
						.withAddress(
							new Address()
								.withLine1("Debtor Address Line1")
								.withLine2("Debtor Address Line2")
								.withTown("Debtor Town")
								.withPostCode("123123")
								.withState("Debtor State")
								.withCountry("IE")
							)
						.withLanguage(CommunicationLanguage.fr_BE)
						.withEmail("debtor@email.com")
						.withPhoneNumber("0360123123123")
						.withMobileNumber("0360321312312")
						)
				.withMandateInfo(
					new MandateInfo()
						.withMandateId("1234567899")
						.withContractReference("Contract Reference")
						.withSignatureLocation("Signature Location")
						.withSignatureDate(DateUtils.toDate("2015-07-21"))
						.withMandateType(MandateType.RCUR)
						)
				.withDebtorAccount(
					new BasicAccount()
						.withIban("GB94SELN00999976543215")
					)
				.withCreditorAccount(
					new BasicAccount()
						.withIban("GB47SELN00999912345678")
					)
				);
		createPaymentScheduleAndMandateRequest.withPaymentSchedule(
			new PaymentSchedule()
				.withPaymentFrequency(PaymentFrequency.DAILY)
				.withPaymentType(PaymentType.FIXED_LENGTH)
				.withStartDate(DateUtils.toDate("2017-06-23"))
				.withNumberOfPayments(2)
				.withPaymentAmount(new BigDecimal("9.90"))
				.withFirstPaymentAmount(new BigDecimal("1.10"))
				.withLastPaymentAmount(new BigDecimal("9.90"))
				.withRemittanceInformation("remittanceInformation")
				.withTwoPaymentsSamePeriod(true));
		
		try{
			CreatePaymentScheduleAndMandateResponse createPaymentScheduleAndMandateResponse = 
					paymentScheduleService.createPaymentScheduleAndMandate("ybo8lg392q", createPaymentScheduleAndMandateRequest);
			System.out.println(createPaymentScheduleAndMandateResponse.getData());
		} catch (SentenialException ex){
			ex.printStackTrace();
		}
	}
}

For more details refer to the documentation.

About

NuaPay REST API Java client

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

4 stars

Watchers

6 watching

Forks

5 forks
Report repository

Releases

20 tags

Packages

No packages published

Contributors 6

Languages