You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-42Lines changed: 42 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -24,14 +24,14 @@ _Note: Support for building the SDK with either Ant or Maven has been made. Plea
24
24
* jmock-2.6.0.jar : unit testing
25
25
26
26
### Migrating from older versions
27
-
Since August 2018, the Authorize.Net API has been reorganized to be more merchant focused. AuthorizeNet AIM, ARB, CIM, Transaction Reporting and SIM classes have all been deprecated in favor of `net\authorize\api`. To see the full list of mapping of new features corresponding to the deprecated features, you can see [MIGRATING.md](MIGRATING.md).
27
+
Since August 2018, the Authorize.Net API has been reorganized to be more merchant focused. Authorize.Net AIM, ARB, CIM, Transaction Reporting, and SIM classes have been deprecated in favor of `net\authorize\api`. To see the full list of mapping of new features corresponding to the deprecated features, see [MIGRATING.md](MIGRATING.md).
28
28
29
29
### Contribution
30
-
- If you need information or clarification about any Authorize.Net features, please create an issue for it. Also you can search in the [Authorize.Net developer community](https://community.developer.authorize.net/).
31
-
- Before creating pull requests, please read [CONTRIBUTING.md](CONTRIBUTING.md)
30
+
- If you need information or clarification about Authorize.Net features, create an issue with your question. You can also search the [Authorize.Net developer community](https://community.developer.authorize.net/) for discussions related to your question.
31
+
- Before creating pull requests, read [the contributors guide](CONTRIBUTING.md).
32
32
33
33
### TLS 1.2
34
-
The Authorize.Net APIs only support connections using the TLS 1.2 security protocol. It's important to make sure you have new enough versions of all required components to support TLS 1.2. Additionally, it's very important to keep these components up to date going forward to mitigate the risk of any security flaws that may be discovered in your system or any libraries it uses.
34
+
The Authorize.Net API only support connections using the TLS 1.2 security protocol. Make sure to upgrade all required components to support TLS 1.2. Keep these components up to date to mitigate the risk of new security flaws.
35
35
36
36
37
37
## Installation
@@ -42,13 +42,13 @@ The Authorize.Net APIs only support connections using the TLS 1.2 security proto
42
42
```
43
43
44
44
## Registration & Configuration
45
-
Use of this SDK and the Authorize.Net APIs requires having an account on our system. You can find these details in the Settings section.
46
-
If you don't currently have a production Authorize.Net account and need a sandbox account for testing, you can easily sign up for one [here](https://developer.authorize.net/sandbox/).
45
+
Use of this SDK and the Authorize.Net APIs requires having an account on the Authorize.Net system. You can find these details in the Settings section.
46
+
If you don't currently have a production Authorize.Net account, [sign up for a sandbox account](https://developer.authorize.net/sandbox/).
47
47
48
48
### Authentication
49
-
To authenticate with the Authorize.Net API you will need to use your account's API Login ID and Transaction Key. If you don't have these values, you can obtain them from our Merchant Interface site. Access the Merchant Interface for production accounts at (https://account.authorize.net/) or sandbox accounts at (https://sandbox.authorize.net).
49
+
To authenticate with the Authorize.Net API, use your account's API Login ID and Transaction Key. If you don't have these credentials, obtain them from the Merchant Interface. For production accounts, the Merchant Interface is located at (https://account.authorize.net/), and for sandbox accounts, at (https://sandbox.authorize.net).
50
50
51
-
Once you have your keys simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request.
51
+
After you have your credentials, load them into the appropriate variables in your code. The below sample code shows how to set the credentials as part of the API request.
52
52
53
53
#### To set your API credentials for an API request:
54
54
```java
@@ -58,82 +58,77 @@ Once you have your keys simply load them into the appropriate variables in your
You should never include your Login ID and Transaction Key directly in a file that's in a publically accessible portion of your website. A better practice would be to define these in a constants file, and then reference those constants in the appropriate place in your code.
61
+
Never include your API Login ID and Transaction Key directly in a file in a publically accessible portion of your website. As a best practice, define the API Login ID and Transaction Key in a constants file, and then reference those constants in your code.
62
62
63
63
### Switching between the sandbox environment and the production environment
64
-
Authorize.Net maintains a complete sandbox environment for testing and development purposes. This sandbox environment is an exact duplicate of our production environment with the transaction authorization and settlement process simulated. By default, this SDK is configured to communicate with the sandbox environment. To switch to the production environment, set the appropriate environment constant using ApiOperationBase `setEnvironment` method. For example:
64
+
Authorize.Net maintains a complete sandbox environment for testing and development purposes. The sandbox environment is an exact duplicate of our production environment, with simulated transaction authorization and settlement. By default, this SDK is configured to use the sandbox environment. To switch to the production environment, set the appropriate environment constant using ApiOperationBase `setEnvironment` method. For example:
API credentials are different for each environment, so be sure to switch to the appropriate credentials when switching environments.
71
71
72
-
73
72
## SDK Usage Examples and Sample Code
74
-
To get started using this SDK, it's highly recommended to download our sample code repository:
73
+
When using this SDK, downloading the Authorize.Net sample code repository is recommended.
75
74
*[Authorize.Net Java Sample Code Repository (on GitHub)](https://github.com/AuthorizeNet/sample-code-java)
76
75
77
-
In that respository, we have comprehensive sample code for all common uses of our API:
76
+
The respository contains comprehensive sample code for common uses of the Authorize.Net API.
78
77
79
-
Additionally, you can find details and examples of how our API is structured in our API Reference Guide:
78
+
The API Reference contains details and examples of the structure and formatting of the Authorize.Net API.
80
79
*[Developer Center API Reference](http://developer.authorize.net/api/reference/index.html)
81
80
82
-
The API Reference Guide provides examples of what information is needed for a particular request and how that information would be formatted. Using those examples, you can easily determine what methods would be necessary to include that information in a request using this SDK.
81
+
Use the examples in the API Reference to determine which methods and information to include in an API request using this SDK.
83
82
84
83
## Create a Chase Pay Transaction
85
84
86
85
Use this method to authorize and capture a payment using a tokenized credit card number issued by Chase Pay. Chase Pay transactions are only available to merchants using the Paymentech processor.
87
86
88
87
The following information is required in the request:
89
-
-The **payment token**,
90
-
-The **expiration date**,
91
-
-The **cryptogram** received from the token provider,
92
-
-The **tokenRequestorName**,
93
-
-The **tokenRequestorId**, and
94
-
-The **tokenRequestorEci**.
88
+
-**payment token**
89
+
-**expiration date**
90
+
-**cryptogram** received from the token provider
91
+
-**tokenRequestorName**
92
+
-**tokenRequestorId**
93
+
-**tokenRequestorEci**
95
94
96
95
When using the SDK to submit Chase Pay transactions, consider the following points:
97
96
-`tokenRequesterName` must be populated with **`”CHASE_PAY”`**
98
97
-`tokenRequestorId` must be populated with the **`Token Requestor ID`** provided by Chase Pay services for each transaction during consumer checkout
99
98
-`tokenRequesterEci` must be populated with the **`ECI Indicator`** provided by Chase Pay services for each transaction during consumer checkout
100
99
101
-
102
100
## Building & Testing the SDK
103
101
Build the SDK with Maven
104
102
------------------------
105
103
106
-
To compile the SDK and create a jar...
104
+
To compile the SDK and create a .jar file:
107
105
108
106
` $ mvn clean package`
109
107
110
108
Build the SDK with Ant
111
109
----------------------
112
110
113
-
To compile the SDK and create a jar...
111
+
To compile the SDK and create a .jar file:
114
112
115
113
` $ ant jar`
116
114
117
-
To run the unit tests...
115
+
To run the unit tests:
118
116
119
117
` $ ant unit-test`
120
118
121
-
122
-
To create the javadocs...
119
+
To create the javadocs:
123
120
124
121
` $ ant javadoc`
125
122
126
123
### Running the SDK Tests
127
-
* Note: To properly run the unit tests, please reference the
128
-
anet-java-sdk.properties file, which is a simple properties file that
129
-
holds the API credentials for testing the SDK.
124
+
* Note: To properly run the unit tests, please reference the anet-java-sdk.properties file, which contains the API credentials for testing the SDK.
130
125
131
126
### Testing Guide
132
127
For additional help in testing your own code, Authorize.Net maintains a [comprehensive testing guide](http://developer.authorize.net/hello_world/testing_guide/) that includes test credit card numbers to use and special triggers to generate certain responses from the sandbox environment.
133
128
134
129
## Logging Sensitive Data
135
130
136
-
The Authorize.Net Java SDK uses Log4J framework for logging purposes and it can be enabled by keeping a configuration file `Log4j.properties` in the resources folder of the application. A sample [Log4.properties](https://github.com/AuthorizeNet/sdk-java/blob/master/resources/log4j.properties) file has been provided as a reference.
131
+
The Authorize.Net Java SDK uses Log4J framework for logging purposes. Enable the logger by keeping a configuration file `Log4j.properties` in the resources folder of the application. A sample [Log4.properties](https://github.com/AuthorizeNet/sdk-java/blob/master/resources/log4j.properties) file has been provided as a reference.
137
132
138
133
The possible log levels are `DEBUG, INFO, WARN, ERROR` and `FATAL`. There is a new pattern layout introduced to mask sensitive data while logging and can be used with the application by providing the following configurations in the `Log4j.properties` file:
By default the logger comes with two appenders i.e **console** and **file transport**.
154
-
155
-
The list of sensitive fields which can be masked during logging are:
156
-
* Card Number,
157
-
* Card Code,
158
-
* Expiration Date,
159
-
* Name on Account,
160
-
* Transaction Key, and
161
-
* Account Number.
148
+
By default the logger comes with two appenders, **console** and **file transport**.
162
149
163
-
There is also a list of regular expressions which the sensitive logger uses to mask credit card numbers while logging. Further information on the sensitive data logging and regular expressions can be found at this [location](https://github.com/AuthorizeNet/sdk-java/blob/master/resources/AuthorizedNetSensitiveTagsConfig.json).
150
+
The sensitive fields that are masked during logging are:
151
+
* Card Number
152
+
* Card Code
153
+
* Expiration Date
154
+
* Transaction Key
155
+
* Account Number
156
+
* Name on Account
157
+
158
+
There is also a list of regular expressions which the sensitive logger uses to mask credit card numbers while logging.
159
+
160
+
More information on the regular espressions used during sensitive data logging [can be found here](https://github.com/AuthorizeNet/sdk-java/blob/master/resources/AuthorizedNetSensitiveTagsConfig.json).
161
+
162
+
### Transaction Hash Upgrade
163
+
Authorize.Net is phasing out the MD5 based `transHash` element in favor of the SHA-512 based `transHashSHA2`. The setting in the Merchant Interface which controlled the MD5 Hash option is no longer available, and the `transHash` element will stop returning values at a later date to be determined. For information on how to use `transHashSHA2`, see the [Transaction Hash Upgrade Guide](https://developer.authorize.net/support/hash_upgrade/).
164
164
165
165
## License
166
-
This repository is distributed under a proprietary license. See the provided [`LICENSE.txt`](/LICENSE.txt) file.
166
+
This repository is distributed under a proprietary license. See the provided [`LICENSE.txt`](/LICENSE.txt) file.
0 commit comments