On this page:

Attributes

METHOD TYPEE-wallet
PAYMENTS
PAYOUTS
REFUNDS
RECURRING

Introduction

PayPay is a payment method available in Japan that allows users to make purchases using the PayPay mobile app by scanning a QR code. After users select the PayPay payment method on a mobile or desktop browser, they complete the payment using the PayPay mobile app.

Supported Countries

Japan

Supported Currencies

Payment (Deposit) Flow

Follow these steps to perform a payment using Nuvei REST API integration:

1. Generate a `sessionToken`

Press here for details.

2. Send a `/payment` Request

Perform the payment by sending a /payment request with its mandatory parameters including:

userTokenId
amount
currency
paymentOption.alternativePaymentMethod class containing:
- paymentMethod: “apmgw_PayPay“
deviceDetails class containing: ipAddress
billingAddress class containing: firstName, lastName, email, country
userDetails class containing: firstName, lastName, email, country
urlDetails class containing: successUrl, failureUrl, pendingUrl

The urlDetails class should be included in the request to redirect the user to the merchant app.

Each link in the class may have an extra GET parameter, which later can be interpreted by the page as a deep link and used to navigate to this link.

Please refer to the example below.

Example `/payment` Request

{
  "sessionToken":"<sessionToken from /getSessionToken>",
  "merchantId":"<your merchantId>",
  "merchantSiteId":"<your merchantSiteId>",
  "clientRequestId":"<unique request ID in merchant system>",
  "amount":"1000",
  "currency":"JPY",
  "userTokenId":"<unique customer identifier in merchant system>",
  "clientUniqueId":"<unique transaction ID in merchant system>",
  "paymentOption":{
    "alternativePaymentMethod":{
      "paymentMethod":"apmgw_PayPay"
    }
  },
  "deviceDetails":{
    "ipAddress":"<customer's IP address>"
  },
  "billingAddress":{
    "firstName":"John",
    "lastName":"Smith",
    "email":"[email protected]",
    "country":"JP"
  },
  "userDetails":{
    "firstName":"John",
    "lastName":"Smith",
    "email":"[email protected]",
    "country":"JP"
  },
  "urlDetails": {
    "successUrl": "<http://merchantsuccessURL.html?deep_link=parameter>", 
    "failureUrl": "<http://merchantfailureURL.html?deep_link=parameter>", 
    "pendingUrl": "<<http://merchantpendingURL.html?deep_link=parameter>"
  }
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

Example `/payment` Response

{
  "internalRequestId": 1712060408576,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "5416795427517477813",
  "merchantSiteId": "186111",
  "version": "1.0",
  "clientRequestId": "20240402152009",
  "sessionToken": "26cf392d-c0b1-491f-8e23-2633ec6bcc34",
  "orderId": "42308701",
  "paymentOption": {
    "redirectUrl": "https://webapp-apm-globalpay-api-qa.nuvei.com/Home?PaymentToken=CEB62C4D9A11CE4BDC5D62B9A67D67A5.6889276",
    "userPaymentOptionId": "",
    "card": {}
  },
  "transactionStatus": "REDIRECT"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to the URL provided in urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

Example `/payment` DMN with `status`=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=42309141&userid=&merchant_unique_id=&customData=&productId=&first_name=Fname&last_name=Lname&email=test%40mymail.com&currency=JPY&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=Sancho+el+fuerte+15&address2=&country=Japan&state=&city=Madrid&zip=%24%7BzipU%7D&phone1=0987654321&phone2=&phone3=&client_ip=93.146.254.172&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=Smart2Pay-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=186111&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_PayPay&ID=&merchant_id=5416795427517477813&responseTimeStamp=2024-04-02.12%3A48%3A03&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&userPaymentOptionId=&TransactionID=2610000000000016910&externalTransactionId=6889282&APMReferenceID=CED64C4E94DC4EB8B2C27CE243B9C68F&orderTransactionId=23742331&totalAmount=1000.00&dynamicDescriptor=hristo+descriptor&item_name_1=NA&item_number_1=&item_amount_1=1000.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&type=DEPOSIT&clientRequestId=20240402154721&relatedTransactionId=&apmPayerInfo=%7B%22StatusInfo%22%3A%22%7B+StatusCode%3A+%2C+info%3A+%2C+originalAmount%3A+1000.0000%2C+ProcessedAmount%3A+100000%2C+originalCurrency%3A+YEN%2C+ProcessedCurrency%3A+JPY+%7D%22%7D&sessionId=ed9898d4264fb4afbd895ce0fa04&responsechecksum=e0ef65790af66aad491384ed60f3969c03819b8e8ab911a077b1da9d454f5a25&advanceResponseChecksum=3144bdce139c932c6e3eca4d638aead80ccef18ad3e49638d9dd77ff01e159ae',

User Experience

Mobile Browser

The user is redirected to the PayPay app and selects a payment funding source.
Upon completion of payment, the user can return to the service page or view the purchase details.

Desktop Browser

The user is redirected to the PayPay website.
The user scans the QR code using the PayPay app.
The user selects a payment funding source and confirms the payment.
Upon completion of payment, the user can return to the service page or view the purchase details.

Testing

In the sandbox environment, you can simulate an approval or a decline request. To simulate an approval, press the blue button (Pay). To simulate a decline and be redirected to the merchant page, press the red button (Cancel).

PayPay