Skip to content

Commit 75a05fd

Browse files
committed
update README: add note and improve
1 parent 5b6538b commit 75a05fd

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ Java SDK for interacting with PayPay APIs
1818
This is the quickest way to integrate PayPay payment services. This is primarily meant for merchants who wish to perform interactions with PayPay API programmatically.
1919
With PayPay's OPA SDK, you can build a custom Payment checkout process to suit your unique business needs and branding guidelines.
2020

21+
> **Note:** This SDK is provided to assist merchants in integrating with our APIs. While it remains available for use, ongoing maintenance is limited and updates may not be released regularly. Most new features and enhancements are introduced directly at the API level, and we recommend referring to the latest API documentation for the most up-to-date capabilities.
22+
2123
## Integrating with PayPay OPA
2224

2325
## Prerequisites
2426
Before integrating with the SDK, run through this checklist:
25-
- [*] Understand the payment flow
26-
- [*] Sign up for a PayPay developer/merchant Account
27-
- [*] Generate the API keys from the Developer Panel. Use the sandbox API Keys to test out the integration
27+
- [x] Understand the payment flow
28+
- [x] Sign up for a PayPay developer/merchant Account
29+
- [x] Generate the API keys from the Developer Panel. Use the sandbox API Keys to test out the integration
2830

2931
## HMAC Signature Verification
3032
Signature verification is a mandatory step to ensure that the callback is sent by PayPay and the payment is received from an authentic source.
@@ -33,11 +35,11 @@ The PayPay signature, returned to you by the Checkout form on successful payment
3335

3436
Step 1: Hash the body and content-type with MD5 algorithm
3537

36-
Note : If there is no request body, for instance, the HTTP GET method case, no need of generating MD5. Instead, hash value is set as "empty".
38+
Note: If there is no request body, for instance, the HTTP GET method case, no need of generating MD5. Instead, hash value is set as "empty".
3739
The value of authHeader is passed in HttpHeader.AUTHORIZATION. With the authHeader will decode back the data added and with the HTTP request object and based on data available for api-key in the system,
3840
we will recreate the SHA256("key", requestParams) which gives macData. This macData is verified against the value passed in the header.
3941

40-
Note: HMAC authorization will be done internally by the SDK, so client don't need to worry about it.
42+
Note: HMAC authorization will be done internally by the SDK, so clients don't need to worry about it.
4143

4244
## Requirements
4345
Building the API client library requires Gradle to be installed.

0 commit comments

Comments
 (0)