| Table of Contents |
|---|
About KoreaCC
General information about credit card payments with KoreaCC
| Page properties | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Multiexcerpt | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Process flow chart
| Multiexcerpt | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Process flow of a credit card payment with KoreaCC
| Multiexcerpt include | ||||||
|---|---|---|---|---|---|---|
|
interface
| Multiexcerpt include | ||||||
|---|---|---|---|---|---|---|
|
Calling the interface
Following credit card brands are supported: „Samsung“, „Kookmin“, „KEB“, „Hyunday“, „Shinhan“, „BC“, „Lotte“, „VISA“, „MasterCard“, „JCB“, „AMEX“.
Only the currency KRW is supported. This currency is forwarded as WON and no conversion is done. WON is not a ISO 4217 currency and therefore not supported by Computop Paygate
. However WON is displayed in the Paygate Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Name PageWithExcerpt Wording
.Net form because Paygate Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
.Net does not support KRW. Note that KRW has no decimal places according to ISO 4217. Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
Credit card data (and/or other authorisation data such as mobile no. etc.) is entered into the Paygate
.Net form. Sensitive data is not transferred to Computop. Computop Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
. Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Partner-Name PageWithExcerpt Wording
retains no credit card numbers or PCNR.Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Partner-Name PageWithExcerpt Wording
The reference numbers entered (RefNr or TransId) are not printed onto the customer’s bill.
In order to make a credit card payment with KoreaCC via Paygate form, go to a
form, please use the following URL:Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter
Format
CND
Description
MerchantID
ans..30
M
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
TransID
ans..64
M
TransactionID which should be unique for each payment
RefNr
ns..30
O
Unique reference number
Amount
n..10
M
Amount in the smallest currency unit (e.g. EUR Cent)
Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currency
a3
M
Currency, three digits DIN / ISO 4217. Only KRW permitted.
URLSuccess
ans..256
M
Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.
URLFailure
ans..256
M
Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.
Response
a7
O
Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.
URLNotify
ans..256
M
Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
OrderDesc
a..100
O
Shopping basket information
UserData
ans..256
O
If specified at request, Paygate forwards the parameter with the payment result to the shop
Capture
ans..6
O
Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).
ReqID
ans..32
O
To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.
Language
a2
M
Language of the form. There are supported only KR and US.
BuyerName
ans..50
O
Name of the buyer for the email notification
BuyerMail
ans..128
O
Email address of the buyer for the email notification
Plain
ans..50
O
A value to be set by the merchant to return some information unencrypted, e.g. the MID
Custom
ans..1024
O
The merchant can submit several values separated by | which are returned unencrypted and separated by &.
Custom=session=123|id=456 will change in the answer to Session=123&id=456
Parameters for credit card payments via KoreaCC
The following table describes the result parameters that the Paygate transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:
Parameter
Format
CND
Description
MID
ans..30
M
MerchantID, assigned by Computop
PayID
an32
M
ID assigned by Paygate for the payment, e.g. for referencing in batch files
XID
an32
M
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
TransID
ans..64
M
Merchant’s transaction number
Status
a..50
M
AUTHORIZE_REQUEST (URLSuccess) and FAILED (URLFailure)
Description
ans..1024
M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Code
n8
M
Error code according to Paygate Response Codes (A4 Error codes)
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
UserData
ans..1024
O
If specified at request, Paygate forwards the parameter with the payment result to the shop
RefNr
ns..30
O
Unique reference number
CodeExt
ans4
M
Error code from downstream system re payment result.
ErrorText
ans..256
M
Detailed information about payment result. The value can include Korean characters.
TransactionID
ans..30
M
Unique transaction number generated by external system for each payment
Type
ans..20
M
Gives payment method, for credit card: SSL
CCBrand
a..10
O
Name of card brand, e.g. Samsung, KOOKMIN, KEB, BC, Shinhan, Hyunday, Lotte, VISA, MasterCard, AMEX, JCB
Plain
ans..50
O
A value to be set by the merchant to return some information unencrypted, e.g. the MID
Custom
ans..1024
O
The merchant can submit several values separated by | which are returned unencrypted and separated by &.
Custom=session=123|id=456 will change in the answer to Session=123&id=456
Result parameters for URLNotify, URLSuccess and URLFailure in case of KoreaCC
Capture
Captures are possible via a Server-to-Server connection. To carry out a Capture via a Server-to-Server connection please use the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for credit card payments via KoreaCC
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_IntroURL PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameter
Format
CND
Description
MerchantID
ans..30
M
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
PayID
an32
M
ID assigned by Paygate for the payment to be captured
TransID
ans..64
M
ID assigned by Merchant for the payment process to be captured
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
Amount
n..10
M
Amount in the smallest currency unit (e.g. EUR Cent)
Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currency
a3
M
Currency code, three digits DIN / ISO 4217
Parameters for captures of credit card payments with KoreaCC
The following table describes the Paygate response parameters:
Parameter
Format
CND
Description
MID
ans..30
M
MerchantID, assigned by Computop
PayID
an32
M
ID assigned by Paygate for the payment, e.g. for referencing in batch files.
XID
an32
M
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
TransID
ans..64
M
Merchant’s transaction number
Status
a..50
M
OK or FAILED
Description
ans..1024
M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Code
n8
M
Error code according to Paygate Response Codes (A4 Error codes)
CodeExt
ans4
M
|
Response parameters for captures of credit card payments with KoreaCC
|
Result parameters for URLNotify, URLSuccess and URLFailure in case of KoreaCC
Capture
Captures are possible via a Server-to-Server connection. To carry out a Capture via a Server-to-Server connection please use the following URL:
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for captures of credit card payments with KoreaCC
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_Intro PageWithExcerpt Reuse API
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response parameters for captures of credit card payments with KoreaCC
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. If you refer to a capture for a Credit the amount of the Credit is limited to the amount of the previous capture.
To carry out a credit with a reference transaction, please use the following URL:
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for credits of credit card payments with KoreaCC
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_Intro PageWithExcerpt Reuse API
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response parameters for credits of credit card payments with KoreaCC
Reversal
A credit card authorisation lowers the customer's credit line.
can reverse an authorisation so that it no longer block the limit any more. Use the following URL:Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Platform-Kurz PageWithExcerpt Wording
|
Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
| Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for reversal of credit card payments with KoreaCC
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_Intro PageWithExcerpt Reuse API
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. If you refer to a capture for a Credit the amount of the Credit is limited to the amount of the previous capture.
To carry out a credit with a reference transaction, please use the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter
Format
CND
Description
MerchantID
ans..30
M
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
PayID
an32
M
ID assigned by Paygate for the payment to be credited
TransID
ans..64
M
ID assigned by Merchant for the payment process to be credited
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
Amount
n..10
M
Amount in the smallest currency unit (e.g. EUR Cent)
Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currency
a3
M
Currency code, three digits DIN / ISO 4217
Parameters for credits of credit card payments with KoreaCC
The following table describes the Paygate response parameters:
Parameter
Format
CND
Description
MID
ans..30
M
MerchantID, assigned by Computop
PayID
an32
M
ID assigned by Paygate for the payment, e.g. for referencing in batch files.
XID
an32
M
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
TransID
ans..64
M
Merchant’s transaction number
Status
a..50
M
OK or FAILED
Description
ans..1024
M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Code
n8
M
Error code according to Paygate Response Codes (A4 Error codes)
CodeExt
ans4
M
Error code from downstream system re payment result.
ErrorText
ans..256
M
Detailed information about payment result. The value can include Korean characters.
Response parameters for credits of credit card payments with KoreaCC
Reversal
A credit card authorisation lowers the customer's credit line. Paygate can reverse an authorisation so that it no longer block the limit any more. Use the following URL:
Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.
The following table describes the encrypted payment request parameters:
Parameter
Format
CND
Description
MerchantID
ans..30
M
MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.
PayID
an32
M
Paygate ID for the identification of a payment
TransID
ans..64
M
Merchant ID for the identification of the payment process to be reversed
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
Amount
n..10
M
Amount in the smallest currency unit (e.g. EUR Cent)
Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currency
a3
M
Currency code, three digits DIN / ISO 4217
Parameters for reversal of credit card payments with KoreaCC
The following table describes the Paygate response parameters:
Parameter
Format
CND
Description
MID
ans..30
MC
MerchantID, assigned by Computop
PayID
an32
M
ID assigned by Paygate for the payment, e.g. for referencing in batch files.
XID
an32
M
ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate
TransID
ans..64
M
Merchant’s transaction number
Status
a..50
M
OK or FAILED
Description
ans..1024
M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Code
n8
M
|
|
|
Response parameters for reversals of credit card payments with KoreaCC