Application Scenarios
This API provides the
function of searching an allowance ticket which has been cancelled
(invalidated).
API URLs:
- Stage: https://einvoice-stage.ecpay.com.tw/B2CInvoice/GetAllowanceInvalid
- Production: https://einvoice.ecpay.com.tw/B2CInvoice/GetAllowanceInvalid
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
InvoiceNo String(10)
Required
- Number of e-invoice
- Fix length: 10
AllowanceNo String(16)
Required
- Number of allowance ticket
- Fix length: 16
Example
{
"MerchantID": 2000132,
"InvoiceNo": "UV11100016",
"AllowanceNo": "2019091719477262"
}
Response format
- Content Type :application/json
- HTTP Method :POST
Response by ECPay (Json format)
PlatformID String(10)
MerchantID String(10)
Required
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.
AI_Allow_Date String(20)
- Allowance order date
- Format is “yyyy-MM-dd HH:mm:ss”
AI_Allow_No String(16)
Allowance order number
AI_Buyer_Identifier String(10)
- Buyer Tax ID
- 0000000000 Implies that there is no Tax ID
AI_Date String(20)
- Invalidation Time
- Format is “yyyy-MM-dd HH:mm:ss”
AI_Invoice_No String(10)
Invoice number
AI_Mer_ID String(10)
Merchant Code
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
AI_Seller_Identifier String(10)
Seller Tax ID
AI_Upload_Date String(10)
- Upload time
- Format is “yyyy-MM-dd HH:mm:ss”
AI_Upload_Status String(1)
- Upload status
- 1: Upload complete
0: Not yet uploaded
Example
{
"AI_Allow_Date": "2019-09-17 19:47:19",
"AI_Allow_No": "2019091719477262",
"AI_Buyer_Identifier": "0000000000",
"AI_Date": "2019-09-17 19:52:58",
"AI_Invoice_No": "UV11100016",
"AI_Mer_ID": "2000132",
"Reason": "Reson",
"AI_Seller_Identifier": "11456006",
"AI_Upload_Date": "",
"AI_Upload_Status": "0",
"RtnCode": 1,
"RtnMsg": "Success"
}