Skip to content

bayonetio/bayonet-java

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits

gradle/wrapper

gradle/wrapper

 
 

src/main/java/io/bayonet

src/main/java/io/bayonet

 
 

.gitignore

.gitignore

 
 

LICENSE

LICENSE

 
 

README.md

README.md

 
 

build.gradle

build.gradle

 
 

gradlew

gradlew

 
 

gradlew.bat

gradlew.bat

 
 

Repository files navigation

Bayonet

Bayonet enables companies to feed and consult a global database about online consumers’ reputation, based on historic payments. Start making smarter business decisions today.

Introduction

Bayonet’s API is organized around REST and exposes endpoints for HTTP requests. It is designed to have predictable, resource-oriented URLs and uses standard HTTP response codes to indicate the outcome of operations. Request and response payloads are formatted as JSON.

About the service

Bayonet provides an Ecosystem of Trust and Protection where companies can colaborate with each other to combat online fraud together. We provide a secure platform to share and consult data to understand when a consumer is related to fraudulent activity or has a fraud-free record. Different technologies that run algorithms to link parameters seen in different transactions, fed by companies connected to the ecosystem are employed in order to build consumer profiles. By consulting Bayonet’s API, a response with data provided by companies themselves is available in real-time for your risk assesment process to analyze it and take better decisions.

Bayonet's API details

The examples shown in this README are only for demonstration of the functionality of this SDK. For the detailed integration flow, and when to send which API call, please refer to the Bayonet API documentation.

Getting started

To use this SDK, please make sure:

  • You have Java 1.7 or superior installed on your system.

  • You have an API KEY (sandbox and/or live) generated on your Bayonet console.

  • Maven:

    <dependency>
  <groupId>io.bayonet</groupId>
  <artifactId>bayonet-java</artifactId>
  <version>2.12.0</version>
</dependency>

  • Gradle:

    dependencies {
    compile 'io.bayonet:bayonet-java:2.12.0'
}

  • Manually:

    You can also install the Bayonet SDK manually. Please downloaded the latest build from the releases page. The zip contains bayonet-java and Gson (that bayonet-java depends on). Make sure you add both JARs to your project

Usage

Once you have Bayonet's SDK configured, you can call the APIs with the following syntax. Follow the guidelines specific to the product you are integrating:

Ecommerce

  • Consult API

    import io.bayonet.clients.EcommerceClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.base.Address;
import io.bayonet.model.base.Product;
import io.bayonet.model.base.RulesTriggered;
import io.bayonet.model.ecommerce.EcommerceConsultRequest;

import java.util.ArrayList;
import java.util.HashMap;

/* Initialize the Ecommerce client with your Api key and Api version */
EcommerceClient client = new EcommerceClient("<your api key>", "<api version>");

/* Build the consult request */
EcommerceConsultRequest params = new EcommerceConsultRequest()
        .setEmail("example@bayonet.io")
        .setConsumerName("Example name")
        .setConsumerInternalId("<your internal ID for this consumer>")
        .setCardholderName("Example name")
        .setTelephone("1234567890")
        .setCardNumber("4242424242424242")
        .setTransactionAmount(100.00)
        .setCurrencyCode("MXN")
        .setPaymentMethod("card")
        .setPaymentGateway("stripe")
        .setChannel("ecommerce")
        .setShippingAddress(
            new Address()
                .setLine1("example line 1")
                .setLine2("example line 2")
                .setCity("Mexico City")
                .setState("CDMX")
                .setCountry("MEX")
                .setZipCode("1234")
        )
        .setBillingAddress(new Address()
                .setLine1("example line 1")
                .setLine2("example line 2")
                .setCity("Mexico City")
                .setState("CDMX")
                .setCountry("MEX")
                .setZipCode("1234"))
        .setOrderId("<your internal ID for this order (mandatory)>")
        .setTransactionId("<your internal transaction ID (optional)>")
        .setBayonetFingerprintToken("<token generated by Bayonet fingerprinting JS>");
        
