Create EasyQR code

EasyQRコードを作成します。

Authorization

AuthorizationBearer <token>

API呼出すの認証は、秘密鍵を認証トークンとして扱い、Bearer 認証経由で行われます。秘密鍵は、全ての API リクエスト操作が可能となる重要なキーなので、取扱いにご注意ください。

In: header

Request Body

application/json

EasyQRコードリクエスト

amount*integer

金額

currency?string

通貨コード (ISO_4217)

Default"JPY"

orderNo*string

お客様側のシステムオーダーNo（例：注文番号、決済IDなど）最大桁数は50桁です。

description?string

支払いオブジェクトの「決済に関する説明」

extra?

決済に関する追加情報がある場合に利用します。具体的設定情報は「開発ガイド->決済Extra情報設定」を参照してください。決済オブジェクトを作成する時、こちら設定したextra情報を優先利用します。

metadata?

支払いオブジェクトの「メタデータ」

expiryDuration?integer

EasyQRコード有効期限(分) 最小:3分、最大:30分、デフォルト:10分

frontUrl?string

EasyCheckout決済が完了したあとの、戻り先ページのURL

Matchhttps?://[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]

items?

商品に関する情報

locationId?string

ロケーションID

customerId?string

カスタマID

sourceId?string

カスタマソースID

shouldCreateSource?boolean

このコードで新しいカスタマソースを作成する必要があるかどうか。

Defaultfalse

Response Body

application/json;charset=utf-8

curl -X POST "https://api.elepay.io/codes" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 0,
    "orderNo": "string"
  }'

curl -X POST "https://api.elepay.io/codes" \  -H "Content-Type: application/json" \  -d '{    "amount": 0,    "orderNo": "string"  }'

{
  "id": "string",
  "object": "code",
  "liveMode": true,
  "codeUrl": "string",
  "amount": 0,
  "currency": "JPY",
  "orderNo": "string",
  "description": "string",
  "extra": {
    "property1": "string",
    "property2": "string"
  },
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "status": "pending",
  "charge": {
    "id": "string",
    "appId": "string",
    "object": "charge",
    "liveMode": true,
    "amount": 0,
    "authorizeAmount": 0,
    "currency": "JPY",
    "authorize": true,
    "paymentMethod": "alipay",
    "resource": "web",
    "orderNo": "string",
    "description": "string",
    "extra": {
      "property1": "string",
      "property2": "string"
    },
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "cardInfo": {
      "brand": "string",
      "last4": "string",
      "expMonth": 0,
      "expYear": 0,
      "name": "string",
      "wallet": "string",
      "walletApp": "string",
      "repaymentType": "string",
      "approvalCode": "string",
      "threeDSecure": true,
      "threeDSecureVersion": "string",
      "threeDSecureDetail": "string",
      "businessType": "string",
      "konbiniScanTime": 0,
      "konbiniType": "string",
      "receivedAmount": 0,
      "receivedTime": 0,
      "bankUserCode": "string",
      "bankUserName": "string",
      "bankName": "string",
      "bankBranchName": "string",
      "bankAccountNo": "string"
    },
    "voucherNo": "string",
    "clientIp": "string",
    "paid": true,
    "refunded": true,
    "disputed": true,
    "refunds": {
      "amount": 0,
      "totalCount": 0,
      "data": [
        {
          "id": "string",
          "object": "refund",
          "chargeId": "string",
          "liveMode": true,
          "amount": 0,
          "currency": "string",
          "metadata": {
            "property1": "string",
            "property2": "string"
          },
          "reason": "string",
          "status": "pending",
          "refundedTime": 0,
          "createTime": 0
        }
      ]
    },
    "status": "pending",
    "codeContent": "string",
    "credential": "string",
    "paidTime": 0,
    "refundTime": 0,
    "expiryTime": 0,
    "settleTime": 0,
    "createTime": 0
  },
  "customer": {
    "id": "string",
    "object": "customer",
    "liveMode": true,
    "defaultSource": "string",
    "name": "string",
    "description": "string",
    "email": "string",
    "phone": "string",
    "remark": "string",
    "operator": "string",
    "status": "active",
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "updateTime": 0
  },
  "source": {
    "id": "string",
    "object": "source",
    "liveMode": true,
    "paymentMethod": "alipay",
    "resource": "web",
    "description": "string",
    "extra": {
      "property1": "string",
      "property2": "string"
    },
    "info": {
      "property1": {},
      "property2": {}
    },
    "cardInfo": {
      "brand": "string",
      "last4": "string",
      "expMonth": 0,
      "expYear": 0,
      "name": "string",
      "wallet": "string",
      "walletApp": "string",
      "repaymentType": "string",
      "approvalCode": "string",
      "threeDSecure": true,
      "threeDSecureVersion": "string",
      "threeDSecureDetail": "string",
      "businessType": "string",
      "konbiniScanTime": 0,
      "konbiniType": "string",
      "receivedAmount": 0,
      "receivedTime": 0,
      "bankUserCode": "string",
      "bankUserName": "string",
      "bankName": "string",
      "bankBranchName": "string",
      "bankAccountNo": "string"
    },
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "credential": "string",
    "status": "pending"
  },
  "frontUrl": "string",
  "items": [
    {
      "name": "string",
      "image": "string",
      "price": 0,
      "count": 0
    }
  ],
  "locationId": "string",
  "expired": true,
  "expiryTime": 0,
  "expiryPeriod": 0,
  "createTime": 0,
  "shouldCreateSource": true
}

Create EasyQR code

Authorization

Request Body

Response Body

201application/json;charset=utf-8

application/json;charset=utf-8