sendInvoice

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

ApiScope: payment.invoice.send
API Scope Level: ServiceSubscriberScope

application/json

Request Body required

paymentRequestDTO object
id int64
version int64
amount number
timeStamp date-time
source string
sourceInfo string
status string
ttl int64
paymentType string
guid string
refundStatus string
invoiceGUID string
invoiceEmailMessage string
dealerID int64
dealerUUID string
emailCustomerCommunicationID int64
phoneCustomerCommunicationID int64
paymentRequestType string
sendAsText boolean
sendAsEmail boolean
esignInvoice boolean
sendWithoutInvoice boolean
achEnabled boolean
achOnly boolean

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

object

{}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

POST /kpayment/v1/sendInvoice

Request

Base URL

/payment

Body required

{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}

curl / cURL

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'

python / requests

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'

go / native

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'

nodejs / axios

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'

ruby / Net::HTTP

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'

csharp / RestSharp

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'

php / cURL

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'

java / OkHttp

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'

powershell / RestMethod

curl -L -X POST '/payment/kpayment/v1/sendInvoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "paymentRequestDTO": {
    "id": 0,
    "version": 0,
    "amount": 0,
    "timeStamp": "2025-03-28T11:34:46.512Z",
    "source": "string",
    "sourceInfo": "string",
    "status": "string",
    "ttl": 0,
    "paymentType": "string",
    "guid": "string",
    "refundStatus": "string"
  },
  "invoiceGUID": "string",
  "invoiceEmailMessage": "string",
  "dealerID": 0,
  "dealerUUID": "string",
  "emailCustomerCommunicationID": 0,
  "phoneCustomerCommunicationID": 0,
  "paymentRequestType": "string",
  "sendAsText": true,
  "sendAsEmail": true,
  "esignInvoice": true,
  "sendWithoutInvoice": true,
  "achEnabled": true,
  "achOnly": true
}'