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
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,13 +18,15 @@ Java SDK for interacting with PayPay APIs
18
18
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.
19
19
With PayPay's OPA SDK, you can build a custom Payment checkout process to suit your unique business needs and branding guidelines.
20
20
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
+
21
23
## Integrating with PayPay OPA
22
24
23
25
## Prerequisites
24
26
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
28
30
29
31
## HMAC Signature Verification
30
32
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
33
35
34
36
Step 1: Hash the body and content-type with MD5 algorithm
35
37
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".
37
39
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,
38
40
we will recreate the SHA256("key", requestParams) which gives macData. This macData is verified against the value passed in the header.
39
41
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.
41
43
42
44
## Requirements
43
45
Building the API client library requires Gradle to be installed.
0 commit comments