generateReceiptV4

ApiScope: payment.receipt.generate
API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required

application/json

Request Body required

transactionUuid string
paymentAttemptUuid string
dealerOrderUuid string
renderFormat string

Possible values: [HTML, PDF, TEXT, URL, SHORT_URL]

templateType string

Possible values: [PRINT, EMAIL, TEXT, NOTIFICATION]

forCustomer boolean

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

object

{}

POST /v4/departments/:departmentUuid/receipts

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/payment

Username

Password

departmentUuid — path required

Body required

{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}

curl / cURL

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'

python / requests

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'

go / native

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'

nodejs / axios

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'

ruby / Net::HTTP

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'

csharp / RestSharp

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'

php / cURL

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'

java / OkHttp

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'

powershell / RestMethod

curl -L -X POST '/payment/v4/departments/:departmentUuid/receipts' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "transactionUuid": "string",
  "paymentAttemptUuid": "string",
  "dealerOrderUuid": "string",
  "renderFormat": "HTML",
  "templateType": "PRINT",
  "forCustomer": true
}'