Skip to navigation
MembershipsCard

Send to Wallet

Sends the card's wallet pass link to the member by email or SMS. Membership types with an NP Passes design use NP Passes, other types use the NP Pass server. Returns 400 when the card is blocked, temporary or no longer valid.

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.

cardIdUUIDRequired
Unique identifier for a card.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.
cardIdUUID
Unique identifier for a card.
notificationSentboolean

False when no message was sent. For NP Passes types without a wallet notification setup, deliver landingUrl yourself.

emailstringOptional
The email address or mobile phone number to send cards and notifications to
phoneNostringOptional
The email address or mobile phone number to send cards and notifications to
landingUrlstringOptional
The wallet pass landing page. For NP Passes this is the signed link the member opens to add the pass.
androidUrlstringOptional

NP Pass server only. With NP Passes, use landingUrl.

iosUrlstringOptional

NP Pass server only. With NP Passes, use landingUrl.