Creating Order / Installment by Credit Card

Scenario

Installment payment: this function allows customers to authorize their card once. The installment amount will be confirmed by the bank.

Step 1. Merchant：Set the ChoosePayment payment method to Credit.
Step 2. ECPay：accepts order from merchant and check details.

Special Note：

Merchants should apply for the installment periods with ECPay firstly before using this function. The periods that can be used are only those approved after merchants apply with ECPay .
It is not possible to set the parameters for periodic fixed-amount purchases at the same time.
Stage environment: Please use the credit card test number provided by ECPay to simulate payment.

Transaction Flow Chart

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：

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.
Upon receiving the callback from ECPay, please respond a string “1|OK“.
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

CheckMacValue String
Required

Checksum.

Please refer to the Appendix Checksum Mechanism.

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.

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:

Please return N for parameter value if you do not need to return additional payment information.
Please return Y for parameter value if you need to return additional payment information. After payment is completed, ECPay will return the additional payment information via Server Site POST.

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

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

The following parameters are for installment payments.

CreditInstallment String(20)

Credit card installment periods.

installment periods: 3,6,12,18,24
Flexible Installment periods:30N

Special Note：

This cannot be set with the periodic fixed-amount parameter.
If the installment function is used, subsequent installment payments will be confirmed and provided by the bank.
To pay with a credit card in Stage, please use the test credit card number provided by ECPay for payment simulation.
When requesting this parameter, please provide the total amount of all installments. Merchants do not need to calculate the amount of each installment. Indivisible remainders will be collected by the bank in the first installment. For example, a total of $1733 is to be paid in 6 installments. The indivisible remainder will be collected in the first installment: 293,288,288,288,288,288
UniPay does not support the function of installment payment.
UnionPay cards are not supported for Stage.
When you use the Flexible Installment (30N), if the amount is less than the minimum transaction amount of Flexible Installment and there is no other installment method, the transaction will be displayed as a failure.

Screen

Green World