adnansorg/rxp-remote-java

The official Realex Payments Remote Java SDK.

Realex Remote Java SDK

You can sign up for a Realex account at https://developer.realexpayments.com

Requirements

Java 1.6 and later.

Installation

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.realexpayments.remote.sdk</groupId>
  <artifactId>rxp-remote-java</artifactId>
  <version>1.3.1</version>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.realexpayments.remote.sdk:rxp-remote-java:1.3.1"

Usage

Please see https://developer.realexpayments.com for more comprehensive integration guides.

Authorisation

Card card = new Card()
	.addExpiryDate("0119")
	.addNumber("4242424242424242")
	.addType(CardType.VISA)
	.addCardHolderName("Joe Smith")
	.addCvn("123")
	.addCvnPresenceIndicator(PresenceIndicator.CVN_PRESENT);

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.AUTH)
	.addAmount(100)
	.addCurrency("EUR")
	.addCard(card)
	.addAutoSettle(new AutoSettle().addFlag(AutoSettleFlag.TRUE));

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Authorisation (With Address Verification)

Card card = new Card()
	.addExpiryDate("0119")
	.addNumber("420000000000000000")
	.addType(CardType.VISA)
	.addCardHolderName("Joe Smith")
	.addCvn("123")
	.addCvnPresenceIndicator(PresenceIndicator.CVN_PRESENT);
 
PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.AUTH)
	.addAmount(100)
	.addCurrency("EUR")
	.addCard(card)
	.addAutoSettle(new AutoSettle().addFlag(AutoSettleFlag.TRUE))
	.addAddressVerificationServiceDetails("382 The Road", "WB1 A42");

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Authorisation (Mobile)

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.AUTH_MOBILE)
	.addAutoSettle(new AutoSettle().addFlag(AutoSettleFlag.TRUE))
	.addMobile("apple-pay")
	.addToken("{auth mobile payment token}");

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Settle

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.SETTLE)
	.addOrderId("Order ID from original transaction")
	.addAmount(100)
	.addCurrency("EUR")
	.addPaymentsReference("pasref from original transaction");

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Void

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.VOID)
	.addOrderId("Order ID from original transaction")
	.addPaymentsReference("pasref from original transaction");

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Rebate

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.REBATE)
	.addOrderId("Order ID from original transaction")
	.addAmount(100)
	.addCurrency("EUR")
	.addPaymentsReference("pasref from original transaction")
	.addAuthCode("Auth code from original transaction")
	.addRefundHash("SHA1 hash of rebate password");

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

OTB

Card card = new Card()
	.addExpiryDate("0119")
	.addNumber("420000000000000000")
	.addType(CardType.VISA)
	.addCardHolderName("Joe Smith")
	.addCvn("123")
	.addCvnPresenceIndicator(PresenceIndicator.CVN_PRESENT);
 
 PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.OTB)
	.addCard(card);
	
RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);	

Refund

Card card = new Card()
	.addExpiryDate("0119")
	.addNumber("420000000000000000")
	.addType(CardType.VISA)
	.addCardHolderName("Joe Smith")
	.addCvn("123")
	.addCvnPresenceIndicator(PresenceIndicator.CVN_PRESENT);
	
PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.REFUND)
	.addAmount(100)
	.addCurrency("EUR")
	.addCard(card)
	.addRefundHash("SHA1 hash of refund password");
 
RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Hold

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.HOLD)
	.addReasonCode(ReasonCode.OUT_OF_STOCK)
	.addOrderId("Order ID from original transaction")
	.addPaymentsReference("Pasref from original transaction");

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Release

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.RELEASE)
	.addReasonCode(ReasonCode.FALSE_POSITIVE)
	.addOrderId("Order ID from original transaction")
	.addPaymentsReference("Pasref from original transaction");

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Receipt-In

PaymentData paymentData = new PaymentData()
  	.addCvnNumber("123");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
 	.addType(PaymentType.RECEIPT_IN)
 	.addAmount(100)
 	.addCurrency("EUR")
 	.addPayerReference("payer ref for customer")
 	.addPaymentMethod("payment method ref for card")
 	.addPaymentData(paymentData);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Payment-out

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
 	.addType(PaymentType.PAYMENT_OUT) 	
 	.addAmount(100)
 	.addCurrency("EUR")
 	.addPayerReference("payer ref for customer")
 	.addPaymentMethod("payment method ref for card")
 	.addRefundHash("SHA1 hash of refund password");

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Payer-new

PayerAddress address = new PayerAddress()
    .addLine1("Apt 167 Block 10")
    .addLine2("The Hills")
    .addLine3("67-69 High St")
    .addCity("Hytown")
    .addCounty("Dunham")
    .addPostcode("3")
    .addCountryCode("IE")
    .addCountryName("Ireland");
    

Payer payer = new Payer()
    .addType("Business")
    .addRef("smithj01")
    .addTitle("Mr")
    .addFirstName("John")
    .addSurname("Smith")
    .addCompany("Acme")
    .addPayerAddress(address)
    .addHomePhoneNumber("+35317285355")
    .addWorkPhoneNumber("+35317433923")
    .addFaxPhoneNumber("+35317893248")
    .addMobilePhoneNumber("+353873748392")
    .addEmail("jsmith@acme.com")
    .addComment("Comment1")
    .addComment("Comment2");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
 	.addType(PaymentType.PAYER_NEW)  	
 	.addPayer(payer);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Payer-edit

