User Notification (1.0)
User Notification provides a service that allows OPA client to send notification to a user.
In order to receive the user notifications, it is necessary to turn on "Essential Alerts" in the Notification Settings of the PayPay app.
The PayPay Open Payment API requires that you use TLS 1.2 or higher as a security measure. Note that you cannot connect with TLS1.0 and TLS1.1.
To start utilizing our Open Payment API platform, at first the business needs to be onboarded as a PayPay merchant.
This process usually consists of information collection, manual verification, contract confirmation and credentials issuance.
After becoming a merchant on PayPay, the following items would be setup for the client:
- api key and secret
- webhook endpoints
- client IP whitelist
This setup can be managed using our merchant panel/ getting in touch with the sales representative.
Everything related to OPA API Authorization is described here.
PayPay OPA uses HTTP response status codes and OPA error code to indicate the success or
failure of the requests. With these information, you can decide what error handling strategy
to use. In general, PayPay OPA return the following http status codes.
User Push Notification
| Status | Code | Description |
|---|---|---|
| 200 | SUCCESS | Success |
| 400 | INVALID_REQUEST_PARAMS | The infomation provide by the request contains invalid data. E.g. unsupported currency |
| 400 | MISSING_REQUEST_PARAMS | The set parameter is invalid |
| 400 | UNACCEPTABLE_OP | The requested operation is not able to be processed due to the current condition. E.g. the user is suspicious. |
| 401 | UNAUTHORIZED | No valid api key and secret provided |
| 401 | INVALID_USER_AUTHORIZATION_ID | The specified user authorization ID is invalid |
| 401 | EXPIRED_USER_AUTHORIZATION_ID | The user authorization ID expired |
| 401 | OP_OUT_OF_SCOPE | The operation is not permitted |
| 401 | USER_STATE_IS_NOT_ACTIVE | User is not in active state |
| 404 | OPA_CLIENT_NOT_FOUND | OPA Client not found |
| 500 | SERVICE_ERROR | A service error has occurred |
| 500 | INTERNAL_SERVER_ERROR | This code indicates that something went wrong, but we don't know exactly if the transaction has happened or not. It should be treated as unknown payment status |
In principle, all API responses include an X-REQUEST-ID in the response header (with some exceptions).
When contacting PayPay support, please provide this request ID.
Format: Alphanumeric characters and hyphens (maximum 64 characters)
Example:
OPA45F681001AEF4605B2A50939F611F4B8
User Push Notification
send push notification to a user
Request Body schema: application/json
Send Push Notification
| userAuthorizationId required | string (UserAuthorizationId) <= 64 characters The PayPay user reference id returned by the user authorization flow |
| pushText required | string (pushText) content of push notification |
| pushDeepLink | string (pushDeepLink) deep-link of push notification |
Responses
Request samples
- Payload
{- "userAuthorizationId": "string",
- "pushText": "string",
- "pushDeepLink": "string"
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "resultInfo": {
- "code": "string",
- "message": "string",
- "codeId": "string"
}, - "data": { }
}