Digital Wallets Management

Documentation Index

Fetch the complete documentation index at: /docs/llms.txt

Use this file to discover all available pages before exploring further.

Skip to main content

The Marqeta platform facilitates the use of digital wallets for storing tokenized cards and making payments. The API provides endpoints that enable mobile applications to provision tokens into a digital wallet. It also provides endpoints for retrieving digital wallet tokens and for managing their lifecycle through state transitions.For an overview of digital wallet tokens, see Digital Wallets and Tokenization.

​ Create digital wallet token provisioning request for Apple Wallet

Action:POST Endpoint:/digitalwalletprovisionrequests/applepayUse this endpoint to return card data for use in provisioning a digital wallet token into Apple Wallet.The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your Payment Card Industry (PCI) compliance overhead.

​ Request body

​ Sample request body

JSON

{
  "card_token": "my_card_token_1234",
  "device_type": "MOBILE_PHONE",
  "provisioning_app_version": "2.13.7",
  "certificates": [\
    "my_certificate_ZIzj...",\
    "my_certificate_SgMA..."\
  ],
  "nonce": "my_nonce_JJCF",
  "nonce_signature": "my_nonce_signature_wbBn"
}

See all 11 lines

​ Response body

​ Sample response body

JSON

{
  "created_time": "2026-03-22T21:22:19Z",
  "last_modified_time": "2026-03-22T21:22:19Z",
  "card_token": "my_card_token_1234",
  "encrypted_pass_data": "my_encrypted_pass_data_KGga...",
  "activation_data": "my_activation_data_VERF...",
  "ephemeral_public_key": "my_ephemeral_public_key_omvw..."
}

See all 8 lines

​ Submit a post-tokenization authentication decision

Action:POST Endpoint:/digitalwallets/postTokenizationAuthenticationDecisionUse this endpoint to submit a post-tokenization authentication decision from the customer to Marqeta in a secure card on file scenario. Marqeta validates the request, stores it, and forwards the authentication decision to Mastercard Digital Enablement Service (MDES) in real time. Marqeta then returns the MDES response back to the customer synchronously. This enables issuers to notify MDES of the cardholder’s authentication outcome following tokenization, ensuring that the token requestor receives timely and accurate decisioning.

​ Request body

​ Response body

​ Create a digital wallet token provisioning request for Google Wallet as part of UPP

Action:POST Endpoint:/digitalwalletprovisionrequests/v2/androidpayUse this endpoint to retrieve the card data needed to provision a digital wallet token into Google Wallet as part of Unified Push Provisioning (UPP).The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your Payment Card Industry (PCI) compliance overhead.

​ Request body

​ Sample request body

JSON

{
  "card_token": "test-card-token",
  "device_type": "MOBILE_PHONE",
  "wallet_account_id": "google_wallet_user_abc123xyz",
  "device_id": "device_987654321",
  "provisioning_app_version": "2.1.0",
  "token_requestor_id": "40010075001",
  "server_session_id": "sdfadfafsfa"
}

See all 9 lines

​ Response body

​ Sample response body

JSON

{
  "created_time": "2025-11-06T22:43:20Z",
  "last_modified_time": "2025-11-06T22:43:20Z",
  "card_token": "my_card_token_1111",
  "push_tokenize_request_data": {
    "display_name": "Visa Card",
    "last_digits": "3264",
    "network": "Visa",
    "token_service_provider": "TOKEN_PROVIDER_VISA",
    "opaque_payment_card": "my_opaque_payment_card_RUza...",
    "user_address": {
      "name": "John Doe",
      "address1": "180 Grand Ave",
      "address2": "Suite 500",
      "city": "Oakland",
      "state": "CA",
      "postal_code": "94612",
      "country": "US",
      "phone": "5105551212"
    }
  },
  "google_opaque_payment_card": "my_google_opaque_payment_card_sfawe..."
}

See all 23 lines

