Download OpenAPI specification:Download
Each carrier will send an email to the consumer at the time of OpenID issuance, authorization, etc.
Note that this e-mail will not be sent if the Testing ID and requestMode are set in the sandbox.
The table below lists each carrier/service and the timing of email transmission.
| Carrier/Service | Transmission Timing | ||||||
| At the time of OpenID issuance | At the time of Payment Request (Authorization only) | At the time of authorization cancellation | At the time of Capture | At the time of Capture Cancellation | At the time of On-demand payment (Authorization only) | ||
| d Payment | Total payment | None | ○ | None | None | △ (Partial refund only) |
○ |
| Docomo account payment | None | △ | ○ | None | ○ | None | |
| auPAY (au Easy Payment), auPAY (Online payment) | ○ | None | None | ○ | ○ | None | |
・d payment
| Payment Method | Delivery Timing | Delivery | Contact Contents |
| Total payment | At the time of Single Payment | sp-mode mail |
Notification of usage details *The body of the email will contain the following information. [Detailed Information] ・The site name you registered at the time of merchant registration application ・Item information (name) at the time of uest (Pay) [Usage Charges] ・Payment amount (amount) at the time of est (Pay) [Payment Type] ・Payment Type (Single Payment) at the time of |
| Docomo account payment | At the time of Single Payment | Message R |
Notification of withdrawal details *The body of the email will contain the following information. [Usage Charges] ・Payment amount (amount) at the time of est (Pay) |
| Docomo account payment | At the time of authorization cancellation | Message R |
Notify the purchase cancellation amount *The body of the email will contain the following information. [Cancellation Amount] ・Payment amount (amount) at the time of est (Pay) |
| Total payment | At the time of partial refund | sp-mode mail |
Notification of partial refund details *The body of the email will contain the following information. [Usage Charges (Before Change)] ・Payment Amount before partial refund [Usage Charges (After Change)] ・Payment Amount after partial refund [Scheduled payment month] ・The billing year and month for the changed amount |
| Docomo account payment | At the time of partial refund | Message R |
Notify the refund amount *The body of the email will contain the following information. [Refund Date and Time] ・Date and time when the merchant processed the partial refund [Refund Amount] ・Amount refunded through partial refund and credited to the Docomo account |
| Docomo account payment | At the time of payment cancellation | Message R |
Notify the purchase cancellation amount *The body of the email will contain the following information. [Cancellation Amount] ・Payment amount (amount) at the time of est (Pay) |
| Total payment | At the time of On-demand payment | sp-mode mail | Notification of usage details *The body of the email will contain the following information. [Detailed Information] ・The site name you registered at the time of merchant registration application ・Item information (name) at the time of On-Demand Payment Request (Subscribe) [Payment Type] ・Payment Type (On-Demand Payment) at the time of On-Demand Payment (Charge) |
・auPAY (au Easy Payment), auPAY (Online payment)
| Charge type | Transmission Timing | Contact Contents |
| Single payment, On-demand payment | At the time of OpenID issuance |
ID linkage notification email *The body of the email will contain the following information. [Partner Name] ・[Company Name Abbreviation] specified by the store at the time of payment request for carrier payment. |
| Single payment, On-demand payment | Capture settlement/ authorization & Capture settlement |
Capture Settlement Email *The body of the email will contain the following information. [Partner Name] ・[Company Name Abbreviation] specified by the store at the time of payment request for carrier payment [Service Name] ・The store's [Site name for user display] specified at the time of the payment request for carrier payment [Description] ・Item information (name) at the time of uest (Pay) [Product Type] ・The type of product provided by the merchant will be displayed. [Contact Information] ・The store will send the [Contact Information: telephone number] specified at the time of the payment request for carrier payment [Item Amount] ・Payment amount (amount) at the time of est (Pay) |
| Single payment, On-demand payment | Capture cancellation |
Capture Cancellation Email *The body of the email will contain the following information. [Partner Name] ・ [Company Name Abbreviation] specified by the store at the time of payment request for carrier payment [Service Name] ・The store's [Site name for user display] specified at the time of the payment request for carrier payment [Description] ・Item information (name) at the time of uest (Pay) In the case of Recurring Payment, before the above, specify contents from the Payment Server to the effect of "Billing on ○○ day of every month". [Product Type] ・The type of product provided by the merchant will be displayed. [Contact Information] ・The store will send the [Contact Information: telephone number] specified at the time of the payment request for carrier payment [Item Amount] ・Payment amount (amount) at the time of est (Pay) |
| Single payment, On-demand payment | At the time of partial refund |
Amount change email *The body of the email will contain the following information. [Partner Name] ・[Company Name Abbreviation] specified by the store at the time of payment request for carrier payment [Service Name] ・The store's [Site name for user display] specified at the time of the payment request for carrier payment [Description] ・Item information (name) at the time of uest (Pay) [Contact Information] ・The store will send the [Contact Information: telephone number] specified at the time of the payment request for carrier payment [Changed Amount] ・Refund Amount (amount) at the time of Cancel (Cancel) *Displayed as a negative amount. *If you do not specify an amount when canceling, the remaining balance from the partial refund will be displayed. |
The Item Name corresponding to the Payment-specific Order ID (providerOrderId) is the following name, respectively.
| Carrier | Item name (number of digits) |
| d Payment | Payment number (12 digits) |
| auPAY (au Easy Payment) / auPAY (Online payment) | Slip number (16~19 digits) |
In the page redirection on the Docomo side in the Payment Request, the page display for entering the SP mode password is as follows.
Display example of Smartphone
On this page, the "Payment Details" displays the contents of the merchant's contract.
However, in the case of a blanket contract, the "Item type (commodityType)" specified in the Payment Request determines the contents to be displayed.
Display contents of payment details
| Combination | Displayed contents |
| Digital contents + Single payment | Digital contents (Single payment) |
| Sale of goods/Service + Single payment | Sale of goods (Single payment) |
If the payment request is completed (successful at Docomo side), mail is sent to the consumer from Docomo.
'Payment details', 'Merchant name', 'Detailed information' displayed in the Confirmation page are described even in this mail.
From December 2015, for d Payment, fingerprint and iris biometric authentication is possible on terminals equipped with the biometric authentication function.
(Merchant that concludes the payment aggregator contract will not use it in December 2015. The day of starting this use is currently being considered.)
For biometric authentication function, there is correspondence between pre-installed browser (standard browser and Chrome browser of the terminal ) only at the mobile terminal.
Biometric authentication function is not used in the browser other than this or the browser in the unique merchant application (WebView).
*Precautions when Browser in Unique Merchant Application (WebView) is Used
| Target case | Error code | |
| resultCode | vResultCode | |
| If a partial refund is made immediately after Capture | UA-PRV-001 | WG20 |
| If a partial refund is made again immediately after a partial refund is made | UA-PRV-002 | WG11 |
Example: For a payment amount of 300 yen (100 yen via telephone charges total payment and 200 yen via Docomo account credits), if a 200-yen reduction is issued, 100 yen will be refunded to the telephone charges total payment, and 100 yen will be refunded to the Docomo account. As a result, 100 yen charged to the Docomo account will remain as the amount to be billed.
auPAY (au Easy Payment) offers two types of payment methods: a payment method that uses the au ID authentication infrastructure based on the OpenID protocol, and a payment method that performs authentication and payment within the au PAY application.
The case where au ID authentication platform is used is described below.
When using the au ID authentication infrastructure, two authentication methods are provided: "au ID Login," which uses an au ID for authentication, and "ID Linkage," which uses the unique ID of the merchant's site for authentication. Either of the authentication methods must be used to use auPAY (au Easy Payment).
The "au ID Login" and "ID Linkage" functions can be used by switching the Settings value of the parameter "Login Type (loginType)" during Payment Request and On-Demand Payment Request.
*When it is not set, it is 'ID linkage'.
*Be sure to use "au ID Login" when providing auPAY (au Easy Payment) without performing your own user authentication on the merchant's site (without having the user log in to the merchant's site).
ID linkage
To use partial refund, it is necessary to apply to KDDI. When using the partial refund, please contact the sales representative or technical support.
Even if a partial refund is possible, depending on the Payment Method selected by the Consumer at the time of the Payment Request, resultCode=UA-CST-001 and vResultCode=WG24 may be refunded upon the partial refund request.
Since partial refund can not be done in this transaction, study the refunding with alternate means.
| Error Code in Capture settlement | Failure Notification to Consumers | |
| resultCode | vResultCode | |
| UA-CST-001 | WG39 | Necessary |
| WG40 | ||
| Error codes other than above | Optional | |
UA-CST-001 and ResultCode=WG39, or resultCode=UA-CST-001 and ResultCode=WG40, the Capture Process cannot be performed due to a Consumer error.