Create charge

決済処理を行います。

Authorization

AuthorizationBearer <token>

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

In: header

Request Body

application/json

支払リクエスト

amount*integer

金額

capture?boolean

支払い処理を確定するかどうか falseの場合、承認と支払い額の確保のみ行う。デフォルトはtrue

Defaulttrue

currency?string

通貨コード (ISO_4217)

Default"JPY"

paymentMethod*string

決済方法

auto 自動識別(CPM決済のみ利用可能)
alipay アリペイ
alipayhk アリペイHK
alipayplus Alipay+
amazonpay Amazon Pay
applepay Apple Pay
applepay_cn Apple Pay(中国)
atokara アトカラ
atone atone(コンビニで翌月払い)
aupay au Pay
clicktopay Click To Pay
banktransfer 銀行振込
creditcard クレジットカード
dana DANA
docomopay d払い
ezlink EZ-Link
felica 電子マネー
felica_id iD
felica_quickpay QUICPay
felica_transport_ic 交通系ICカード
gcash GCash
ginkopay 銀行Pay
googlepay Google Pay
jcoinpay J-Coin Pay
jkopay JKOPAY
kakaopay Kakao Pay
konbini コンビニ決済
linepay LINE Pay
merpay メルペイ
origamipay Origami Pay
paidy Paidy 翌月払い
paypal PayPal
paypay PayPay
pxpayplus 全支付
rakutenpay 楽天ペイ
smartcode スマートコード
tng Touch 'n Go eWallet
truemoney TrueMoney
unionpay 雲閃付
wechatpay Wechat Pay
aeonpay AEON Pay
rabbitlinepay Rabbit LINE Pay
bpi BPI
boost Boost
hellomoney HelloMoney by AUB
tosspay Toss Pay
naverpay Naver Pay
wellwa WellWa Points
grabpay Grab Pay
momopay Momo Pay
promptpay Prompt Pay
wovenpay Woven City Pay

Value in

"alipay" | "alipayhk" | "alipayplus" | "amazonpay" | "applepay" | "applepay_cn" | "atokara" | "atone" | "aupay" | "clicktopay" | "banktransfer" | "creditcard" | "dana" | "docomopay" | "ezlink" | "felica" | "felica_id" | "felica_quickpay" | "felica_transport_ic" | "gcash" | "ginkopay" | "googlepay" | "jcoinpay" | "jkopay" | "kakaopay" | "konbini" | "linepay" | "merpay" | "origamipay" | "paidy" | "paypal" | "paypay" | "pxpayplus" | "rakutenpay" | "smartcode" | "tng" | "truemoney" | "unionpay" | "wechatpay" | "aeonpay" | "rabbitlinepay" | "bpi" | "boost" | "hellomoney" | "tosspay" | "naverpay" | "wellwa" | "grabpay" | "momopay" | "promptpay" | "wovenpay" | "auto"

resource?string

決済リソース

web WEBブラウザ
ios iOS Nativeアプリ
android Android Nativeアプリ
liff Line LIFFアプリ
mini WeChatミニプログラム
cpm CPM決済、利用者提示型QRコード
mpm MPM決済、店舗側提示型QRコード
reader カードリーダー決済(リーダー設備が必要)
posapp POSアプリ決済(POSアプリが連携必要)

orderNo*string

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

description?string

決済に関する説明

extra?

決済に関する追加情報がある場合に利用します。具体的設定情報は「開発ガイド->決済Extra情報設定」を参照してください。

metadata?

メタデータキーバリューの任意データ。キーは20個まで、バリューは255バイト以内の文字列。「route」、「__」で始まる文字列は予約キー。

clientIp?string

Client IP アドレス

customerId?string

カスタマID

sourceId?string

カスタマソースID

locationId?string

ロケーションID

Response Body

application/json;charset=utf-8

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

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

{
  "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
}

Create charge

Authorization

Request Body

Response Body

201application/json;charset=utf-8

application/json;charset=utf-8