// Add product information - products that the consumer is buying on your store
ArrayList<Product> products = new ArrayList<Product>();
        products.add(
                new Product()
                .setProductId("1")
                .setProductName("product_1")
                .setProductPrice(75.00)
                .setProductCategory("example category")
                .setProductQuantity(1)
                .setProductMetadata(new ProductMetadata()
                    .setEventTime(1517518880L)
                    .setEventLocation(new Location()
                            .setLatitude("12.12")
                            .setLongitude("12.12")
                    )
                )
        );
        products.add(
                new Product()
                .setProductId("2")
                .setProductName("product_2")
                .setProductPrice(25.00)
                .setProductCategory("example category")
                .setProductQuantity(2)
                .setProductMetadata(new ProductMetadata()
                    .setEventTime(1517518880L)
                    .setEventLocation(new Location()
                            .setLatitude("12.12")
                            .setLongitude("12.12")
                    )
                )
        );
params.setProducts(products);

/* Send consulting request */
try {
    client.consult(params);
    
    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"
    System.out.println(client.getBayonetTrackingId());                  // tracking ID for this transaction
    
    // decision whether to accept the transaction or not
    System.out.println(client.getDecision());
    // all the rules that were triggered by this consumer
    RulesTriggered rules_triggered = client.getRulesTriggered();
    // custom rules
    ArrayList<String> custom = rules_triggered.getCustom();
    // dynamic rules
    ArrayList<String> dynamic = rules_triggered.getDynamic();
    
} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

  • Update transaction API

    import io.bayonet.clients.EcommerceClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.ecommerce.EcommerceUpdateTransactionRequest;

/* Initialize the Ecommerce client with your Api key and Api version */
EcommerceClient client = new EcommerceClient("<your api key>", "<api version>");

/* Build the transaction update request */
EcommerceUpdateTransactionRequest params = new EcommerceUpdateTransactionRequest()
        .setOrderId('<your internal ID for this order (as sent in the consult step)>')
        // Or
        //.setTransactionId("<your internal transaction ID (as sent in the consult call)>")
        // Or
        //.setBayonetTrackingId('<tracking ID returned by the API in the consult step>')
        .setTransactionStatus("success")
        .setBankAuthCode("<auth code returned by the processing bank>");

// please note that you can use either one of 'order_id', 'transaction_id', or 'bayonet_tracking_id' in the params to update the status of a transaction

/* Send transaction update request */
try {
    client.updateTransaction(params);
    
    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"
    
} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

  • Feedback-historical API

    import io.bayonet.clients.EcommerceClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.base.Address;
import io.bayonet.model.base.Product;
import io.bayonet.model.ecommerce.EcommerceFeedbackHistoricalRequest;

import java.util.ArrayList;

/* Initialize the Ecommerce client with your Api key and Api version */
EcommerceClient client = new EcommerceClient("<your api key>", "<api version>");

/* Build the feedback historical request */
EcommerceFeedbackHistoricalRequest params = new EcommerceFeedbackHistoricalRequest()
        .setEmail("example@bayonet.io")
        .setConsumerName("Example name")
        .setConsumerInternalId("<your internal ID for this consumer>")
        .setCardholderName("Example name")
        .setTelephone("1234567890")
        .setCardNumber("4242424242424242")
        .setTransactionAmount(100.00)
        .setCurrencyCode("MXN")
        .setPaymentMethod("card")
        .setTransactionTime(1506468823L)
        .setPaymentGateway("stripe")
        .setChannel("ecommerce")
        .setShippingAddress(
            new Address()
                .setLine1("example line 1")
                .setLine2("example line 2")
                .setCity("Mexico City")
                .setState("CDMX")
                .setCountry("MEX")
                .setZipCode("1234")
        )
        .setBillingAddress(new Address()
                .setLine1("example line 1")
                .setLine2("example line 2")
                .setCity("Mexico City")
                .setState("CDMX")
                .setCountry("MEX")
                .setZipCode("1234"))
        .setBayonetFingerprintToken("<token generated by Bayonet fingerprinting JS>")
        .setTransactionId("<your internal transaction ID>")
        .setTransactionStatus("success")
        .setBankAuthCode("<auth code returned by the processing bank>");
        
