Source (ソース) API

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

Attribute

Name Type Description
object string

固定値 source

id object_id

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

livemode boolean

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

location string

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

absorption_type string

(分割払い使用時のみ)"カード保有者 "または"加盟店 "。誰が利息を負担するかを決定する。

amount integer

指定された通貨において最小単位、かつ正の整数で表される金額。(例:100サターンは1タイバーツ) サポート通過コード一覧

barcode string

バーコード番号。

currency string

小文字3桁の国際識別コードで、ISO 4217規格 によって定義された通貨(サポート通貨コード一覧)。

email string

ソースに関連付けられたメールアドレス。

flow string

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

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

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

    name string

    (日本のみconvenence store, pay-easy, or online banking payments ソース名(例:人名)。

    phone_number string

    (日本のみconvenence store, pay-easy, or online banking payments ソース電話番号。

    references references

    決済に関する参照情報(有効期限など)。

    store_id string

    取引した店舗ID。

    store_name string

    取引した店舗名

    terminal_id string

    取引で使用したターミナル端末ID

    type string

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

    • internet_banking_bay
    • internet_banking_ktb
    • internet_banking_scb
    • internet_banking_bbl
    • alipay
    • barcode_alipay
    • bill_payment_tesco_lotus
    • installment_bay
    • installment_first_choice
    • installment_bbl
    • installment_ktc
    • installment_kbank
    • econtext
    詳細については、installmentspayment methodsを参照してください。

    Example

    • Json Response

    ソースを作成する

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

    新しいソースを作成して返します。 注:この動作は、public and secret key authenticationの両方を受け入れます。

    Charge APIを使用し、ソースを直接作成し課金できます。

    Request Parameter

    Name Type Description
    type string

    必須)ソース決済タイプ。利用可能なタイプについては上記の属性セクションを参照してください。

    amount integer

    必須)使用される通貨の最小単位の金額。 For thb (タイ・バーツ)の場合は、金額をサターンにする必要があります。

    currency string

    (必須) 決済を行う通貨。

    barcode string

    (オプション) バーコード番号

    store_id string

    (オプション) 取引した店舗ID

    store_name string

    (オプション) 取引した店舗名

    terminal_id string

    (オプション) 取引で使用したターミナル端末ID

    installment_terms integer

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

    name string

    (オプション) (日本のみconvenence store, pay-easy, or online banking payments ソース名(例:人名)。

    email string

    (オプション) (日本のみconvenence store, pay-easy, or online bankingpaymentsソースに関連付けられたメールアドレス。

    phone_number string

    (日本のみconvenence store, pay-easy, or online bankingpayments ソース電話番号。

    Example

    • ソースを作成する

    ソースを取得する

    - GET https://api.omise.co/sources/SOURCE_ID

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

    Example

    • ソースを取得する