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	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_terms	integer	月単位の分割払い期間。許容値については installments(`type=installment_*`)をご覧ください
ip	string	ソース作成時にOmiseに提供される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のいずれか
promotion_code	string	TBD
provider_references	object	決済が正常に処理されたアイテムへの参照を表示します。以下の決済方法が取引参照に表示されます。 `duitnow_obw` `duitnow_qr` `fpx` `grabpay` `maybank_qr` `mobile_banking_bay` `mobile_banking_bbl` `mobile_banking_kbank` `mobile_banking_ktb` `mobile_banking_ocbc` `mobile_banking_scb` `paynow` `promptpay` `shopeepay` `shopeepay_jumpapp` `truemoney_jumpapp` `truemoney_qr` `touch_n_go` 他の決済プロバイダーの場合、`null` が返されます。
qr_settings	object	応答QRコードのフォーマットと見た目をカスタマイズする設定オブジェクト（type=promptpay) `image_type` (string) QRコードの画像フォーマット。サポート形式： jpeg、png、svg
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`)
supplier_id	string	TBD
terminal_id	string	取引で使用したターミナル端末ID (`type=barcode_alipay`)
type	string	ソース決済タイプ

Example

JSON Response

{
  "object": "source",
  "id": "src_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "location": "/sources/src_test_no1t4tnemucod0e51mo",
  "amount": 12345,
  "bank": null,
  "barcode": "1234567890",
  "created": "2019-12-31T12:59:59Z",
  "currency": "thb",
  "email": null,
  "flow": "offline",
  "installment_terms": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "billing": null,
  "shipping": null,
  "items": [],
  "references": null,
  "store_id": "store_1",
  "store_name": "store 1",
  "terminal_id": "POS-01",
  "type": "barcode_alipay",
  "absorption_type": null,
  "charge_status": "unknown",
  "receipt_amount": null,
  "discounts": []
}