Create EasyQR code

EasyQRコードを作成します。

POST

/codes

Authorization (Header)string

金額

通貨コード (ISO_4217)

length 3–3 · default: JPY

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

length ≤ 50

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

length ≤ 255

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

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

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

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

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

商品に関する情報

ロケーションID

length ≤ 32

カスタマID

length ≤ 32

カスタマソースID

length ≤ 32

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

default: false

Response Body

`application/json`

Created

TypeScript Definitions

Use the response body type in TypeScript.

id?string

EasyQRコードID

Lengthlength <= 32

object?string

対象種類の表記

Default"code"

liveMode?boolean

本番モードかどうか

false テストモード
true 本番モード

codeUrl?string

EasyQRコードURL

Lengthlength <= 255

amount?integer

支払い金額

currency?string

通貨コード (ISO_4217)

Default"JPY"

Length3 <= length <= 3

orderNo?string

お客様システム側のオーダーNo、例えば注文番号、決済IDなど

Lengthlength <= 50

description?string

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

Lengthlength <= 255

extra?

支払いエキストラデータ

Propertiesproperties <= 20

metadata?

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

Propertiesproperties <= 20

status?CodeStatusType

EasyQrコード状態

pending 未支払
completed 支払い情報の準備が完了
captured 支払済み
closed 有効期限切れ・削除された

Value in"pending" | "completed" | "captured" | "closed"

charge?

支払いオブジェクト

customer?CustomerDto

カスタマオブジェクト

source?SourceDto

カスタマソースオブジェクト

frontUrl?string

items?array<>

locationId?string

ロケーションID

Lengthlength <= 32

expired?boolean

EasyQRコード有効有無

expiryTime?integer

EasyQRコード有効期限（エポックミリ秒）

Formatint64

expiryPeriod?integer

EasyQRコード有効期限までの残りミリ秒数

Formatint64

createTime?integer

コード新規時間（エポックミリ秒）

Formatint64

shouldCreateSource?boolean

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

activeSources?array<>

有効なカスタマソースリスト

invoice?InvoiceDto

インボイスオブジェクト

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": {},
  "metadata": {},
  "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",
    "location": {
      "id": "string",
      "name": {
        "kanji": "string",
        "kana": "string",
        "romaji": "string"
      },
      "tel": "string",
      "zip": "string",
      "address": {
        "kanji": {
          "pref": "string",
          "city": "string",
          "town": "string",
          "address1": "string",
          "address2": "string"
        },
        "kana": {
          "pref": "string",
          "city": "string",
          "town": "string",
          "address1": "string",
          "address2": "string"
        },
        "romaji": {
          "pref": "string",
          "city": "string",
          "town": "string",
          "address1": "string",
          "address2": "string"
        }
      },
      "latitude": 0.1,
      "longitude": 0.1,
      "note": "string",
      "status": "active"
    },
    "extra": {},
    "metadata": {},
    "cardInfo": {
      "brand": "string",
      "last4": "string",
      "expMonth": 0,
      "expYear": 0,
      "name": "string",
      "issuerCode": "string",
      "issuerName": "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",
      "billingNo": "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": "str",
          "metadata": {},
          "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": {},
    "updateTime": 0
  },
  "source": {
    "id": "string",
    "object": "source",
    "liveMode": true,
    "paymentMethod": "alipay",
    "resource": "web",
    "description": "string",
    "extra": {},
    "info": {},
    "cardInfo": {
      "brand": "string",
      "last4": "string",
      "expMonth": 0,
      "expYear": 0,
      "name": "string",
      "issuerCode": "string",
      "issuerName": "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",
      "billingNo": "string"
    },
    "metadata": {},
    "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,
  "activeSources": [
    {
      "id": "string",
      "object": "source",
      "liveMode": true,
      "paymentMethod": "alipay",
      "resource": "web",
      "description": "string",
      "extra": {},
      "info": {},
      "cardInfo": {
        "brand": "string",
        "last4": "string",
        "expMonth": 0,
        "expYear": 0,
        "name": "string",
        "issuerCode": "string",
        "issuerName": "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",
        "billingNo": "string"
      },
      "metadata": {},
      "credential": "string",
      "status": "pending"
    }
  ],
  "invoice": {
    "id": "string",
    "object": "invoice",
    "liveMode": true,
    "customer": {
      "id": "string",
      "object": "customer",
      "liveMode": true,
      "defaultSource": "string",
      "name": "string",
      "description": "string",
      "email": "string",
      "phone": "string",
      "remark": "string",
      "operator": "string",
      "status": "active",
      "metadata": {},
      "updateTime": 0
    },
    "invoiceNo": "string",
    "name": "string",
    "memo": "string",
    "amount": 0,
    "currency": "JPY",
    "status": "draft",
    "operator": "string",
    "invoiceTime": 0,
    "sendTime": 0,
    "paidTime": 0,
    "expiryTime": 0,
    "createTime": 0,
    "fields": [
      "string"
    ],
    "items": [
      {
        "id": "string",
        "object": "invoiceItem",
        "name": "string",
        "unitPrice": 0,
        "currency": "JPY",
        "quantity": 0,
        "unit": "string",
        "taxRateType": "standard",
        "transactionTime": 0
      }
    ],
    "remark": "string",
    "metadata": {},
    "enableAutoCharge": true
  }
}

Create EasyQR code

Response Body

201application/json

`application/json`