Create digital wallet tokens - Equals Money Documentation

Create a digital wallet token to provision a digital wallet token into an Apple, Google, or Samsung wallet. Once your request is processed, you’ll receive a DigitalWalletTokenTransition containing the digital wallet token. Learn more about webhooks and how to subscribe to them.

You can only have up to 25 digital wallet tokens associated with the same funding PAN. This includes both active and suspended tokens. If you try to create a 26th, Mastercard will display an error message on the device itself — you won’t receive an error message from the Equals Money API.

Before you start

To create digital wallet tokens, you’ll need to:

ensure that tokenisation is enabled for your cards
have an existing app and the relevant App Store or Google Play certificates

Tokenisation is enabled at a BIN and card product level. If you’re not sure this is enabled for your cards, please get in touch with your account manager.

Create an Apple digital wallet token

POST /v2/cards/{cardId}/apple-wallet

Request

Use this request to create a digital wallet token that can be added to an Apple wallet. The card’s data is encrypted using Apple’s own encryption key, meaning your PCI compliance overhead is reduced.

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/2471fbf0-cb07-42fc-863e-5979d5773122/apple-wallet?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "deviceType": "WATCH",
    "provisioningAppVersion": "2.11.1",
    "certificates": [
      "MIIEPDCCA+KgAwIBAgICEAAwCQYHKoZIzj",
      "MIIDZjCCAw2gAwIBAgIJAJx22AGaEPSgMA"
    ],
    "nonce": "vXWJaBidcTLaJJCF",
    "nonceSignature": "jD4Aphu+93N2wbBn"
  }'

Path parameters

cardId

string (uuid)

required

The ID of the card to work with.Allowable values: An existing cardId (≤ 36 characters)

Query parameters

accountId

string

required

The ID of the account that the card is associated with.Allowable values: An existing accountId

personId

string (uuid)

The ID of the person that the card belongs to.Allowable values: An existing personId (≤ 36 characters)

Request body schema

deviceType

string

required

The type of device. For example, type=WATCH.Allowable values: MOBILE_PHONE, TABLET, WATCH

provisioningAppVersion

string

required

The version of the application making the provisioning request. This is used for debugging and fraud prevention.Allowable values: ≤ 50 characters

certificates

array of strings

required

The Base64-encoded leaf and sub-CA certificates provided by Apple. The first element of the array should be the leaf certificate, followed by the sub-CA.Allowable values: A valid array of strings

nonce

string

required

The single-use nonce provided by Apple for security purposes.Allowable values: A valid string

nonceSignature

string

required

The signature to the nonce provided by Apple.Allowable values: A valid string

Response

If your request is successful, you’ll receive a 201 response. You’ll also receive a webhook containing the digital wallet token.

{
  "deviceType": "WATCH",
  "provisioningAppVersion": "2.11.1",
  "certificates": [
    "MIIEPDCCA+KgAwIBAgICEAAwCQYHKoZIzj",
    "MIIDZjCCAw2gAwIBAgIJAJx22AGaEPSgMA"
  ],
  "nonce": "vXWJaBidcTLaJJCF",
  "nonceSignature": "jD4Aphu+93N2wbBn"
}

For more detailed information about this request and its response, see the API reference.

Create a Google Pay digital wallet token

POST /v2/cards/{cardId}/google-wallet

Request

Use this request to create a digital wallet token that can be added to a Google wallet. The card’s data is encrypted using Google’s own encryption key, meaning your PCI compliance overhead is reduced.

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/9888e73c-3ea6-4911-bbdd-79f9bab5919c/google-wallet?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "deviceType": "WATCH",
    "provisioningAppVersion": "2.11.1",
    "deviceId": "b39f54264a3d",
    "walletUserId": "894b8236-b5cc-4f49-89f7-690d7bc4b9d2"
  }'

Path parameters

cardId

string (uuid)

required

The ID of the card to work with.Allowable values: An existing cardId (≤ 36 characters)

Query parameters

accountId

string

required

The ID of the account that the card is associated with.Allowable values: An existing accountId

personId

string (uuid)

The ID of the person that the card belongs to.Allowable values: An existing personId (≤ 36 characters)

