Invoice Upload API

The Invoice Upload API is used to collect Invoices or AWB from Cross-Border Payments merchants through upload from the Merchant Dashboard. Invoice ID and Invoice file will be passed by merchants selling software, whereas, for merchants selling goods, there will be separate requests for passing Invoice ID, Invoice file, and AWB number, AWB file. 

HTTP Method: POST

The Invoice Upload API expects only the Invoice ID and Invoice file for merchants selling services. However, for merchants selling goods, different requests must be made to pass the Invoice ID and Invoice file, as well as AWB no. and AWB file; thus, the Invoice Upload API would need to be called twice. 

Merchant calls the Invoice Upload API with the file to be uploaded, PayU ID (mihpayuid), and other mandatory parameters to access the info API.  For merchants who have to include the AWB details (AWB no. and AWB file), they need to use the Invoice Upload API as mentioned in the following subsections:

• Including Single AWB Details
• Including Multiple AWB Details

Including single AWB details

The Invoice Upload API expects only the Invoice ID and Invoice file for merchants selling services. However, for merchants selling goods, different requests must be made to pass the Invoice ID and Invoice file, as well as AWB no. and AWB file; thus, the Invoice Upload API would need to be called twice.   

Including multiple AWB details

If a merchant is shipping multiple physical goods through various vendors on an invoice, you need to post multiple requests.  

For example, you have a customer ordered from two vendors, where vendorA is shipping the product from London and vendorB is shipping the product from Amsterdam.  Here, the AWB no. and corresponding AWB file are different for both vendors. Hence, you need to post three requests using the Invoice Upload API. Where the first request contains the invoice, the second request contains vendorA AWB no. & AWB file, and the third request contains vendorB AWB no. & AWB file. 

To include multiple AWB details using the Invoice Upload API:  

1. Post the first request using the Invoice Upload API with the Invoice ID and Invoice file as mentioned in the Request Parameters table. 
2. Post the request using the Invoice Upload API for the next AWB no. and corresponding AWB file. 
3. Repeat Step 2 until you have posted for all the AWB no. and the corresponding AWB file. 

📘

Note

You need to ensure that the Invoice ID and Invoice file are posted only once in the above procedure.

Environment

Request Parameters

Sample request

curl --location -g --request POST '{{baseUrl}}/merchant/postservice?form=2' \ 
--form 'key="{{merchantKey}}"' \ 
--form 'command="opgsp_upload_invoice_awb"' \ 
--form 'var1="403993715525825059"' \  - PayuId 
--form 'var2="TestInv0001234568"' \ - invoice Id 
--form 'var3="Invoice"' \ - type of upload - Invoice/AWB 
--form 'file=@"/path/to/file"' \ - file 
--form 'hash="{{hash}}"' 

Sample response

Success Scenario

• When a file is uploaded successfully: 

{
\"responseCode\":\"00\",
\"responseMsg\":\"File Uploaded Successfully\"
}

Failure Scenarios

• When there is an error in uploading the file:

{ 
\“responseCode\”: \“103\”, 
\“responseMsg\”: \“Failed to Upload\” 
} 

• When the file format is not supported:

{ 
\“responseCode\”: \“105\”, 
\“responseMsg\”: \“Not an OPGSP merchant, contact KAM\” 
} 

• When the payuid is invalid:

{
\"responseCode\":\"107\",
\"responseMsg\":\"The PayuID in request is invalid\"
}

• When a mandatory field is missing:

{
\"responseCode\":\"109\",
\"responseMsg\":\"All fields are mandatory, please check!\"
} 

Response Code and Description