Source (ソース) API

Source(ソース)APIを使用すると、決済ソースを作成および取得することができます。 ソースとは、Charge APIを使用して、クレジットカード以外のチャネル (Alipay、コンビニエンスストア決済、internet banking(ネットバンク、installment payments(分割払い)を含む)を通して決済を受け入れる方法です。 新しいソースは、公開鍵(パブリックキー)のみを使用し作成できます。

Attributes

Name Type Description
object string

固定値 source

id string

/src(_test)?_[0-9a-z]+/と一致するSOURCE_ID

livemode boolean

本番モード (true) あるいはテストモード(false) ソース

location string

現在のsourceオブジェクトを取得するためのAPIパス

amount integer

smallest currency unit(最小通貨単位)で表したソースの金額

bank string

Bank (type=fpx)

barcode string

バーコード番号 (type=barcode_alipay,barcode_wechat)

charge_status string

Status of charge created using this source (if any). Value is one of allowed charge.status values or, no charge has been created, unknown

created_at string

ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)でのソース作成のUTC日時

currency string

3文字で表示されるソース通貨[ISO 4217](http://ja.wikipedia.org/wiki/ISO_4217)コード

discounts array

Discounts

email string

ソースに紐づけられたメールアドレス。 (type=econtext,fpx)

flow string

顧客が決済を完了するために使用する決済フロー。 値は次のいずれかになります。:redirect:決済を完了させるため、顧客が外部Webサイトにauthorize_uriでリダイレクトする必要があります。例:ネットバンキング。 </ li>

  • offline:顧客は、オフラインで決済するために決済情報を受け取ります。 例:百貨店での請求書決済。
  • installment_term integer

    (分割払い使用時のみ) オプションについてはinstallmentsを参照してください

    mobile_number string

    顧客の電話番号(type=econtext,truemoney)

    name string

    顧客名 (type=econtext)

    phone_number string

    顧客の電話番号(type=econtext,truemoney)

    receipt_amount integer

    Receipt amount

    references object

    支払いに関する参照情報(type=bill_payment_tesco_lotus,econtext,barcode_alipay)

    scannable_code barcode

    Barcode object

    store_id string

    取引した店舗ID (type=barcode_alipay)

    store_name string

    取引した店舗名 (type=barcode_alipay)

    terminal_id string

    取引で使用したターミナル端末ID (type=barcode_alipay)

    type string

    ソース決済タイプ

    zero_interest_installments boolean

    加盟店が分割払いの支払いに関する利子を負担するかどうか(type=installment_*)

    Example

    • JSON Response

    ソースを作成する

    - POST https://api.omise.co/sources

    新しいソースを作成して返します。 注:この動作は、public and secret key authenticationの両方を受け入れます。 Charge APIを使用し、ソースを直接作成し課金できます。

    Request Parameters

    Name Type Description
    amount integer

    (必須) smallest currency unit(最小通貨単位)で表したソースの金額

    currency string

    (必須) 3文字で表示されるソース通貨[ISO 4217](http://ja.wikipedia.org/wiki/ISO_4217)コード

    type string

    (必須, one of: alipay, barcode_alipay, barcode_wechat, bill_payment_tesco_lotus, econtext, fpx, installment_bay, installment_bbl, installment_citi, installment_ezypay, installment_first_choice, installment_kbank, installment_ktc, installment_scb, internet_banking_bay, internet_banking_bbl, internet_banking_ktb, internet_banking_scb, mobile_banking_scb, paynow, points_citi, promptpay, qr_code_upi, rabbit_linepay, truemoney) ソース決済タイプ

    bank string

    (任意、 場合によって必須) Bank (type=fpx)

    barcode string

    (任意、 場合によって必須) バーコード番号 (type=barcode_alipay,barcode_wechat)

    email string

    (任意、 場合によって必須) ソースに紐づけられたメールアドレス。 (type=econtext,fpx)

    installment_term integer

    (任意、 場合によって必須) (分割払い使用時のみ) オプションについてはinstallmentsを参照してください

    mobile_number string

    (任意、 場合によって必須) 顧客の電話番号(type=econtext,truemoney)

    name string

    (任意、 場合によって必須) 顧客名 (type=econtext)

    store_id string

    (任意、 場合によって必須) 取引した店舗ID (type=barcode_alipay)

    store_name string

    (任意、 場合によって必須) 取引した店舗名 (type=barcode_alipay)

    terminal_id string

    (任意、 場合によって必須) 取引で使用したターミナル端末ID (type=barcode_alipay)

    zero_interest_installments boolean

    (任意, one of: true, false) 加盟店が分割払いの支払いに関する利子を負担するかどうか(type=installment_*)

    Example

    • ソースを作成する

    ソースを取得する

    - GET https://api.omise.co/sources/{id}

    すでに作成されているソースを取得します。

    Example

    • ソースを取得する

    Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら