決済

クレジットカード決済を利用するためには、まずchargeオブジェクトを作成します。chargeオブジェクトは一意のユニークなIDを持ち、このIDにて特定の決済情報の取得、確定、払い戻し処理をすることができます。

chargeオブジェクト
項目属性
id: string
object: string(初期値 "charge")
livemode: boolean
amount: 1円以上9,999,999円以下の数値
決済金額
captured: boolean
決済の確定状態を示します。新規決済作成時にcaptureにfalseをセットした場合はfalseが返却されます。同時確定の場合や別途確定処理をした場合にはtrueが返却されます。
card: hash(cardオブジェクト)
決済時に利用したカード情報を格納したhashです。
created: timestamp
currency: 通貨コード
一律"jpy"です。
paid: boolean
refunded: boolean
払い戻しフラグ。全額返金がされた場合にtrueになります。部分返金の場合はfalseのままです。
refunds: hash
返金のリスト。
object: string
amount: integer
返金額
created: timestamp
currency: 通貨コード
一律"jpy"です。
amount_refunded: 整数またはゼロ
返金済み金額。部分返金時は決済額以下のみが指定可能な払い戻しフラグです。
description: string
備考情報
failure_code: string
決済がエラーとなった際の理由を示すコードです。詳細はエラー処理を参照してください。
failure_message: string
決済がエラーとなった際の詳細メッセージです。
サンプルオブジェクト
{
    "id": "ch_103ULD2eZvKYlo2CgXFDfQLV"
    "object": "charge"
    "created": 1392286547
    "livemode": false
    "amount": 500
    "currency": "jpy"
    "refunded": false
    "card": {
        "id": "card_103ULD2eZvKYlo2C7TSOz3c1"
        "object": "card"
        "last4": "4242"
        "type": "Visa"
        "exp_month": 1
        "exp_year": 2050
    }
    "captured": true
    "refunds": [ ]
    "failure_message": null
    "failure_code": null
    "amount_refunded": 0
    "description": null
}