Contents x
    Deactivate Invoice
    • 04 Apr 2022
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Deactivate Invoice

    • Updated on 04 Apr 2022
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    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
    • Endpoint: deactivateInvoice
    • Name: Inquire Invoice Service
    • Method: POST
    • Input Parameters: invoice, a JSON formatted object.
    • Parameters Type: Form parameters that need to be set in the body of the HTTP request.
    • Path: rest/InvoicesService/deactivateInvoice. The path is prefixed with the SmartLink Context root.

    Input Parameters

    ParameterDescription
    merchantID
    required    		An alphanumeric value that represents the Merchant ID. The Payment Gateway operation team provides this value based on the merchant enrollment. 
    • Field Type: Alphanumeric
    • Length: 30
    • Sample Data: abcMerchant
    authenticationToken 
    required    		An alphanumeric value that represents the Authentication Token. The Payment Gateway operation team provides this value based on the merchant enrollment. 
    • Field Type: Alphanumeric
    • Length: 255
    • Sample Data: ODYxNTY2ZTI4MmJmMzUyM2VhYmUyMGYx
    invoiceID
    required    		An alphanumeric value that represents the Invoice Id that must be unique per invoice.
    • Field Type: Alphanumeric
    • Length: 60
    • Sample Data: 50142985

    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

    ParameterDescription
    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.
    • Field Type: Alphanumeric
    • Length: 60
    • Sample Data: 50142985
    authenticationToken
    required
    		An alphanumeric value that represents the Authentication Token. The Payment Gateway operation team provides this value based on the merchant enrollment. 
    • Field Type: Alphanumeric
    • Length: 255
    • Sample Data: ODYxNTY2ZTI4MmJmMzUyM2VhYmUyMGYx
    status
    required
    		A value that represents the status description of the deactivation process.  
    • Field Type: Alphanumeric
    • Length: 265
    • Sample Data: Invoice is deactivated successfully. 

    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" }
    What's Next