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パス

absorption_type string

分割払い使用時に誰が利息を負担するかを決定する。customer(カード保有者)またはmerchant(加盟店) (type=installment_*)

amount integer

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

bank string

金融機関 (type=fpx)

barcode string

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

billing object

請求先住所。詳細はソース作成パラメーターを参照してください。

charge_status string

該当する場合)このソースを使用して作られた課金のステータス。 値は次のいずれかになります。charge.status の値、または、課金が作成されていない場合は 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

割引 (type=qr_code_upi)

email string

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

flow string

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

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

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

    ip string

    ソース作成時にOpnに提供されるIPアドレス。IPv4またはIPv6。

    items array

    注文に含まれるアイテムの詳細。詳細はソース作成パラメーターを参照してください。

    mobile_number string

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

    name string

    顧客名 (type=econtext)

    phone_number string

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

    platform_type string

    支払者が支払いを行うプラットフォーム。ブラウザ、iOS、Androidのいずれか

    provider_references object

    決済が正常に処理されたアイテムへの参照を表示します。以下の決済方法が取引参照に表示されます。

    • promptpay
    • paynow
    • mobile_banking_scb
    • mobile_banking_ktb
    • mobile_banking_kbank
    • mobile_banking_bay
    • mobile_banking_bbl

    他の決済プロバイダーの場合、null が返されます。

    receipt_amount integer

    明細書の金額 (type=qr_code_upi)

    references object

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

    scannable_code barcode

    バーコードオブジェクト

    shipping 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, alipay_cn, alipay_hk, alipayplus_mpm, alipayplus_upm, atome, atome_qr, barcode_alipay, bill_payment_tesco_lotus, bkash, boost, dana, duitnow_qr, duitnow_obw, easypaisa, econtext, fpx, gcash, grabpay, installment_bay, installment_bbl, installment_first_choice, installment_kbank, installment_ktc, installment_mbb, installment_scb, installment_ttb, installment_uob, installment_wlb_kbank, installment_wlb_ktc, installment_wlb_ttb, internet_banking_bay, internet_banking_bbl, kakaopay, maybank_qr, mobile_banking_ocbc, mobile_banking_scb, mobile_banking_kbank, mobile_banking_bbl, mobile_banking_bay, mobile_banking_ktb, paynow, paypay, points_citi, promptpay, qr_code_upi, rabbit_linepay, shopeepay, shopeepay_jumpapp, touch_n_go, truemoney, truemoney_jumpapp, truemoney_qr, wechat_pay, wechat_pay_mpm, wechat_pay_upm) ソース決済タイプ

    bank string

    (任意、 場合によって必須) 金融機関 (type=fpx)

    barcode string

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

    billing object

    (任意) (任意) 請求先住所

    • country (string) 2文字のISO3166国名コードで国名指定
    • city (string) 市区郡
    • postal_code (string) 郵便番号
    • state (string) 州
    • street1 (string) 番地 #1
    • street2 (string) (任意) 番地 #2
    email string

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

    installment_term integer

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

    ip string

    (任意) ソース作成時にOpnに提供されるIPアドレス。IPv4またはIPv6。

    items array

    (任意) (任意) 注文に含まれるアイテムの詳細。以下の属性を持つオブジェクトの配列。 Array of objects with the following attributes:

    • amount (integer) (任意、場合によって必須) 最小通貨単位でのアイテムの販売価格 (type=atome)

    • sku (string) (任意場合によって必須) SKU、アイテムの識別単位 (type=atome)

    • name (string) (任意場合によって必須) アイテムの名前 (type=atome)

    • quantity (integer) (任意場合によって必須) アイテムの数量 (type=atome)

    • category (string) (任意) アイテムのカテゴリー

    • brand (string) (任意) アイテムのブランド

    • item_uri (string) (任意) アイテムのURI

    • image_uri (string) (任意) アイテムの画像URI

    mobile_number string

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

    name string

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

    platform_type string

    (任意、 場合によって必須) (任意場合によって必須) 支払者が支払いを行うプラットフォーム。ブラウザ、iOS、Androidのいずれか。

    • ブラウザ(デフォルト): 支払者がウェブサイトから支払いを行う場合

    • iOS: 支払者がiOS端末から支払いを行う場合

    • ANDROID: 支払者がAndroid端末から支払いを行う場合

    以下の決済方法が platform_type に対応しています:

    • alipay_cn

    • alipay_hk

    • dana

    • gcash

    • kakaopay

    • touch_n_go

    shipping object

    (任意) (任意) 配送先住所

    • country (string) 2文字のISO3166国名コードで国名指定

    • city (string) 市区郡

    • postal_code (string) 郵便番号

    • state (string) 州

    • street1 (string) 番地 #1

    • street2 (string) (任意) 番地 #2

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