​ Create digital wallet token provisioning request for Google Wallet

Action:POST Endpoint:/digitalwalletprovisionrequests/androidpayUse this endpoint to return card data for use in provisioning a digital wallet token into Google Wallet.The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your Payment Card Industry (PCI) compliance overhead.

​ Request body

​ Sample request body

JSON

{
  "card_token": "my_card_token_0987",
  "device_type": "MOBILE_PHONE",
  "provisioning_app_version": "2.13.3",
  "wallet_account_id": "my_wallet_account_id_sr51",
  "device_id": "my_device_id_r51j"
}

See all 7 lines

​ Response body

​ Sample response body

JSON

See all 22 lines

​ Create digital wallet token provisioning request for Samsung Wallet

Action:POST Endpoint:/digitalwalletprovisionrequests/samsungpay

This endpoint is limited in availability. For more information, contact your Marqeta representative.

Use this endpoint to return card data for use in provisioning a digital wallet token into Samsung Wallet.The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your Payment Card Industry (PCI) compliance overhead.

​ Request body

​ Response body

​ Create digital wallet token provisioning request for XPay

Action:POST Endpoint:/digitalwalletprovisionrequests/xpay

This endpoint is limited in availability. For more information, contact your Marqeta representative.

Use this endpoint to return card data for use in provisioning a digital wallet token into an XPay digital wallet.The returned card data is encrypted using the digital wallet provider’s encryption key, thereby reducing your Payment Card Industry (PCI) compliance overhead.

​ Request body

​ Response body

​ Create digital wallet token transition

Action:POST Endpoint:/digitalwallettokentransitionsUse this endpoint to transition a digital wallet token from one state to another.

​ Request body

​ Sample request body

JSON

{
  "token": "my_transition_04",
  "digital_wallet_token": {
    "token": "my_digital_wallet_token_0987"
  },
  "state": "ACTIVE",
  "reason": "Passed additional identity verification",
  "reason_code": "18"
}

See all 9 lines

​ Response body

​ Sample response body

JSON

{
  "token": "my_transition_04",
  "digital_wallet_token": {
    "token": "my_digital_wallet_token_0987"
  },
  "type": "state.activated",
  "channel": "API",
  "state": "ACTIVE",
  "fulfillment_status": "PROVISIONED",
  "reason": "Passed additional identity verification",
  "reason_code": "18",
  "created_time": "2026-02-23T18:57:45Z"
}

See all 13 lines

​ Error responses

​ Sample error response body

JSON

{
  "error_message": "Unsuccessful response from token services gateway",
  "error_code": "422003"
}

​ Retrieve digital wallet token transition

Action:GET Endpoint:/digitalwallettokentransitions/{token}Use this endpoint to retrieve a specific digital wallet token transition.This endpoint supports field filtering.

​ URL path parameters

​ URL query parameters

​ Response body

​ Sample response body

JSON

See all 13 lines

​ List transitions for digital wallet token

Action:GET Endpoint:/digitalwallettokentransitions/digitalwallettoken/{token}Use this endpoint to return an array of all transitions for a particular digital wallet token.This endpoint supports field filtering, pagination, and sorting.

​ URL path parameters

​ URL query parameters

​ Response body

​ Sample response body

JSON

{
  "count": 2,
  "start_index": 0,
  "end_index": 1,
  "is_more": false,
  "data": [\
    {\
      "token": "my_transition_04",\
      "digital_wallet_token": {\
        "token": "my_digital_wallet_token_0987"\
      },\
      "type": "state.activated",\
      "channel": "API",\
      "state": "ACTIVE",\
      "fulfillment_status": "PROVISIONED",\
      "reason": "Passed additional identity verification",\
      "reason_code": "18",\
      "created_time": "2026-02-23T18:57:45Z"\
    },\
    {\
      "token": "my_transition_04",\
      "digital_wallet_token": {\
        "token": "my_digital_wallet_token_0987"\
      },\
      "type": "fulfillment.requested",\
      "channel": "TOKEN_SERVICE_PROVIDER",\
      "state": "REQUESTED",\
      "fulfillment_status": "DECISION_YELLOW",\
      "reason": "Additional identity verification required",\
      "reason_code": "21",\
      "created_time": "2026-02-23T18:44:21Z"\
    }\
  ]
}