PayerAddress address = new PayerAddress()
    .addLine1("Apt 167 Block 10")
    .addLine2("The Hills")
    .addLine3("67-69 High St")
    .addCity("Hytown")
    .addCounty("Dunham")
    .addPostcode("3")
    .addCountryCode("IE")
    .addCountryName("Ireland");
    

Payer payer = new Payer()
    .addType("Business")
    .addRef("smithj01")
    .addTitle("Mr")
    .addFirstName("John")
    .addSurname("Smith")
    .addCompany("Acme")
    .addPayerAddress(address)
    .addHomePhoneNumber("+35317285355")
    .addWorkPhoneNumber("+35317433923")
    .addFaxPhoneNumber("+35317893248")
    .addMobilePhoneNumber("+353873748392")
    .addEmail("jsmith@acme.com")
    .addComment("Comment1")
    .addComment("Comment2");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
 	.addType(PaymentType.PAYER_EDIT)  	
 	.addPayer(payer);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Card-new

Card card = new Card()
    .addReference("visa01")
    .addPayerReference("smithj01")
    .addNumber("420000000000000000")    
	.addExpiryDate("0119")	
	.addCardHolderName("Joe Smith")
	.addType(CardType.VISA)
	.addIssueNumber("1");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
 	.addType(PaymentType.CARD_NEW)  	
 	.addCard(card);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Card-edit

Card card = new Card()
    .addReference("visa01")
    .addPayerReference("smithj01")
    .addNumber("420000000000000000")    
	.addExpiryDate("0119")	
	.addCardHolderName("Joe Smith")
	.addType(CardType.VISA);

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
 	.addType(PaymentType.CARD_UPDATE)  	
 	.addCard(card);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Card-delete

Card card = new Card()
    .addReference("visa01")
    .addPayerReference("smithj01");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
 	.addType(PaymentType.CARD_CANCEL)  	
 	.addCard(card);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Verify Card Enrolled

PaymentData paymentData = new PaymentData()
  	.addCvnNumber("123");


ThreeDSecureRequest request = new ThreeDSecureRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
  	.addType(ThreeDSecureType.VERIFY_CARD_ENROLLED)
  	.addAmount(100)
  	.addCurrency("EUR")
  	.addPayerReference("payer ref from customer")
  	.addPaymentMethod("payment method ref from customer")
  	.addPaymentData(paymentData)
  	.addAutoSettle(new AutoSettle().addFlag(AutoSettleFlag.TRUE));
 	

RealexClient client = new RealexClient("shared secret");
ThreeDSecureResponse response = client.send(request);

DCC Rate Lookup

Card card = new Card()    
    .addNumber("420000000000000000")    
	.addExpiryDate("0119")	
	.addCardHolderName("Joe Smith")
	.addType(CardType.VISA);
	
DccInfo dccInfo = new DccInfo()
    .addDccProcessor("fexco");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
  	.addType(PaymentType.DCC_RATE_LOOKUP)
  	.addAmount(100)
  	.addCurrency("EUR")
  	.addCard(card)
  	.addDccInfo(dccInfo);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Authorisation with DCC Information

Card card = new Card()    
    .addNumber("420000000000000000")    
	.addExpiryDate("0119")	
	.addCardHolderName("Joe Smith")
	.addType(CardType.VISA);
	
DccInfo dccInfo = new DccInfo()
    .addDccProcessor("fexco")
    .addRate(0.6868)
    .addAmount(13049)
    .addCurrency("GBP");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
  	.addType(PaymentType.DCC_AUTH)
  	.addAmount(19000)
  	.addCurrency("EUR")
  	.addCard(card)
  	.addDccInfo(dccInfo);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Receipt-in OTB

 
 PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
	.addType(PaymentType.RECEIPT_IN_OTB)
	.addPayerReference("payer ref from customer")
    .addPaymentMethod("payment method ref from customer");
	
RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);	

DCC Stored Card Dcc Rate

	
DccInfo dccInfo = new DccInfo()
    .addDccProcessor("fexco");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
  	.addType(PaymentType.STORED_CARD_DCC_RATE)
  	.addAmount(100)
  	.addCurrency("EUR")
 	.addPayerReference("payer ref for customer")
 	.addPaymentMethod("payment method ref for card")
  	.addDccInfo(dccInfo);

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Fraud Filter Request

Card card = new Card()
  	.addExpiryDate("0119")
  	.addNumber("4242424242424242")
  	.addType(CardType.VISA)
  	.addCardHolderName("Joe Smith")
  	.addCvn("123");

PaymentRequest request = new PaymentRequest()
	.addMerchantId("Merchant ID")
	.addAccount("internet")
  	.addType(PaymentType.AUTH)
  	.addAmount(1000)
  	.addCurrency("EUR")
  	.addCard(card)
  	.addAutoSettle(new AutoSettle().addFlag(AutoSettleFlag.TRUE))
  	.addFraudFilter(new FraudFilter().addMode(FraudFilter.FraudFilterMode.PASSIVE));

RealexClient client = new RealexClient("shared secret");
PaymentResponse response = client.send(request);

Fraud Filter Response

// request is fraud filter
PaymentResponse response = client.send(request);

FraudFilter.FraudFilterMode mode = response.getFraudFilter().getMode();
FraudFilter.FraudFilterResult result = response.getFraudFilter().getResult();

List<FraudFilterRule> rules = response.getFraudFilter().getRules();

for (FraudFilterRule rule :rules ) {
    System.out.print(rule.getId());
    System.out.print(rule.getName());
    System.out.print(rule.getValue());
}
//or        
rules.get(0).getId();

License

See the LICENSE file.