Searching Operations / Searching E-invoice Invalidated

Application Scenarios

This API provides the function of searching an e-invoice which has been cancelled (invalidated)

API URLs:

Stage: https://einvoice-stage.ecpay.com.tw/B2CInvoice/GetInvalid
Production: https://einvoice.ecpay.com.tw/B2CInvoice/GetInvalid

HTTPS format

Content Type ：application/json
HTTP Method ：POST

Request by Merchant (Json format)

PlatformID String(10)

This parameter is specifically designed for platform vendors collaborating with ECPay. It can only be utilized after applying for and activating the service.
If you are a general vendor, please leave the PlatformID empty.
When using this parameter, the MerchantID must be filled in with the specific store code bound to your PlatformID to prevent operation failures.
Please note that only the MerchantID of a bound sub-merchant can be used to avoid operational failures. For binding operations, please contact your business representative.

MerchantID String(10)
Required

RqHeader Object
Required

Request header

Timestamp Number
Required

Please convert the transmission time to a timestamp (GMT+8).
ECPay will use this parameter to convert the current time to Unix TimeStamp to verify the time interval of this connection.

Special Notes：

If ECPay receives the API call is more 10 minutes late than the timestamp sent by merchants, this request will be failed. Reference information is as follows：http://www.epochconverter.com/。
Merchants are suggested to frequently synchronize the time zone of server to another server of the nearest time zone.

Data String
Required

Message payload
This is the encrypted data in JSON format.
AES Encryption Description

Example

				
					{
    "MerchantID": "2000132",
    "RqHeader": {
        "Timestamp": 1525168923
    },
    "Data": "..."
}

Message payload of Data(Json format) : please urlencode the JSON string firstly and then do AES encryption

MerchantID String(10)
Required

RelateNumber String(30)
Required

Unique ID of the e-invoice which is defined by the merchant itself.
Fix length: 30

Special notes : special characters are not acceptable.

InvoiceNo String(10)
Required

Number of e-invoice
Fix length: 10

InvoiceDate String(10)
Required

Date of e-invoice created
The format: yyyy-MM-dd

Example

				
					{
  "MerchantID": 2000132,
  "RelateNumber": "123456789",
  "InvoiceNo": "UV11100016",
  "InvoiceDate": "2018-10-28"
}

Response format

Content Type ：application/json
HTTP Method ：POST

Response by ECPay (Json format)

PlatformID String(10)

MerchantID String(10)
Required

RpHeader Object

Response header

Timestamp Number

Unix timestamp(GMT+8)

TransCode Int

Response code to indicate whether the payload is successfully accepted
Possible values:
1: Payload (i.e. MerchantID, RqHeader, and Data) is successfully accepted by ECPay.
Others: failed.

TransMsg String(200)

Response message to indicate whether the payload is successfully accepted

Data String

Message payload
Responde relevant data, this is the encrypted JSON format data。
AES Encryption Description

Example

				
					{
    "MerchantID": "2000132",
    "RpHeader": {
        "Timestamp": 1525169058
    },
    "TransCode": 1,
    "TransMsg": "",
    "Data": "..."
}

Message payload of Data(Json format) : please do AES decryption to the Data firstly and then do urldecode.

RtnCode Int

Return codes to indicate whether the API is successfully executed or not.
Possible values:
1: API is successfully executed.
Others: failed.

RtnMsg String(200)

Return messages to indicate whether the API is successfully executed or not.

ChannelPartner String(1)

1:Shopee

IIS_Mer_ID String(10)

merchant ID

II_Date String(20)

Invalidation Time
Format is “yyyy-MM-dd HH:mm:ss”

II_Upload_Status String(1)

Upload status
1: Upload complete
0: Not yet uploaded

II_Upload_Date String(20)

Upload time
Format is “yyyy-MM-dd HH:mm:ss”

Reason String(20)

Invalidation Reason
Will be output in the form of URL Encode coding
The parameter shall be exempted when calculating the check digit

II_Seller_Identifier String(10)

Seller Tax ID

II_Buyer_Identifier String(10)

Buyer Tax ID
0000000000 implies that there is no Tax ID

Example

				
					{
  "RtnCode": 1,
  "RtnMsg": "查詢成功,
  "ChannelPartner": "",
  "IIS_Mer_ID": "2000132",
  "II_Invoice_No": "UV11100018",
  "II_Date": "2019-09-17 20:00:50",
  "II_Upload_Status": "0",
  "II_Upload_Date": "",
  "Reason": "Invalid_Reason",
  "II_Seller_Identifier": "11456006",
  "II_Buyer_Identifier": "0000000000"
}

Green World