Source (ソース) API

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

Attributes

Name Type Description
object string

固定値 source

id object_id

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

livemode boolean

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

location string

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

amount integer

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

barcode string

バーコード番号 (type=barcode_alipay)。

created_at datetime

UTC datetime of the creation of the source in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

currency currency

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

email string

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

flow string

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

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

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

    name string

    顧客名 (type=econtext)。

    phone_number string

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

    references references

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

    store_id string

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

    store_name string

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

    terminal_id string

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

    type string

    ソース決済タイプ。 値は次のいずれかになります(アカウントや国によって異なります)。

    • alipay
    • barcode_alipay
    • bill_payment_tesco_lotus
    • econtext
    • installment_bay
    • installment_bbl
    • installment_first_choice
    • installment_kbank
    • installment_ktc
    • internet_banking_bay
    • internet_banking_bbl
    • internet_banking_ktb
    • internet_banking_scb
    • truemoney

    詳細については、installmentspayment methodsを参照してください。

    zero_interest_installments boolean

    Whether merchant absorbs the interest for installment payments (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 currency

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

    type string

    (必須) ソース決済タイプ。 値は次のいずれかになります(アカウントや国によって異なります)。

    • alipay
    • barcode_alipay
    • bill_payment_tesco_lotus
    • econtext
    • installment_bay
    • installment_bbl
    • installment_first_choice
    • installment_kbank
    • installment_ktc
    • internet_banking_bay
    • internet_banking_bbl
    • internet_banking_ktb
    • internet_banking_scb
    • truemoney

    詳細については、installmentspayment methodsを参照してください。

    barcode string

    (任意) バーコード番号 (type=barcode_alipay)。

    email string

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

    installment_term integer

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

    name string

    (任意) 顧客名 (type=econtext)。

    phone_number string

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

    store_id string

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

    store_name string

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

    terminal_id string

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

    Example

    • ソースを作成する

    ソースを取得する

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

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

    Example

    • ソースを取得する