Skip to content

Create Template

Request

Upload a new custom Liquid template for receipt or email rendering. The template is created in DRAFT status and must be activated before use. Liquid syntax is validated on creation.

Security
OAuth2
Bodyapplication/jsonrequired
entityIdinteger, (int64)required

Merchant/tenant identifier for tenant isolation

namestring, <= 255 charactersrequired

Human-readable template name

Example:"Custom branded receipt"
typestringrequired

RECEIPT - Template for the rendered receipt document (HTML). RECEIPT_EMAIL - Template for the receipt notification email body.

Enum:"RECEIPT""RECEIPT_EMAIL"
contentstring, <= 65536 charactersrequired

Liquid template markup

descriptionstring, <= 1000 characters

Optional description of the template's purpose

curl -i -X POST \
  https://docs.nelnetpay.com/_mock/apis/receipts-service/templates \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entityId": 0,
    "name": "Custom branded receipt",
    "type": "RECEIPT",
    "content": "string",
    "description": "string"
  }'

Responses

Template created successfully

Bodyapplication/json
responseCodestringrequired
Example:"A100"
responseMessagestringrequired
Example:"Approved"
responseDetailsnullrequired
objectobjectrequired

Business payload for this operation (null when no payload)

Response
{ "responseCode": "A100", "responseMessage": "Approved", "responseDetails": null, "object": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": 0, "name": "string", "type": "RECEIPT", "engineType": "LIQUID", "content": "string", "version": 1, "status": "DRAFT", "isSystem": true, "description": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "createdBy": "string" } }