Introduction

Konbini is a payment method available in Japan. It allows users to pay in cash for online products and services. The user chooses the place they want to pay, gets the reference number from the website, and pays it at the store.

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_Konbini“
deviceDetails class containing: ipAddress
billingAddress class containing: firstName, lastName, email, country
userDetails class containing: firstName, lastName, email, country

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_Konbini"
    }
  },
  "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"
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

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`=PENDING

...'ppp_status=PENDING&Status=PENDING&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=375664798&userid=123123123&merchant_unique_id=&customData=&productId=&first_name=John&last_name=Smith&email=test_user_83022133%40testuser.com&currency=JPY&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=340689+main+St.&address2=&country=Japan&state=&city=Brasilia&zip=12345&phone1=9096123456&phone2=&phone3=&client_ip=93.146.254.172&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=Nuvei-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=216668&merchant_status=&action=&requestVersion=&message=PENDING&merchantLocale=&unknownParameters=&payment_method=apmgw_Konbini&ID=&merchant_id=7796900751751000334&responseTimeStamp=2023-07-07.17%3A30%3A34&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=123123123&userPaymentOptionId=92478888&TransactionID=811000000003196800&externalTransactionId=23191923&APMReferenceID=2FDD5D71C44780C9CE8BBDF2A4B1A38F&orderTransactionId=1207805568&totalAmount=501.00&dynamicDescriptor=KC+test&item_name_1=NA&item_number_1=&item_amount_1=501.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&upoRegistrationDate=20230707&type=DEPOSIT&clientRequestId=20230708013009&relatedTransactionId=&sessionId=15ca1cce7b196b35ac38d2a8b3a5&responsechecksum=90ad80cfb00d5c99bf607fcc43b3782b3d6cd25deabeb89c03c66d92583fb81a&advanceResponseChecksum=059c41fcd86797de8b44c72daf7f97ae5edc2e0a7e5bd3734079a48c6c22e668'

User Experience

The user is redirected to a third-party page.
The user enters their name, chooses a participating convenience store, and presses Payment to generate a payment reference number.

The user receives an email with payment instructions.
The user presents the payment reference number to the convenience store for payment.
Once the payment is processed, the status of the transaction reference changes from Pending to Approved.

Testing

Enter a valid email address.

Konbini