Create Wallet

POST

https://api.npretail.app/:tenant/:environment/:company/attractionWallet

POST

/:tenant/:environment/:company/attractionWallet

curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./attractionWallet \
     -H "x-np-api-key: <NaviPartner API Key>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "My wallet holds my tickets, coupons and vouchers for the event.",
  "tickets": [
    "3d4b95d8-16e0-42e4-9b2a-1d95f08d5c14"
  ],
  "memberCards": [
    "5f6d17fa-38a2-64a6-bd4c-3f17a20f7e16"
  ],
  "coupons": [
    "7b8c9d0e-8f90-1abc-def1-234567890abc"
  ],
  "vouchers": [
    "9d0e1f2a-012b-3cde-f123-4567890abcde"
  ],
  "externalReferenceNumbers": [
    "john.doe@acme.com"
  ],
  "originatesFromItemNo": "70009"
}'

200CreateWalletRequest

{
  "description": "My wallet holds my tickets, coupons and vouchers for the event.",
  "expiryDatetime": "2026-12-31T23:59:59Z",
  "lastPrintedAt": "2026-12-31T23:59:59Z",
  "printCount": 1,
  "referenceNumber": "141234529930210327",
  "walletId": "a2cbd5bc-5cf4-ef11-b3a1-a1084fe21c78",
  "assets": [
    {
      "id": "2c3a84c7-059f-41d3-8033-0d94e08d4b13",
      "type": "ticket",
      "assetId": "3d4b95d8-16e0-42e4-9b2a-1d95f08d5c14",
      "itemNo": "31005",
      "description": "General Admission",
      "referenceNumber": "ATF-BIL010665L-3",
      "isSuperseded": false,
      "expiryDatetime": "2026-12-31T23:59:59Z"
    },
    {
      "id": "7e8f90ab-cdef-1234-5678-90abcdef1234",
      "type": "membership",
      "assetId": "5f6d17fa-38a2-64a6-bd4c-3f17a20f7e16",
      "itemNo": "320100",
      "description": "Membership Card",
      "referenceNumber": "CARD-FWGEASWFJFD",
      "isSuperseded": false,
      "expiryDatetime": "2026-12-31T23:59:59Z"
    }
  ],
  "externalReferenceNumber": "151234529930210327",
  "originatesFromDescription": "Family Fun Pack",
  "originatesFromItemNo": "70009"
}

Create a new wallet. Note that in the Create Wallet and Add to Wallet, API calls, the assets may also be identified by their visual reference numbers. If the assetId does not interpret as a UUID, the system will attempt to resolve it as a visual reference number.

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Request

This endpoint expects an object.

namestringOptional

A human-readable description of the wallet.

ticketslist of UUIDsOptional

memberCardslist of UUIDsOptional

couponslist of UUIDsOptional

voucherslist of UUIDsOptional

externalReferenceNumberslist of stringsOptional

originatesFromItemNostringOptional

The item number from which the wallet originates.

Response

This endpoint returns an object.

descriptionstring

A human-readable description of the wallet.

expiryDatetimestring

The expiry datetime of the wallet in ISO 8601 format. Use an empty string if not applicable.

lastPrintedAtstring

The datetime when the wallet was last printed in ISO 8601 format. Use an empty string if not applicable.

printCountinteger

The number of times the wallet has been printed.

referenceNumberstring

The visual reference number associated with the wallet.

walletIdUUID

A globally unique identifier for the wallet.

assetslist of objectsOptional

externalReferenceNumberstringOptional

The first external reference on the wallet that is neither blocked nor expired. null when there is none.

originatesFromDescriptionstringOptional

The item description from which the wallet originates.