See all 34 lines

​ List digital wallet tokens

Action:GET Endpoint:/digitalwallettokensUse this endpoint to retrieve a list of digital wallet tokens.

​ URL query parameters

​ Response body

​ Retrieve digital wallet token

Action:GET Endpoint:/digitalwallettokens/{token}Use this endpoint to retrieve a specific digital wallet token.

​ URL path parameters

​ Response body

​ Sample response body

JSON

{
  "token": "my_token_0000",
  "card_token": "my_card_token_1989",
  "state": "ACTIVE",
  "state_reason": "Card activated by cardholder",
  "fulfillment_status": "PROVISIONED",
  "issuer_eligibility_decision": "cardaccount.verified",
  "created_time": "2025-10-03T18:55:45Z",
  "last_modified_time": "2026-01-26T22:36:10Z",
  "token_service_provider": {
    "token_reference_id": "my_token_reference_id_1600",
    "pan_reference_id": "my_pan_reference_id_0073",
    "token_requestor_id": "my_token_requestor_id_0373",
    "token_requestor_name": "Token Requestor Name",
    "token_type": "DEVICE_SECURE_ELEMENT",
    "token_score": "02",
    "token_eligibility_decision": "DECISION_GREEN"
  },
  "device": {
    "type": "MOBILE_PHONE",
    "language_code": "eng",
    "device_id": "my_device_id_9575",
    "phone_number": "12345678900",
    "name": "Phone Name",
    "location": "+37.81/-122.26",
    "ip_address": "x.x.x.x"
  },
  "wallet_provider_profile": {
    "account": {
      "score": "05"
    },
    "risk_assessment": {
      "score": "DECISION_YELLOW",
      "version": "0001.00"
    },
    "device_score": "03",
    "pan_source": "KEY_ENTERED"
  },
  "address_verification": {
    "name": "Address Verification Name",
    "street_address": "223 Elm Street",
    "postal_code": "94703"
  }
}

See all 44 lines

​ List digital wallet tokens for card

Action:GET Endpoint:/digitalwallettokens/card/{card_token}Use this endpoint to return an array of all digital wallet tokens for a particular card.This endpoint supports pagination.

​ URL path parameters

​ URL query parameters

​ Response body

​ Sample response body

JSON

{
  "count": 1,
  "start_index": 0,
  "end_index": 0,
  "is_more": true,
  "data": [\
    {\
      "token": "my_token_0000",\
      "card_token": "my_card_token_1989",\
      "state": "ACTIVE",\
      "state_reason": "Card activated by cardholder",\
      "fulfillment_status": "PROVISIONED",\
      "issuer_eligibility_decision": "cardaccount.verified",\
      "created_time": "2025-10-03T18:55:45Z",\
      "last_modified_time": "2026-01-26T22:36:10Z",\
      "token_service_provider": {\
        "token_reference_id": "my_token_reference_id_1600",\
        "pan_reference_id": "my_pan_reference_id_0073",\
        "token_requestor_id": "my_token_requestor_id_0373",\
        "token_requestor_name": "Token Requestor Name",\
        "token_type": "DEVICE_SECURE_ELEMENT",\
        "token_score": "02",\
        "token_eligibility_decision": "DECISION_GREEN"\
      },\
      "device": {\
        "type": "MOBILE_PHONE",\
        "language_code": "eng",\
        "device_id": "my_device_id_9575",\
        "phone_number": "12345678900",\
        "name": "Phone Name",\
        "location": "+37.81/-122.26",\
        "ip_address": "x.x.x.x"\
      },\
      "wallet_provider_profile": {\
        "account": {\
          "score": "05"\
        },\
        "risk_assessment": {\
          "score": "DECISION_YELLOW",\
          "version": "0001.00"\
        },\
        "device_score": "03",\
        "pan_source": "KEY_ENTERED"\
      },\
      "address_verification": {\
        "name": "Address Verification Name",\
        "street_address": "223 Elm Street",\
        "postal_code": "94703"\
      }\
    }\
  ]
}

