All-In-One API Document

Creating Order / All Payment

Scenario

An order is transmitted once customers make a purchase.

  • Step 1. Merchant: Transmit order details to ECPay via POST (HTTP Method), and proceed to checkout.
  • Step 2. ECPay: accepts order from merchant and check details.

❗ Special Note：

  • Using an in-app iframe (embedded iframe) may cause the transaction to fail, so iframe is not recommended.
  • If it is expected to create an order on iOS, please do not open any link in a new window or new tab (otherwise there will be an error message on the device). For more details please see FAQ.
  • If your membership type is ECTicket member, the payment methods available to you can be confirm in the ECPay’s merchant’s dashboard > Contracts & Rates > Payment.

API URLS

  • Stage：https://payment-stage.ecpay.com.tw/Cashier/AioCheckOut/V5
  • Production：https://payment.ecpay.com.tw/Cashier/AioCheckOut/V5

HTTPS Transfer Protocol

  • Content Type ：application/x-www-form-urlencoded
  • HTTP Method ：POST

Request Parameters Description (Common Parameters)

MerchantID String(10)
Required

Merchant ID (provided by Green World).

MerchantTradeNo String(20)
Required

Transaction ID (provided by the merchant).
  • Merchant Transaction IDs are unique and can not be reused.
  • The value of this parameter is a combination of upper and lower case alphanumeric characters.
❗ Special Note：Please refer to the FAQ on how to avoid duplication of order numbers.

MerchantTradeDate String(20)
Required

Transaction time.

  • Format:yyyy/MM/dd HH:mm:ss

PaymentType String(20)
Required

Transaction type.

  • Please fill in aio

TotalAmount Int
Required

Transaction amount.
  • Only integer is allowed; decimal is not accepted.
  • The currency should be New Taiwan Dollars only.

TradeDesc String(200)
Required

Transaction description.

  • Do not use special characters.

ItemName String(400)
Required

Merchandise name.
  • 1. If this field will include more than 1 product and on the webpage each product is expected to be displayed line by line, each product’s name should be separated by hash (#).
  • 2. Maximum length: 400 characters(Chinese and English). ECPay will automatically cut the length exceeding this maximum. Please refer to the FAQ.

ReturnURL String(200)
Required

A return URL for payment notification.

  • When the consumer completes payment, ECPay will respond payment completed notification (callback) to this parameter (using server Site POST). For more detail about the data of the callback please see Payment result notification (callback).

❗ Special note：

  1. This is a server-side URL. Please do not set this URL the same as [OrderResultURL], which is the URL of the client-side, in order to avoid errors.
  2. Upon receiving the callback from ECPay, please respond a string “1|OK“.
  3. The string “1|OK” is merely a response, which is to tell ECPay’s server that this callback is successfully received by merchant’s server. This response “1|OK” will not change the payment status.

ChoosePayment String(20)
Required

Choose default payment method.
ECPay provides the following payment methods which are transmitted at the time the order is created:

  • Credit: Credit card
  • TWQR：OPAY TWQR
  • WebATM: WebATM
  • ATM: ATM
  • CVS: Convenience reference numbers
  • BARCODE: Convenience store barcodes
  • ApplePay : Apple Mobile Pay
  • ALL: No designated payment method. ECPay will display the webpage to select payment method.

❗ Special Note：

  1. The following payment methods are not supported for mobile devices:
    WebATM: WebATM
  2. Apple Pay is not displayed when the browser is not Safari.

CheckMacValue String
Required

Checksum.

EncryptType Int
Required

CheckMacValue encryption type.
Possible value:

  • 1:SHA256 encryption.
StoreID String(10)

Merchant store ID.

  • Allows merchants to enter specific store ID.
  • This parameter only allows a combination of upper and lower case alphanumeric characters.
ClientBackURL String(200)

Button to return to merchant on client’s end.

  • The page will be directed to the URL when the customer clicks on this button

❗ Special Note：

  • The URL only redirects the page to the URL set on client’s end without payment result.
  • If this parameter is set, ECPay will display the “Back to store” button on the payment complete page or the ATM virtual number retrieval page.
  • If this parameter is set, the page will display the “Back to store” button when OTP authentication fails.
  • If this parameter is not set, then ECPay will not display the “Back to store” button on the payment complete page or the ATM virtual number retrieval page.
  • Some browsers may display a warning if the return URL is not an https address.

ItemURL String(200)

Merchandise URL.
Remark String(100)
Additional notes.
ChooseSubPayment String(20)

Payment subitem.

  • If this parameter is set, the page will be directed to ECPay’s order creation page with the designated payment method and payment sub-method. Other payment sub-methods cannot be selected.
  • Please refer to the payment methods list.

❗ Special Note：

  • Panhsin Bank performs routine monthly maintenance.In the event of bank maintenance, orders will be created and failed.
OrderResultURL String(200)

The client end returns the payment result URL.

  • If merchants set a URL in this parameter, when a payment is completed, ECPay will return the payment result to the URL set using client site post.

❗ Special Note：

  • If this parameter is set with [ClientBackURL], ECPay will accept this parameter but ignore [ClientBackURL].
  • This parameter does not support UnionPay cards or non-real-time transactions (ATM, CVS, BARCODE).
  • OrderResultURL can easily be affected by user mishandling or temporary network issues, resulting in not receiving log.It is recommended to rely on the return log from the ReturnURL.
NeedExtraPaidInfo String(1)

Do you require additional payment information
Additional payment information:

❗ Special Note：Please refer to the additional returns parameter page for information on returning additional payment information parameters.

IgnorePayment String(100)
Hide payment method. When the payment method [ChoosePayment] is ALL, you can hide other unwanted payment methods. For multiple entries, please separate them using a hash (#). Available parameter values:
  • Credit: Credit cards
  • WebATM: WebATM
  • ATM: ATM
  • CVS: Convenience store codes
  • BARCODE: Convenience store barcodes
  • ApplePay : Apple Mobile Pay
PlatformID String(10)

Platform merchant ID (Provided by Green World).

  • Used by contracted platform merchants.
  • For general merchants or platform merchant interfacing, please leave empty.
  • For use by platform merchants, please set [MerchantID] as the parameter.
CustomField1 String(50)
Merchant notes field
❗ Special Note：Special symbols only supports ,.#()$[];%{}:/?&@<>!
CustomField2 String(50)
Merchant notes field
❗ Special Note：Special symbols only supports ,.#()$[];%{}:/?&@<>!
CustomField3 String(50)
Merchant notes field
❗ Special Note：Special symbols only supports ,.#()$[];%{}:/?&@<>!
CustomField4 String(50)
Merchant notes field
❗ Special Note：Special symbols only supports ,.#()$[];%{}:/?&@<>!
Language String(3)
Language settings. The default language is Chinese. To change the language, please set the following value:
  • English: ENG
  • Korean: KOR
  • Japanese: JPN
  • Simplified Chinese: CHI

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

Green World