Request body schema

deviceType

string

required

The type of device. For example, type=WATCH.Allowable values: MOBILE_PHONE, TABLET, WATCH

provisioningAppVersion

string

required

The version of the application making the provisioning request. This is used for debugging and fraud prevention.Allowable values: ≤ 50 characters

deviceId

string

required

The unique identifier for the cardholder’s Android device, as provided during the provisioning process.Allowable values: ≤ 24 characters

walletUserId

string

required

The cardholder’s digital wallet account ID, as provided during the provisioning process.Allowable values: ≤ 50 characters

Response

If your request is successful, you’ll receive a 201 response. You’ll also receive a webhook containing the digital wallet token.

{
  "createdAt": "2022-11-06T22:43:20Z",
  "updatedAt": "2022-11-06T22:43:20Z",
  "pushTokenizeRequestData": {
    "displayName": "Visa 5678",
    "lastDigits": "3264",
    "network": "Visa",
    "tokenServiceProvider": "TOKEN_PROVIDER_VISA",
    "opaquePaymentCard": "my_opaque_payment_card_RUza...",
    "userAddress": {
      "name": "John Doe",
      "address1": "180 Grand Ave",
      "address2": "Suite 500",
      "city": "Oakland",
      "state": "CA",
      "postalCode": "94612",
      "country": "US",
      "phone": "5105551212"
    }
  }
}

For more detailed information about this request and its response, see the API reference.

Create a Samsung digital wallet token

POST /v2/cards/{cardId}/samsung-wallet

Request

Use this request to create a digital wallet token that can be added to a Samsung wallet. The card’s data is encrypted using Samsung’s own encryption key, meaning your PCI compliance overhead is reduced.

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/48a5f1ea-0d14-4ef5-b6ed-3a33957e6505/samsung-wallet?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "deviceType": "WATCH",
    "provisioningAppVersion": "2.11.1",
    "deviceId": "b39f54264a3d",
    "walletUserId": "894b8236-b5cc-4f49-89f7-690d7bc4b9d2"
  }'

Path parameters

cardId

string (uuid)

required

The ID of the card to work with.Allowable values: An existing cardId (≤ 36 characters)

Query parameters

accountId

string

required

The ID of the account that the card is associated with.Allowable values: An existing accountId

personId

string (uuid)

The ID of the person that the card belongs to.Allowable values: An existing personId (≤ 36 characters)

Request body schema

deviceType

string

required

The type of device. For example, type=WATCH.Allowable values: MOBILE_PHONE, TABLET, WATCH

provisioningAppVersion

string

required

The version of the application making the provisioning request. This is used for debugging and fraud prevention.Allowable values: ≤ 50 characters

deviceId

string

required

The unique identifier for the cardholder’s Android device, as provided during the provisioning process.Allowable values: ≤ 24 characters

walletUserId

string

required

The cardholder’s digital wallet account ID, as provided during the provisioning process.Allowable values: ≤ 50 characters

Response

If your request is successful, you’ll receive a 201 response. You’ll also receive a webhook containing the digital wallet token.

{
  "createdAt": "2023-03-14T12:08:53Z",
  "updatedAt": "2023-03-14T12:08:53Z",
  "pushTokenizeRequestData": {
    "cardType": "CREDIT",
    "displayName": "Visa 5678",
    "extraProvisionPayload": "string",
    "lastDigits": "5678",
    "network": "CREDIT",
    "tokenServiceProvider": "MC"
  }
}

For more detailed information about this request and its response, see the API reference.

​Before you start

​Create an Apple digital wallet token

​Request

​Path parameters

​Query parameters

​Request body schema

​Response

​Create a Google Pay digital wallet token

​Request

​Path parameters

​Query parameters

​Request body schema

​Response

​Create a Samsung digital wallet token

​Request

​Path parameters

​Query parameters

​Request body schema

​Response

Before you start

Create an Apple digital wallet token

Request

Path parameters

Query parameters

Request body schema

Response

Create a Google Pay digital wallet token

Request

Path parameters

Query parameters

Request body schema

Response

Create a Samsung digital wallet token

Request

Path parameters

Query parameters

Request body schema

Response