Deactivate Invoice
- 04 Apr 2022
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Deactivate Invoice
- Updated on 04 Apr 2022
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Use the Deactivate Invoice web service to deactivate invoices that have not been paid/pre-Authorized yet and are still within their validity period on the PayOne SmartLink interface.
Syntax
POST rest/InvoicesService/deactivateInvoice
Service Specifications
Property and Information |
|
Input Parameters
Parameter | Description |
merchantID required | An alphanumeric value that represents the Merchant ID. The Payment Gateway operation team provides this value based on the merchant enrollment.
|
authenticationToken required | An alphanumeric value that represents the Authentication Token. The Payment Gateway operation team provides this value based on the merchant enrollment.
|
invoiceID required | An alphanumeric value that represents the Invoice Id that must be unique per invoice.
|
Sample Request
Deactivate Invoice service request contains the details of the invoice desired to be deactivated.
It is in JSON format that contains the following details:
- merchantID
- authenticationToken
- invoiceID
invoice={ "merchantID":"abcMerchant", "invoiceID":"50142985", "authenticationToken":"ODYxNTY2ZTI4MmJmMzUyM2VhYmUyMGYx" }
Output Parameters
Parameter | Description |
invoiceID required | An alphanumeric value that represents the Invoice Id which must be unique per invoice. The value is the same as the Invoice Id sent in the request.
|
authenticationToken required | An alphanumeric value that represents the Authentication Token. The Payment Gateway operation team provides this value based on the merchant enrollment.
|
status required | A value that represents the status description of the deactivation process.
|
Sample Response
Deactivate Invoice service returns the response in JSON format.
The returned response contains the following details:
- invoiceID
- status
- authenticationToken
{ "invoiceID":"50142985", "status":"Invoice is deactivated successfully", "authenticationToken":"ODYxNTY2ZTI4MmJmMzUyM2VhYmUyMGYx" }