How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PayPay

PayPay Payment API

Everything involved in the payment life cycle

Documentation Provider Profile APIs.io OpenAPI GitHub

PayPay Payment API is one of 2 APIs that PayPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 9 operations across 9 paths, and defines 42 schemas. It is described by OpenAPI 3.0.0, at version 1.1.

Requests are made against 6 base URLs: //apigw.paypay.ne.jp, //apigw.stg.paypay.ne.jp, //apigw.sandbox.paypay.ne.jp, //api.paypay.ne.jp, //stg-api.paypay.ne.jp, //stg-api.sandbox.paypay.ne.jp.

9 operations 9 paths 42 schemas 2 DELETE2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.1
Base URL
https://apigw.paypay.ne.jp
Authentication
HTTP Basic
Contact
API Support
Resource Areas
1

Authentication & Security 1

PayPay Payment API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 2 DELETE, 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Payment 9

Everything involved in the payment life cycle

POST
/v2/codes
Create a QRCode
createQRCode body → 201400401500
DELETE
/v2/codes/{codeId}
Delete a Code
deleteQRCode 1 param → 200400401500
GET
/v2/codes/payments/{merchantPaymentId}
Get payment details
getCodePaymentDetails 1 param → 200401404500
DELETE
/v2/payments/{merchantPaymentId}
Cancel a payment
cancelPayment 1 param → 202400500
POST
/v2/payments/reauthorize
Update a payment authorization
reauthorizePayment body → 200201400401404500
POST
/v2/payments/capture
Capture a payment authorization
capturePaymentAuth body → 200202400401404500
POST
/v2/payments/preauthorize/revert
Revert a payment authorization
revertAuth body → 200400404500
POST
/v2/refunds
Refund a payment
refundPayment body → 2004XX5XX
GET
/v2/refunds/{merchantRefundId}?paymentId={paymentId}
Get refund details
getRefundDetails 2 params → 200401404500

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are QRCodeResponse (18 properties), QRCode (13 properties), CapturePaymentOrder (11 properties), PaymentOrderWithoutUserAuthorizationId (10 properties). Each schema is shown below with its type and property counts.

CapturePayment
object
ReauthExpiresAt
integer
Epoch timestamp in seconds. Expiry date of order.
Capture
object
7 properties
MerchantCaptureId
string
Transaction ID provided by merchant to uniquely identify Capture by transaction. Allowed characters: a-z, A-Z, 0-9, -,
CapturePaymentOrder
object
11 properties
ResultInfo
object
3 properties
StoreId
string
Id to identify store under merchant
UserAuthorizationId
string
The PayPay user reference id returned by the user authorization flow
MerchantOrderItemResponse
object
5 properties 3 required
CanceledAt
integer
Epoch timestamp in seconds. Timestamp when status became CANCELED.
RefundedAt
integer
Epoch timestamp in seconds. Timestamp when status became REFUNDED.
RefundState
object
2 properties 2 required
MerchantPaymentIdSimple
string
Transaction ID provided by merchant that uniquely identifies the transaction. Allowed characters: a-z, A-Z, 0-9, -,
QRCode
object
13 properties
MerchantOrderItem
object
5 properties 3 required
RefundOrder
object
5 properties 4 required
MerchantPaymentId
string
Transaction ID provided by merchant that uniquely identifies the transaction. When the same merchantPaymentId is specified, the previous result is returned.
ReauthRequestId
string
Identifier reauth request generated by merchant Allowed characters: a-z, A-Z, 0-9, -,
NotDataResponse
object
2 properties
Refund
object
CaptureComplete
object
6 properties 5 required
CompletedAt
integer
Epoch timestamp in seconds. Timestamp when status became COMPLETED.
ExpiresAt
integer
Epoch timestamp in seconds of the expiry of QR code. If the QR code is expired before a payment is made, merchants can create another QR code using Create a QR…
CapturePaymentStateComplete
object
5 properties
MerchantOrderItem-2
object
5 properties 2 required
PaymentId
string
The payment transaction id provided by PayPay
MerchantRefundIdSimple
string
Transaction ID provided by merchant to uniquely identify a refund of a transaction. Allowed characters: a-z, A-Z, 0-9, -,
QRCodeResponse
object
18 properties
EpochTime
integer
Epoch timestamp in seconds
MoneyAmount
object
2 properties 2 required
Ip
string
The IP address of the user who initiates the payment. It will be used for risk analysis to check for fraudulent transactions. Currently the risk analysis proce…
PaymentState
object
6 properties
AuthorizationExpiry
integer
Epoch timestamp in seconds. The expiry duration must be less than the expiry granted to the merchant. Note: The expiry, in case of authorization with PAYLATERC…
PaymentMethodsForPayment
object
1 property
EmptyData
object
data field will be null
PointsBreakdownRegular
array
breakdown for points (cashback).
MerchantRefundId
string
Transaction ID provided by merchant to uniquely identify a refund of a transaction. For multiple refunds, a unique merchantRefundId must be set for each refund…
ProductTypeForCreateCode
string
The product type in PayPay system. Generally, this request parameter is optional. For some merchants that are restricted to use only certain product types, the…
MerchantRevertId
string
Transaction ID provided by merchant to uniquely identify Revert by transaction. Allowed characters: a-z, A-Z, 0-9, -,
Reason
string
PaymentOrderWithoutUserAuthorizationId
object
10 properties
RefundWithAssumeMerchant
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypay-payment-api-openapi.yml Raw ↑

Other APIs PayPay publishes across the network.

PayPay Payments API
AE Profile APIs.io
#Payment
← Back to P APIs
API Details
ID
paypay:paypay-payment-api
Base URL
https://apigw.paypay.ne.jp
Docs
https://developer.paypay.ne.jp/
Provider
PayPay
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=paypay-payment-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/paypay-payment-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of PayPay Payment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.