See all 52 lines

​ Retrieve digital wallet token PAN

Action:GET Endpoint:/digitalwallettokens/{token}/showtokenpanUse this endpoint to retrieve a digital wallet token with the entire primary account number (PAN) displayed. The PAN returned is of the digital wallet token and not of the card. For security reasons, the PAN is not fully visible on the digital wallet token returned by GET``/digitalwallettokens/{token}.

Sending a request to this endpoint requires Payment Card Industry (PCI) Data Security Standard (DSS) compliance. You must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card data such as the cardholder’s PAN, personal identification number (PIN), and card expiration date.

​ URL path parameters

​ Response body

​ Sample response body

JSON

See all 45 lines

​ Create request for Apple Wallet web push provisioning

Action:POST Endpoint:/digitalwallets/wpp/applePayJWTUse this endpoint to add a card to Apple Wallet via a web application.

​ Header parameter

​ Request body

​ Response body

​ Create request for Google Wallet web push provisioning

Action:POST Endpoint:/digitalwallets/wpp/googlePayPushProvisioningNotificationUse this endpoint to add a card to Google Wallet via a web application.This endpoint does not return a payload in response to a request. Instead, a successful call will return a response code only.

​ Header parameter

​ Request body

​ Create a request for Google Wallet web push provisioning (UPP)

Action:POST Endpoint:/digitalwallets/wpp/v2/googlePayPushProvisioningNotificationUse this endpoint to add a card to Google Wallet via a web application using the Unified Push Provisioning (UPP) flow.

​ Header parameter

​ Request body

​ Sample request body

JSON

{
  "card_token": "e9419ecb-f317-4fe7-a6c1-e33989b3576f",
  "device_id": "device-hardware-id",
  "wallet_id": "google-wallet-id",
  "server_session_id": "abc123",
  "token_setting": 1,
  "card_setting": 1
}

See all 8 lines

​ Response body

​ Sample response body

JSON

{
  "display_name": "My Visa Card",
  "last_digits": "1234",
  "user": {
    "name": "Jane Doe",
    "address_lines": [\
      "123 Main St"\
    ],
    "locality_name": "San Francisco",
    "administrative_area_name": "CA",
    "postal_code_number": "94105",
    "country_code": "US",
    "phone": "+14155550100"
  },
  "token_credentials": {
    "card_network": "PAYMENT_NETWORK_VISA",
    "token_service_provider": "TOKEN_PROVIDER_VISA",
    "opaque_payment_card": "my_opc_base64..."
  },
  "card_credentials": {
    "google_opaque_payment_card": "google_opc_base64..."
  }
}

See all 23 lines

​ Check eligibility for Click to Pay for Mastercard

Action:GET Endpoint:/digitalwallets/clicktopay/mastercard/checkeligibilityUse this endpoint to check if a provided BIN prefix is eligible for Click to Pay for Mastercard.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ URL query parameters

​ Response body

​ Sample response body

JSON

