Documentation
Start typing to search…

Pay-easy

Pay-easy is a Japanese payment service that lets consumers pay for online purchases, bills, and taxes via bank transfer, ATMs, or convenience stores, offering a secure and convenient option for those without credit cards. Learn more about Pay-easy.

Payment method properties

Markets (consumer)

JP

Processing currencies

JPY

Consumer currencies

JPY

Authentication methods

REDIRECT

Authentication timeout

8 days and 10 minutes

Minimum payment amount

1 JPY

Maximum payment amount

ATM: 100,000 JPY Online banking: 1,000,000 JPY

Payment instrument

PASSTHROUGH_WALLET

Recurring payments

No

Separate captures

No

Refund

Full - Partial - Multiple

Refund validity

365 days

Disputes

No

Settlement risk

No

Make a Pay-easy payment

Pay-easy payments follow our standardized REDIRECT payment flow. However, we recommend including all relevant settings for any authentication methods you support.

To make a Pay-easy payment, you'll need to provide the following data at minimum when calling our payment charges endpoint:

Field

Description

paymentMethod

PAYEASY

amount.value

The amount to be paid in the smallest units of the currency used.

amount.currency

JPY

consumer.name

Full name of the consumer.

consumer.country

The country of residence of the consumer.

consumer.email

Email of the consumer.

consumer.phone

Phone number of the consumer.

authenticationSettings: REDIRECT settings.returnUrl

Specify the URL to which the consumer should be redirected after completing the payment. This is required for the REDIRECT payment flow.

Request

POST /v1/payment-charges

{
  "paymentMethod": "PAYEASY",
  "amount": {
    "value": 1000,
    "currency": "JPY"
  },
  "consumer": {
    "name": "John Smith",
    "country": "JP",
    "email": "[email protected]",
    "phone": "1234567890"
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ]
}

Response

You'll receive our standard payment charge response with the available authentication methods:

{
  "id": "charge_Y3JVzvEaJpvG53xd2R2Zt",
  "paymentMethod": "PAYEASY",
  "paymentMedium": "ECOMMERCE",
  "scheduleType": "UNSCHEDULED",
  "instrumentId": "instr_Asu0ig2PXXZSiNrhY44A5",
  "currency": "JPY",
  "country": "JP",
  "status": "AUTHENTICATION_PENDING",
  "consumer": {
    "name": "John Smith",
    "country": "JP",
    "email": "[email protected]",
    "phone": "1234567890"
  },
  "authenticationMethods": [
    {
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      },
      "type": "REDIRECT"
    }
  ],
  "authorizations": [
    {
      "id": "authz_aPobet0FNZNU1bYqfexFd",
      "amount": 1000,
      "status": "AUTHENTICATION_PENDING",
      "createdAt": "2025-06-21T08:34:20.766Z",
      "updatedAt": "2025-06-21T08:34:20.766Z"
    }
  ],
  "captures": [],
  "refunds": [],
  "discards": [],
  "voids": [],
  "createdAt": "2025-06-21T08:34:20.114Z",
  "updatedAt": "2025-06-21T08:34:20.766Z",
  "_links": {
    "authorizations": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/authorizations"
    },
    "captures": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/captures"
    },
    "refunds": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/refunds"
    },
    "discards": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/discards"
    },
    "voids": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/voids"
    }
  }
}

Pick the desired authentication method

REDIRECT

  1. Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
    For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
  2. The consumer will be presented with the reference number and instructions to complete the payment.

Handling the payment result

REDIRECT

  1. After the consumer completes the payment, they are redirected to the returnUrl specified in the payment charge creation request.
  2. Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned status field to determine and display the final payment outcome to the consumer.
  3. Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.

Payment instrument

An instrument of type PASSTHROUGH_WALLET will be created for Pay-easy payments.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_z5TxnDodzdTWMAeqZM9Vt",
    "type": "PASSTHROUGH_WALLET"
}

Sandbox testing

Updated 6 days ago