Remind Invoice

A merchant can perform following Invoice operations using our REST API.

Remind an invoice

Merchant can send reminder mail to the customer for the invoice using this API.

How to Remind Invoice?

The merchantInvoiceId will be referred and a POST request will be send over HTTPS to the invoiceServices/REST/v1/remind endpoint.

In our API Specifications you can find a full list of parameters that can be sent in the initial request.

To remind invoice merchant first needs to generate authentication token and set it in header while. To generate auth token please refer Auth token API.

Sample Request

Language:

curl https://ipg-beta.caibo.digital/invoiceServices/REST/v1/remind \
curl --header "AuthToken:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjb25tZXJjaGFudDEiLCJyb2xlIjoibWVyY2hhbnQiLCJpc3MiOiJQWiIsImV4cCI6MTUwMTE0NjY0MX0.TFmGGKDUgkktmZQvrUTeox1buH1J6lgBVE3Mcy8OVjA"
	-d "invoiceId=1724" \
	-d "authentication.memberId=11344" \
	-d "merchantRedirectUrl=www.merchantRedirectUrl.com"

Sample Response

Language:

JSON
XML

{
 "memberId": "11344",
 "statusInvoiceResult": {
  "code": "00012",
  "description": "Invoice reminder sent successfully"
 },
 "invoiceDetails": {
  "amount": "50.00",
  "currency": "USD",
  "createdDate": "2017-02-08",
  "createdTime": " 16:40:32.",
  "merchantInvoiceId": "Invoice01",
  "customerEmail": "john.doe@abc.com",
  "merchantOrderDescription": "Invoice for Goods and Services",
  "systemInvoiceId": "1746",
  "transactionUrl": "https://ipg-beta.caibo.digital/transaction/PayInvoice?inv=2625&ct=wgdeHvcvppnoyjoH"
 }
}