{
  "is_eligible": true,
  "image_assets": [\
    {\
      "media_content": {\
        "type": "image/png",\
        "data": "iVBORw0KGgoAAAANSUhEUgAAAMAAAADACAYAAABS3GwHAAAAAXNSR0IArs4c6... (truncated for readability)",\
        "height": "192px",\
        "width": "192px"\
      }\
    },\
    {\
      "media_content": {\
        "type": "image/svg+xml",\
        "data": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3... (truncated for readability)",\
        "height": "192px",\
        "width": "192px"\
      }\
    }\
  ]
}

See all 21 lines

​ Enroll a card to Click to Pay for Mastercard

Action:POST Endpoint:/digitalwallets/clicktopay/mastercard/enrollUse this endpoint to enroll a card in Click to Pay for Mastercard.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ Request body

​ Sample request body

JSON

{
  "card_token": "my_card_token_1234",
  "user_token": "my_user_token_1234",
  "user_details": [\
    {\
      "email_address": "test@test.com",\
      "mobile_number": {\
        "country_code": "44",\
        "phone_number": "1234567890"\
      }\
    }\
  ],
  "locale_country": "US",
  "locale_language": "en"
}

See all 15 lines

​ Response body

​ Sample response body

JSON

{
  "token": "my_token_0000"
}

See all 3 lines

​ Retrieve Click to Pay for Mastercard enrollment status

Action:GET Endpoint:/digitalwallets/clicktopay/mastercard/status/{token}Use this endpoint to return the status of a specific Click to Pay for Mastercard request.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ URL path parameters

​ Response body

​ Sample response body

JSON

{
  "token": "my_token_0000",
  "status": "SUCCESS",
  "token_reference_id": "my_token_reference_id_1600"
}

See all 5 lines

​ Enroll a cardholder to Click to Pay for Visa

Action:POST Endpoint:/digitalwallets/clicktopay/visa/enrollUse this endpoint to enroll a new cardholder in Click to Pay for Visa.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ Request body

​ Sample request body

JSON

{
  "user": {
    "userToken": "1234567890",
    "firstName": "John",
    "lastName": "Smith",
    "email": "example@email.com",
    "phone": "111-111-1111",
    "locale": "en_US",
    "country": "USA"
  },
  "card": {
    "cardToken": "2345678910",
    "nameOnCard": "John Smith",
    "billingAddress": {
      "address1": "123 Elm Street",
      "address2": "APT 1",
      "city": "Oakland",
      "state": "CA",
      "country": "USA",
      "postalCode": "94607"
    }
  }
}

See all 23 lines

​ Response body

​ Sample response body

JSON

{
  "requestTraceId": "2b6f0cc904d137be2e1730235f5664094b83"
}

See all 3 lines

​ Enroll a card to Click to Pay for Visa

Action:POST Endpoint:/digitalwallets/clicktopay/visa/enrollcardsUse this endpoint to enroll a new card for an existing cardholder in Click to Pay for Visa.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ Request body

​ Sample request body

JSON

{
  "userToken": "1234567890",
  "card": {
    "cardToken": "2345678901",
    "nameOnCard": "John Smith",
    "billingAddress": {
      "address1": "123 Elm Street",
      "address2": "APT 1",
      "city": "Oakland",
      "state": "CA",
      "country": "USA",
      "postalCode": "94607"
    }
  }
}

See all 15 lines

​ Response body

​ Sample response body

JSON

{
  "requestTraceId": "2b6f0cc904d137be2e1730235f5664094b83"
}

See all 3 lines

​ Retrieve user data for Click to Pay for Visa

Action:GET Endpoint:/digitalwallets/clicktopay/visa/getdata/{user_token}Use this endpoint to get user data for Click to Pay for Visa.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ URL path parameters

​ Response body

​ Sample response body

JSON

{
  "data": [\
    {\
      "intent": {\
        "type": "PRODUCT_CODE",\
        "value": "CLICK_TO_PAY"\
      },\
      "paymentInstruments": [\
        {\
          "type": "CARD",\
          "status": "ACTIVE",\
          "cardType": "Visa Platinum",\
          "issuerName": "Bank A",\
          "nameOnCard": "John Doe",\
          "tokenDetails": {\
            "tokenReferenceID": "hflasdhflsdkfhoin3y038yfwn",\
            "tokenRequestorID": "1234567890"\
          },\
          "accountNumber": "4111111145551140",\
          "billingAddress": {\
            "city": "San Francisco",\
            "state": "CA",\
            "country": "USA",\
            "postalCode": "94105",\
            "addressLine1": "1000 Market Street",\
            "addressLine2": "Building 56",\
            "addressLine3": "Suite 101"\
          },\
          "expirationDate": "2030-01",\
          "panReferenceID": "alikbndesfiluwbn1342fs",\
          "paymentAccountReference": "paymentAccountReferenceValues"\
        }\
      ],\
      "consumerInformation": {\
        "emails": [\
          "alex123@hotmail.com"\
        ],\
        "locale": "en_US",\
        "phones": [\
          "16504005555"\
        ],\
        "status": "ACTIVE",\
        "consent": {\
          "version": "1.0",\
          "presenter": "Bank A",\
          "timeOfConsent": "2026-05-05T12:12:12.000Z"\
        },\
        "lastName": "Miller",\
        "firstName": "Alex",\
        "middleName": "Robert",\
        "countryCode": "USA",\
        "externalConsumerID": "63421837-d597-4f0f-89e4-930c1a7b9e85",\
        "nationalIdentifiers": [\
          {\
            "type": "PASSPORT",\
            "value": "A123456"\
          }\
        ]\
      }\
    }\
  ]
}

See all 62 lines

​ Update cardholder information for Click to Pay for Visa

Action:PUT Endpoint:/digitalwallets/clicktopay/visa/usersUse this endpoint to update cardholder information for Click to Pay for Visa.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ Request body

​ Sample request body

JSON

{
  "user": {
    "userToken": "1234567890",
    "firstName": "John",
    "lastName": "Smith",
    "email": "example@email.com",
    "phone": "111-111-1111",
    "locale": "en_US",
    "country": "USA"
  }
}

See all 11 lines

​ Response body

​ Sample response body

JSON

{
  "requestTraceId": "2b6f0cc904d137be2e1730235f5664094b83"
}

See all 3 lines

​ Delete cardholder information for Click to Pay for Visa

Action:DELETE Endpoint:/digitalwallets/clicktopay/visa/usersUse this endpoint to delete cardholder information for Click to Pay for Visa.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ Request body

​ Sample request body

JSON

{
  "userToken": "1234567890"
}

See all 3 lines

​ Response body

​ Sample response body

JSON

{
  "requestTraceId": "2b6f0cc904d137be2e1730235f5664094b83"
}

See all 3 lines

​ Update card information for Click to Pay for Visa

Action:PUT Endpoint:/digitalwallets/clicktopay/visa/cardsUse this endpoint to update card information for Click to Pay for Visa.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ Request body

​ Sample request body

JSON

See all 15 lines

​ Response body

​ Sample response body

JSON

{
  "requestTraceId": "2b6f0cc904d137be2e1730235f5664094b83"
}

See all 3 lines

​ Delete card information for Click to Pay for Visa

Action:DELETE Endpoint:/digitalwallets/clicktopay/visa/cards/{card_token}Use this endpoint to delete card information for Click to Pay for Visa.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ URL path parameters

​ Response body

​ Sample response body

JSON

{
  "requestTraceId": "2b6f0cc904d137be2e1730235f5664094b83"
}

See all 3 lines

​ Retrieve Click to Pay for Visa request status

Action:GET Endpoint:/digitalwallets/clicktopay/visa/status/{requestTraceId}Use this endpoint to return the status of a Click to Pay for Visa request.For more information about this ecommerce checkout solution, see Click to Pay.

​ Header parameter

​ URL path parameters

​ Response body

​ Sample response body

JSON

{
  "status": "IN_PROGRESS",
  "details": [\
    {\
      "intent": {\
        "type": "PRODUCT_CODE",\
        "value": "CLICK_TO_PAY"\
      },\
      "status": "SUCCESS",\
      "errorDetails": [\
        {\
          "field": "string",\
          "reason": "string",\
          "message": "string"\
        }\
      ]\
    }\
  ],
  "consumerInformation": {
    "externalConsumerID": "63421837-d597-4f0f-89e4-930c1a7b9e85",
    "externalConsumerIDOwnerBID": "10098765"
  }
}

See all 23 lines

​ Create a Visa Alias

Action:POST Endpoint:/digitalwallets/aliasdirectory/visa/aliasesUse this endpoint to create a Visa Alias.

​ Header parameter

​ Request body

​ Sample request body

JSON

{
  "aliasType": "PHONE",
  "userToken": "21267931-7975-4b61-be7a-86915883b2b4",
  "aliasValue": "1231231234",
  "consent": {
    "presenter": "Bank A",
    "validFromDateTime": "2024-12-01T10:00:00Z",
    "intermediaries": [\
      "Client A"\
    ],
    "version": "1.0",
    "expiryDateTime": "2027-06-20T10:00:00Z"
  },
  "paymentCredentials": [\
    {\
      "cardToken": "4111111145551142",\
      "billingAddress": {\
        "country": "USA",\
        "streetName": "12",\
        "city": "San Francisco",\
        "postalCode": "94105",\
        "addressLine1": "1000 Market Street",\
        "buildingNumber": "56",\
        "addressLine2": "Suite 101",\
        "state": "CA",\
        "minorSubdivisionCode": "CA"\
      },\
      "nameOnCard": "John Doe",\
      "cardType": "Visa Platinum",\
      "issuerName": "Bank A",\
      "currencyCode": "USD"\
    }\
  ],
  "profile": {
    "firstName": "Alex",
    "middleName": "Robert",
    "lastName": "Miller",
    "firstNameLocal": "Roberto",
    "middleNameLocal": "Alexander",
    "lastNameLocal": "Miller",
    "preferredName": "Miller's Shop",
    "dateOfBirth": "1980-02-01",
    "contactInfo": [\
      {\
        "type": "PHONE",\
        "value": "1231234321"\
      }\
    ]
  },
  "identification": {
    "type": "PASSPORT",
    "value": "A123456",
    "verificationDetails": {
      "verifiedPhone": false,
      "authMethodReference": "EXTERNAL, SMS OTP, Email OTP",
      "authDateTime": "2026-01-01T22:52:46.000Z",
      "verifiedEmail": true,
      "creationDateTime": "2026-01-01T22:52:46.000Z"
    }
  }
}

See all 61 lines

​ Response body

​ Sample response body

JSON

{
  "id": "1f4f5e10-bde6-46a7-b2aa-576550054981",
  "externalId": "21267931-7975-4b61-a-8691588sdfsdfa",
  "paymentCredentials": [\
    {\
      "type": "CARD",\
      "id": "19e538ea-edfb-4780-915e-2f6e02959e03",\
      "externalId": "1111111111111111"\
    }\
  ]
}

See all 11 lines

​ Retrieve Visa Alias by Visa Alias ID

Action:GET Endpoint:/digitalwallets/aliasdirectory/visa/aliases/{aliasId}Use this endpoint to retrieve a Visa Alias by its Visa Alias ID.

​ Header parameter

​ URL path parameters

​ Response body

​ Sample response body

JSON

{
  "aliasValue": "1231231234",
  "profile": {
    "lastName": "Miller",
    "firstName": "Alex",
    "middleName": "Robert",
    "contactInfo": [\
      {\
        "type": "PHONE",\
        "value": "1231234321"\
      }\
    ],
    "dateOfBirth": "1980-02-01",
    "lastNameLocal": "Miller",
    "preferredName": "Miller's Shop",
    "firstNameLocal": "Alexander",
    "middleNameLocal": "Roberto"
  },
  "aliasType": "PHONE",
  "consent": {
    "version": "1.0",
    "presenter": "Bank A",
    "expiryDateTime": "2025-06-20T10:00:00Z",
    "intermediaries": [\
      "Client A"\
    ],
    "validFromDateTime": "2024-12-01T10:00:00Z"
  },
  "identification": {
    "type": "PASSPORT",
    "value": "A123456",
    "verificationDetails": {
      "authDateTime": "2026-01-01T22:52:46Z",
      "verifiedEmail": true,
      "verifiedPhone": false,
      "creationDateTime": "2026-01-01T22:52:46Z",
      "authMethodReference": "EXTERNAL, SMS OTP, Email OTP"
    }
  },
  "createdOn": "2026-01-01T22:52:46.000Z",
  "lastModifiedOn": "2026-01-01T22:52:46.000Z",
  "status": "ACTIVE"
}

See all 43 lines

​ Update Visa Alias by Visa Alias ID

Action:PUT Endpoint:/digitalwallets/aliasdirectory/visa/aliases/{aliasId}Use this endpoint to update a Visa Alias by its Visa Alias ID.

​ Header parameter

​ URL path parameters

​ Request body

​ Sample request body

JSON

{
  "aliasValue": "1231231234",
  "aliasType": "PHONE",
  "profile": {
    "firstName": "Alex",
    "middleName": "Robert",
    "lastName": "Miller",
    "firstNameLocal": "Alexander",
    "middleNameLocal": "Roberto",
    "lastNameLocal": "Miller",
    "preferredName": "Miller's Shop",
    "dateOfBirth": "1980-02-01",
    "contactInfo": [\
      {\
        "type": "PHONE",\
        "value": "1231234321"\
      }\
    ]
  },
  "consent": {
    "version": "1.0",
    "presenter": "Bank A",
    "validFromDateTime": "2024-12-01T10:00:00Z",
    "expiryDateTime": "2025-06-20T10:00:00Z",
    "intermediaries": [\
      "Client A"\
    ]
  },
  "identification": {
    "type": "PASSPORT",
    "value": "A123456",
    "verificationDetails": {
      "authDateTime": "2026-01-01T22:52:46Z",
      "verifiedEmail": true,
      "verifiedPhone": false,
      "creationDateTime": "2026-01-01T22:52:46Z",
      "authMethodReference": "EXTERNAL, SMS OTP, Email OTP"
    }
  },
  "createdOn": "2026-01-01T22:52:46Z",
  "lastModifiedOn": "2026-01-01T22:52:46Z",
  "status": "ACTIVE"
}

See all 43 lines

​ Delete Visa Alias by Visa Alias ID

Action:DELETE Endpoint:/digitalwallets/aliasdirectory/visa/aliases/{aliasId}Use this endpoint to delete a Visa Alias by Visa Alias ID.

​ Header parameter

​ URL path parameters

​ Retrieve alias internal ID

Action:POST Endpoint:/digitalwallets/aliasdirectory/visa/aliases/aliasIdUse this endpoint to retrieve the internal ID associated with a Visa Alias.

​ Header parameter

​ Request body

​ Sample request body

JSON

{
  "aliasValue": "my_alias_value_1234"
}

See all 3 lines

​ Response body

​ Sample response body

JSON

{
  "id": "my_alias_id_1234"
}

See all 3 lines

​ Update alias status

Action:PUT Endpoint:/digitalwallets/aliasdirectory/visa/aliases/{aliasId}/statusUse this endpoint to update the status of a Visa Alias.

​ Header parameter

​ URL path parameters

​ Request body

​ Sample request body

JSON

{
  "status": "ACTIVE"
}

See all 3 lines

​ Create Visa Alias payment credential

Action:POST Endpoint:/digitalwallets/aliasdirectory/visa/aliases/{aliasId}/cardsUse this endpoint to create a payment credential associated with a Visa Alias.

​ Header parameter

​ URL path parameters

​ Request body