Skip to content
API & References
/
/Configuration

Configuration

Per-merchant receipt configuration stored locally by the Receipt Service

Operations

Get Receipt Configuration

Request

Retrieve the per-merchant receipt configuration stored locally by the Receipt Service.

Includes branding, template, receipt number format, send defaults, and push notification settings.

Security
OAuth2
Query
entityIdinteger, (int64)required

Merchant/tenant identifier for tenant isolation

curl -i -X GET \
  'https://docs.nelnetpay.com/_mock/apis/receipts-service/config?entityId=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Configuration retrieved 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",
  "object": {
    "id": "550e8400-e29b-41d4-a716-446655440099",
    "entityId": 6393980735,
    "enabled": true,
    "defaultCurrency": "USD",
    "branding": { … },
    "receiptNumberFormat": "RCP-{YEAR}{MONTH}-{SEQ}",
    "receiptNumberPrefix": "RCP",
    "minDigits": 6,
    "autoSendOnPayment": true,
    "defaultSendChannels": [ … ],
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-02-20T14:30:00Z"
  }
}