// Add product information - products that the consumer is buying on your store
ArrayList<Product> products = new ArrayList<Product>();
        products.add(
                new Product()
                .setProductId("1")
                .setProductName("product_1")
                .setProductPrice(75.00)
                .setProductCategory("example category")
        );
        products.add(
                new Product()
                .setProductId("2")
                .setProductName("product_2")
                .setProductPrice(25.00)
                .setProductCategory("example category")
        );
params.setProducts(products);

/* Send feedback historical request */
try {
    client.feedbackHistorical(params);
    
    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"
    
} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

Lending

  • Report Transaction (Request for loan received)

    import io.bayonet.clients.LendingClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.base.Address;
import io.bayonet.model.lending.LendingReportTransactionRequest;

/* Initialize the Lending client with your Api key and Api version */
LendingClient client = new LendingClient("<your api key>", "<api version>");

/* Build the report transaction request */
LendingReportTransactionRequest params = new LendingReportTransactionRequest()
    .setEmail("example@bayonet.io")
    .setConsumerName("Example name")
    .setConsumerInternalId("<your internal ID for this consumer>")
    .setTelephoneFixed("1234567890")
    .setTelephoneMobile("1234567891")
    .setTelephoneReference1("1234567892")
    .setTelephoneReference2("1234567893")
    .setTelephoneReference3("1234567894")
    .setRfc("Example RFC")
    .setCurp("Example CURP")
    .setAddress(
        new Address()
            .setLine1("example line 1")
            .setLine2("example line 2")
            .setCity("Mexico City")
            .setState("CDMX")
            .setCountry("MEX")
            .setZipCode("1234")
    )
    .setBayonetFingerprintToken("<token generated by Bayonet fingerprinting JS>")
    .setTransactionCategory("crowdfunding")
    .setTransactionId("<your internal ID for this transaction>")
    .setTransactionTime(1506468823L);

/* Send the report transaction request */
try {
    client.reportTransaction(params);

    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"

} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

  • Report Transaction (Request for loan received) + Consult

    This lets you report a transaction (solicitud) and consult Bayonet at the same time. The only difference from the above method (Report Transaction) is that this method will also return a consult response

    import io.bayonet.clients.LendingClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.base.Address;
import io.bayonet.model.lending.LendingReportTransactionRequest;

import java.util.HashMap;

/* Initialize the Lending client with your Api key and Api version */
LendingClient client = new LendingClient("<your api key>", "<api version>");

/* Build the report transaction request */
LendingReportTransactionRequest params = new LendingReportTransactionRequest()
    .setEmail("example@bayonet.io")
    .setConsumerName("Example name")
    .setConsumerInternalId("<your internal ID for this consumer>")
    .setTelephoneFixed("1234567890")
    .setTelephoneMobile("1234567891")
    .setTelephoneReference1("1234567892")
    .setTelephoneReference2("1234567893")
    .setTelephoneReference3("1234567894")
    .setRfc("Example RFC")
    .setCurp("Example CURP")
    .setAddress(
        new Address()
            .setLine1("example line 1")
            .setLine2("example line 2")
            .setCity("Mexico City")
            .setState("CDMX")
            .setCountry("MEX")
            .setZipCode("1234")
    )
    .setBayonetFingerprintToken("<token generated by Bayonet fingerprinting JS>")
    .setTransactionCategory("crowdfunding")
    .setTransactionId("<your internal ID for this transaction>")
    .setTransactionTime(1506468823L);

/* Send the report transaction request */
try {
    client.reportTransactionAndConsult(params);

    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"
    
    // get response payload - nested Map
    HashMap<String, Object> responsePayload = client.getResponsePayload();

} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

  • Consult (consult the persona present in the transaction)

    import io.bayonet.clients.LendingClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.lending.LendingConsultRequest;

import java.util.HashMap;

/* Initialize the Lending client with your Api key and Api version */
LendingClient client = new LendingClient("<your api key>", "<api version>");

/* Build the consult request */
LendingConsultRequest params = new LendingConsultRequest()
    .setTransactionId("<transaction ID that you used when reporting the transaction or solicitud>");

