Create charge

決済処理を行います。

POST

/charges

Authorization (Header)string

金額

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

default: true

通貨コード (ISO_4217)

length 3–3 · default: JPY

決済方法 - 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 - ezopay EZO Pay

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

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

length ≤ 50

決済に関する説明

length ≤ 1024

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

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

Client IP アドレス

length ≤ 39

カスタマID

length ≤ 32

カスタマソースID

length ≤ 32

ロケーションID

length ≤ 32

Response Body

`application/json`

Created

TypeScript Definitions

Use the response body type in TypeScript.

id?string

Charge ID

Lengthlength <= 32

appId?string

App ID

Lengthlength <= 32

object?string

対象種類の表記

Default"charge"

liveMode?boolean

本番モードかどうか

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

amount?integer

支払い金額

authorizeAmount?integer

事前承認金額

currency?string

通貨コード (ISO_4217)

Default"JPY"

Length3 <= length <= 3

authorize?boolean

事前承認フラグ

paymentMethod?PaymentMethodType

決済方法

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
ezopay EZO 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" | "ezopay" | "auto"

resource?ResourceType

決済リソース

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など

Lengthlength <= 50

description?string

支払い説明文

Lengthlength <= 1024

location?

ロケーションオブジェクト

extra?

支払いエキストラデータ

Propertiesproperties <= 20

metadata?

支払いメタデータ

Propertiesproperties <= 20

cardInfo?

カード情報やウォレット情報

voucherNo?string

プロバイダー決済伝票番号

Lengthlength <= 32

clientIp?string

Client IP アドレス

Lengthlength <= 45

paid?boolean

支払い済みフラグ

refunded?boolean

返金済みフラグ

disputed?boolean

不審請求フラグ

refunds?

返金のサマリー。複数回返金された場合、返金内容をサマリーして返します。

status?ChargeStatusType

支払い状態

pending 未支払
waiting 支払い待ち(情報入力済)
notified 支払い準備中(通知済)
uncaptured 承認済み(未確定)
captured 支払済み
partially_refunded 一部返金
refunded 返金済み
amount_mismatch 金額相違
revoked キャンセル済み
failed 支払い失敗

Value in

"pending" | "waiting" | "notified" | "uncaptured" | "captured" | "partially_refunded" | "refunded" | "amount_mismatch" | "revoked" | "failed"

codeContent?string

店舗側提示型QRコード(リソースはmpm場合のみ)

credential?string

Client SDKの認証情報

paidTime?integer

支払い時間（エポックミリ秒）

Formatint64

refundTime?integer

返金時間（エポックミリ秒）

Formatint64

expiryTime?integer

支払い請求有効時間（エポックミリ秒）

Formatint64

settleTime?integer

支払い締め時間（エポックミリ秒）

Formatint64

createTime?integer

支払い新規時間（エポックミリ秒）

Formatint64

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

Create charge

Response Body

201application/json

`application/json`