Source API

Create and retrieve payment sources. Sources are methods for accepting payments through non-credit-card channels (including Alipay, convenience store, internet banking and installment payments).

Attributes

Name	Type	Description
object	string	The string `source`
id	string	The source identifier matching `/src(_test)?_[0-9a-z]+/`
livemode	boolean	Whether this is a live (`true`) or test (`false`) source
location	string	API path to retrieve the current `source` object
absorption_type	string	The entity that absorbs interest for installment payments. One of the customer or merchant (`type=installment_*)
amount	integer	Source amount in smallest unit of source currency
bank	string	Bank (`type=fpx`)
barcode	string	Barcode number (`type=barcode_alipay`)
billing	object	Billing address. See source creation parameters for more details.
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	string	UTC datetime of source creation in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`)
currency	string	Currency for source as three-letter ISO 4217 code
discounts	array	Discounts (`type=qr_code_upi`)
email	string	Payer email address (`type=econtext,fpx`)
flow	string	The payment flow payers need to go through to complete the payment. One of `redirect`, `offline`, or `app_redirect`: `redirect`: payer must be redirected to external website (`charge.authorize_uri`) to complete payment. `offline`: payer will receive payment information to complete payment offline (`charge.source.references`). `app_redirect`: payer must be redirected to an app (`charge.authorize_uri`) to complete payment.
installment_terms	integer	Installment term in months. See installments for allowed values (`type=installment_*`)
ip	string	IP address provided to Omise at source creation. It may be IPv4 or IPv6.
items	array	Information about items included in the order. An array of objects with the following attributes: amount (integer) (optional, but conditionally required) Selling price of the item in the smallest unit of currency (type=atome) sku (string) (optional, but conditionally required) SKU/product ID of the item (type=atome) name (string) (optional, but conditionally required) Name of the item (type=atome) quantity (integer) (optional, but conditionally required) Quantity of the item (type=atome) category (string) (optional) Category of the item brand (string) (optional) Brand of the item item_uri (string) (optional) URI of the item image_uri (string) (optional) Image URI of the item
mobile_number	string	Payer phone number (`type=econtext,truemoney`)
name	string	Payer name (`type=econtext`)
phone_number	string	Payer phone number (`type=econtext,truemoney`)
platform_type	string	Platform from which payer is making a payment. One of WEB, IOS, or ANDROID.
promotion_code	string	The code that grants access to special offers or discounts provided by the service provider.
provider_references	object	Denotes the transaction references for payments made. The following payment methods return transaction references: `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` This object returns `null` for all other payment providers.
qr_settings	object	A configuration object that customizes the format and appearance of the response QR code (`type=promptpay`) `image_type` (string) The image format for the QR code. Supported formats: jpeg, png, and svg.
receipt_amount	integer	Receipt amount (`type=qr_code_upi`)
references	object	Reference information about the payment (`type=bill_payment_tesco_lotus,econtext,barcode_alipay`)
scannable_code	barcode	Barcode object
shipping	object	Shipping address. See source creation parameters for more details.
store_id	string	Store ID for payment source (`type=barcode_alipay`)
store_name	string	Store name for payment source (`type=barcode_alipay`)
supplier_id	string	TBD
terminal_id	string	Terminal ID for payment source (`type=barcode_alipay`)
type	string	Payment source type

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": []
}