/* Send the consult request */
try {
    client.consult(params);

    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"

    // get response payload - nested Map
    HashMap<String, Object> responsePayload = client.getResponsePayload();

} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

  • Feedback (send feedback regarding a transaction - raise alert or block the user)

    import io.bayonet.clients.LendingClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.base.Actions;
import io.bayonet.model.lending.LendingFeedbackRequest;

/* Initialize the Lending client with your Api key and Api version */
LendingClient client = new LendingClient("<your api key>", "<api version>");

/* Build the feedback request */
LendingFeedbackRequest params = new LendingFeedbackRequest()
    .setTransactionId("<transaction ID that you used when reporting the transaction or solicitud>")
        .setActions(new Actions().setAlert(true).setBlock(true));

/* Send the feedback request */
try {
    client.feedback(params);

    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"

} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

  • Feedback historical (for reporting historical transactions that were not sent to Bayonet)

    import io.bayonet.clients.LendingClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.base.Actions;
import io.bayonet.model.base.Address;
import io.bayonet.model.lending.LendingFeedbackHistoricalRequest;

/* Initialize the Lending client with your Api key and Api version */
LendingClient client = new LendingClient("<your api key>", "<api version>");

/* Build the feedback historical request */
LendingFeedbackHistoricalRequest params = new LendingFeedbackHistoricalRequest()
    .setEmail("example@bayonet.io")
    .setConsumerName("Example name")
    .setConsumerInternalId("<your internal ID for this consumer>")
    .setTelephoneFixed("1234567890")
    .setTelephoneMobile("1234567891")
    .setTelephoneReference1("1234567892")
    .setTelephoneReference2("1234567893")
    .setTelephoneReference3("1234567894")
    .setRfc("Example RFC")
    .setCurp("Example CURP")
    .setAddress(
            new Address()
                    .setLine1("example line 1")
                    .setLine2("example line 2")
                    .setCity("Mexico City")
                    .setState("CDMX")
                    .setCountry("MEX")
                    .setZipCode("1234")
    )
    .setTransactionCategory("crowdfunding")
    .setTransactionId("<your internal ID for this transaction>")
    .setTransactionTime(1506468823L)
    .setActions(new Actions().setAlert(true).setBlock(true));

/* Send the feedback historical request */
try {
    client.feedbackHistorical(params);

    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"

} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

Device Fingerprint

  • Get-device-data API

    You can use this endpoint to get detailed information about a fingerprint generated by the Bayonet fingerprinting JS installed on your front-end

    import io.bayonet.clients.DeviceFingerprintClient;
import io.bayonet.exceptions.BayonetException;
import io.bayonet.model.device_fingerprint.DeviceFingerprintRequest;

import java.util.HashMap;

/* Initialize the Device Fingerprint client with your Api key and Api version */
DeviceFingerprintClient client = new DeviceFingerprintClient("<your api key>", "<api version>");

/* Build the fingerprint request */
DeviceFingerprintRequest params = new DeviceFingerprintRequest()
        .setBayonetFingerprintToken("<fingerprint-token-generated-by-JS-snippet>");

/* Send the fingerprint request */
try {
    client.queryFingerprintData(params);

    /* process the response */
    System.out.println(client.getHttpResponseCode());                   // 200
    System.out.println(client.getReasonCode());                         // 0
    System.out.println(client.getReasonMessage());                      // "success"

    // get fingerprint information
    String bayonet_fingerprint = client.getBayonetFingerprint();
    HashMap<String, Object> device_information = client.getDeviceInfo();

} catch (BayonetException e) {
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

    Error Handling

    Bayonet's SDK raises exceptions whenever calling an event. Make sure you use a try-catch block to avoid uncaught exceptions in production:

    try {
    client.EVENT(params);
    // process the successful response
} catch (BayonetException e) {
    // do something with the exception
    System.out.println("error occurred");
    System.out.println("Reason code: " + e.getReasonCode());
    System.out.println("Reason message: " + e.getReasonMessage());
}

About

Bayonet Client API (Java)

Topics

bayonet-api anti-fraud bayonet-client bayonet bayonetio bayonet-java-sdk

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

2 watching

Forks

0 forks
Report repository

Releases 13

v2.10.0 Latest
Nov 14, 2022
+ 12 releases

Packages

No packages published

Languages