openapi: 3.0.3 info: contact: email: support@marqeta.com name: Marqeta description: Marqeta's Core API endpoints, conveniently annotated to enable code generation (including SDKs), test cases, and documentation. Currently in beta. termsOfService: https://www.marqeta.com/api-terms title: Core accepted countries Digital Wallets Management API version: 3.0.39 servers: - url: /v3 security: - mqAppAndAccessToken: [] tags: - description: '// Conditional snippet for beta or internal content include::../../maturity-admonition-banner.adoc[] 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 <>.' name: Digital Wallets Management paths: /digitalwalletprovisionrequests/androidpay: post: description: 'Use 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 PCI compliance overhead.' operationId: postDigitalwalletprovisionrequestsAndroidpay requestBody: content: application/json: example: card_token: my_card_token_0987 device_id: my_device_id_r51j device_type: MOBILE_PHONE provisioning_app_version: 2.13.3 wallet_account_id: my_wallet_account_id_sr51 schema: $ref: '#/components/schemas/digital_wallet_android_pay_provision_request' required: false responses: '201': content: application/json: example: card_token: my_card_token_1111 created_time: 2024-11-06 22:43:20+00:00 last_modified_time: 2024-11-06 22:43:20+00:00 push_tokenize_request_data: display_name: Visa Card last_digits: '3264' network: Visa opaque_payment_card: my_opaque_payment_card_RUza... token_service_provider: TOKEN_PROVIDER_VISA user_address: address1: 180 Grand Ave address2: Suite 500 city: Oakland country: US name: John Doe phone: '5105551212' postal_code: '94612' state: CA schema: $ref: '#/components/schemas/digital_wallet_android_pay_provision_response' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Card not found '500': content: {} description: Server error summary: Create digital wallet token provisioning request for Google Wallet tags: - Digital Wallets Management /digitalwalletprovisionrequests/applepay: post: description: 'Use 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 PCI compliance overhead.' operationId: postDigitalwalletprovisionrequestsApplepay requestBody: content: application/json: example: card_token: my_card_token_1234 certificates: - my_certificate_ZIzj... - my_certificate_SgMA... device_type: MOBILE_PHONE nonce: my_nonce_JJCF nonce_signature: my_nonce_signature_wbBn provisioning_app_version: 2.13.7 schema: $ref: '#/components/schemas/digital_wallet_apple_pay_provision_request' required: false responses: '201': content: application/json: example: activation_data: my_activation_data_VERF... card_token: my_card_token_1234 created_time: 2025-03-22 21:22:19+00:00 encrypted_pass_data: my_encrypted_pass_data_KGga... ephemeral_public_key: my_ephemeral_public_key_omvw... last_modified_time: 2025-03-22 21:22:19+00:00 schema: $ref: '#/components/schemas/digital_wallet_apple_pay_provision_response' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Card not found '500': content: {} description: Server error summary: Create digital wallet token provisioning request for Apple Wallet tags: - Digital Wallets Management /digitalwalletprovisionrequests/samsungpay: post: description: '[NOTE] 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 PCI compliance overhead.' operationId: postDigitalwalletprovisionrequestsSamsungpay requestBody: content: application/json: schema: $ref: '#/components/schemas/digital_wallet_samsung_pay_provision_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/digital_wallet_samsung_pay_provision_response' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Card not found '500': content: {} description: Server error summary: Create digital wallet token provisioning request for Samsung Wallet tags: - Digital Wallets Management /digitalwalletprovisionrequests/xpay: post: description: '[NOTE] 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 PCI compliance overhead.' operationId: postDigitalwalletprovisionrequestsXPay requestBody: content: application/json: schema: $ref: '#/components/schemas/digital_wallet_x_pay_provision_request' required: false responses: '201': content: application/json: schema: $ref: '#/components/schemas/digital_wallet_x_pay_provision_response' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Card not found '500': content: {} description: Server error summary: Create digital wallet token provisioning request for XPay tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/additionalAliases/{additionalAliasId}: delete: description: Use this endpoint to delete an additional Visa Alias by its Visa Alias ID. operationId: deleteAdditionalAliasById parameters: - description: Unique identifier of the additional Visa Aliases. example: a44c9553-e687-4f3c-b7e7-a4245d9f238e explode: false in: path name: additionalAliasId required: true schema: type: string x-allowableValues: Existing additional Visa Alias ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '204': description: Success '404': description: Not found '500': description: Internal server error summary: Delete an additional Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases: post: description: Use this endpoint to create a Visa Alias. operationId: createAlias parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliasType: PHONE aliasValue: '1231231234' consent: expiryDateTime: 2027-06-20 10:00:00+00:00 intermediaries: - Client A presenter: Bank A validFromDateTime: 2024-12-01 10:00:00+00:00 version: '1.0' identification: type: PASSPORT value: A123456 verificationDetails: authDateTime: 2025-01-01 22:52:46+00:00 authMethodReference: EXTERNAL, SMS OTP, Email OTP creationDateTime: 2025-01-01 22:52:46+00:00 verifiedEmail: true verifiedPhone: false paymentCredentials: - billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: '56' city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: '12' cardToken: '4111111145551142' cardType: Visa Platinum currencyCode: USD issuerName: Bank A nameOnCard: John Doe profile: contactInfo: - type: PHONE value: '1231234321' dateOfBirth: 1980-02-01 firstName: Alex firstNameLocal: Roberto lastName: Miller lastNameLocal: Miller middleName: Robert middleNameLocal: Alexander preferredName: Miller's Shop userToken: 21267931-7975-4b61-be7a-86915883b2b4 schema: $ref: '#/components/schemas/ads_create_alias_request' required: true responses: '200': content: application/json: example: externalId: 21267931-7975-4b61-a-8691588sdfsdfa id: 1f4f5e10-bde6-46a7-b2aa-576550054981 paymentCredentials: - externalId: '1111111111111111' id: 19e538ea-edfb-4780-915e-2f6e02959e03 type: CARD schema: $ref: '#/components/schemas/ads_create_alias_response' description: Success '400': description: User input error/Bad request '422': description: Unprocessable entity '500': description: Internal server error summary: Create a Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/aliasId: post: description: Use this endpoint to retrieve the internal ID associated with a Visa Alias. operationId: getAliasIdByValue parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliasValue: my_alias_value_1234 schema: properties: aliasValue: description: 'Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included.' maxLength: 128 minLength: 1 type: string required: true responses: '200': content: application/json: example: id: my_alias_id_1234 schema: properties: id: description: UUID generated by Alias Directory, which identifies the Visa Alias. maxLength: 128 minLength: 1 type: string description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve alias internal ID tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/getByExternalId: post: description: Use this endpoint to retrieve a Visa Alias by its external ID. operationId: getAliasByExternalId parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: externalId: 21267931-7975-4b61-be7a-86915883b2b4 type: ALIAS schema: $ref: '#/components/schemas/ads_get_by_external_id_request' required: true responses: '200': content: application/json: example: associatedIds: - id: a44c9553-e687-4f3c-b7e7-a4245d9f238e type: PAYMENT_CREDENTIAL id: e336c8c8-2945-4be3-af3e-951ec2d01219 schema: $ref: '#/components/schemas/ads_get_by_external_id_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve Visa Alias by external ID tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/inquiry: post: description: 'Use this endpoint to check for available Visa Aliases for alias resolution. One or more Visa Aliases may be available.' operationId: inquireAliasAvailability parameters: - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliases: - '123456' filters: - field: DIRECTORY_NAME value: - DIRECTORY_A - DIRECTORY_B - DIRECTORY_C transactionDetails: currencyCode: USD userDetails: userName: johndoe313 schema: $ref: '#/components/schemas/ads_alias_inquiry_request' required: true responses: '200': content: application/json: example: - details: - aliasType: PHONE aliasValue: '123456' directories: - directoryName: DIRECTORY_A entities: - id: '1101' - id: '1102' preferredFor: - date: 1980-02-01 type: RECEIVE - directoryName: DIRECTORY_B directoriesName: - DIRECTORY_A - DIRECTORY_B summary: aliasesFound: 1 aliasesNotFound: 0 aliasesRepeated: 0 aliasesTotal: 1 schema: items: $ref: '#/components/schemas/ads_alias_inquiry_response' type: array description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Check for Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/resolve: post: description: Retrieve information about a Visa Alias and all the associated payment credentials. operationId: resolveAlias parameters: - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliasType: PHONE aliasValue: '1231231234' filters: - field: DIRECTORY_NAME value: - DIRECTORY_A - DIRECTORY_B - DIRECTORY_C transactionDetails: currencyCode: USD userDetails: userName: username1234 schema: $ref: '#/components/schemas/ads_alias_resolve_request' required: true responses: '200': content: application/json: example: - directoryName: DIRECTORY_A identification: type: PASSPORT value: A123456 verificationDetails: authDateTime: 2021-01-01 22:52:46+00:00 authMethodReference: EXTERNAL, SMS OTP, Email OTP creationDateTime: 2021-01-01 22:52:46+00:00 verifiedEmail: true verifiedPhone: false paymentCredentials: - accountNumber: '4111111145551142' accountNumberType: TOKEN billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: '56' city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: '12' cardType: Visa Platinum currencyCode: USD expirationDate: 2026-01 issuerName: Bank A lastFourDigits: '1142' modifiedOn: 2021-01-01 22:52:46+00:00 nameOnCard: Alex Miller preferredFor: - date: 2021-01-01 type: RECEIVE type: CARD profile: contactInfo: - type: PHONE value: '1231234321' dateOfBirth: 1980-02-01 firstName: Alex firstNameLocal: Alexander lastName: Miller lastNameLocal: Miller middleName: Robert middleNameLocal: Roberto preferredName: Miller's Shop schema: items: $ref: '#/components/schemas/ads_alias_resolve_response' type: array description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Resolve a Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/{aliasId}: delete: description: Use this endpoint to delete a Visa Alias by Visa Alias ID. operationId: deleteAliasById parameters: - description: Unique identifier of the Visa Alias. example: a44c9553-e687-4f3c-b7e7-a4245d9f238e explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '204': description: Success '404': description: Not found '500': description: Internal server error summary: Delete Visa Alias by Visa Alias ID tags: - Digital Wallets Management get: description: Use this endpoint to retrieve a Visa Alias by its Visa Alias ID. operationId: getAliasById parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '200': content: application/json: example: aliasType: PHONE aliasValue: '1231231234' consent: expiryDateTime: 2025-06-20 10:00:00+00:00 intermediaries: - Client A presenter: Bank A validFromDateTime: 2024-12-01 10:00:00+00:00 version: '1.0' createdOn: 2025-01-01 22:52:46+00:00 identification: type: PASSPORT value: A123456 verificationDetails: authDateTime: 2025-01-01 22:52:46+00:00 authMethodReference: EXTERNAL, SMS OTP, Email OTP creationDateTime: 2025-01-01 22:52:46+00:00 verifiedEmail: true verifiedPhone: false lastModifiedOn: 2025-01-01 22:52:46+00:00 profile: contactInfo: - type: PHONE value: '1231234321' dateOfBirth: 1980-02-01 firstName: Alex firstNameLocal: Alexander lastName: Miller lastNameLocal: Miller middleName: Robert middleNameLocal: Roberto preferredName: Miller's Shop status: ACTIVE schema: $ref: '#/components/schemas/ads_alias_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve Visa Alias by Visa Alias ID tags: - Digital Wallets Management put: description: Use this endpoint to update a Visa Alias by its Visa Alias ID. operationId: updateAliasById parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: aliasType: PHONE aliasValue: '1231231234' consent: expiryDateTime: 2025-06-20 10:00:00+00:00 intermediaries: - Client A presenter: Bank A validFromDateTime: 2024-12-01 10:00:00+00:00 version: '1.0' createdOn: 2025-01-01 22:52:46+00:00 identification: type: PASSPORT value: A123456 verificationDetails: authDateTime: 2025-01-01 22:52:46+00:00 authMethodReference: EXTERNAL, SMS OTP, Email OTP creationDateTime: 2025-01-01 22:52:46+00:00 verifiedEmail: true verifiedPhone: false lastModifiedOn: 2025-01-01 22:52:46+00:00 profile: contactInfo: - type: PHONE value: '1231234321' dateOfBirth: 1980-02-01 firstName: Alex firstNameLocal: Alexander lastName: Miller lastNameLocal: Miller middleName: Robert middleNameLocal: Roberto preferredName: Miller's Shop status: ACTIVE schema: $ref: '#/components/schemas/ads_update_alias_request' required: true responses: '204': description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Update Visa Alias by Visa Alias ID tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/{aliasId}/additionalAlias: post: description: Use this endpoint to create additional Visa Aliases associated with an existing main Visa Alias. operationId: createAdditionalAliases parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: type: EMAIL value: '1231231234' schema: $ref: '#/components/schemas/ads_create_additional_aliases_request' required: true responses: '200': content: application/json: example: id: my_alias_id_1234 schema: $ref: '#/components/schemas/ads_create_additional_alias_response' description: Success '400': description: User input error/Bad request '422': description: Unprocessable entity '500': description: Internal server error summary: Create an additional Visa Alias tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/{aliasId}/cards: get: description: Use this endpoint to retrieve a list of payment credentials associated with a Visa Alias. operationId: getCardsByAlias parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '200': content: application/json: example: accountNumber: 4111111145551142 accountNumberType: TOKEN billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: 56 city: San Francisco country: USA minorSubdivisionCode: CA postalCode: 94105 state: CA streetName: 12 cardType: Visa Platinum createdOn: 2025-06-21 13:00:00+00:00 currencyCode: USD expirationDate: 2026-01 externalId: 63421837-d597-4f0f-89e4-930c1a7b9e85 id: a44c9553-e687-4f3c-b7e7-a4245d9f238e issuerName: Bank A lastFourDigits: 1142 lastUpdatedOn: 2025-06-22 15:12:00+00:00 nameOnCard: Alex Miller preferredFor: - date: 2025-01-01 type: RECEIVE status: ACTIVE type: CARD schema: $ref: '#/components/schemas/ads_cards_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve a Visa Alias payment credentials tags: - Digital Wallets Management post: description: Use this endpoint to create a payment credential associated with a Visa Alias. operationId: createCardByAlias parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: '56' city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: '12' cardToken: '4111111145551142' cardType: Visa Platinum currencyCode: USD issuerName: Bank A nameOnCard: John Doe preferredFor: - RECEIVE - SEND schema: $ref: '#/components/schemas/ads_card_details_request' required: true responses: '200': content: application/json: example: externalId: 63421837-d597-4f0f-89e4-930c1a7b9e85 id: a44c9553-e687-4f3c-b7e7-a4245d9f238e type: CARD schema: $ref: '#/components/schemas/ads_create_card_details_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Create Visa Alias payment credential tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/aliases/{aliasId}/status: put: description: Use this endpoint to update the status of a Visa Alias. operationId: updateAliasStatus parameters: - description: Unique identifier of the Visa Alias. explode: false in: path name: aliasId required: true schema: type: string x-allowableValues: Existing Visa Alias ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: status: ACTIVE schema: properties: status: description: Status of the Visa Alias. type: string required: true responses: '204': description: Success '400': description: User input error/Bad request '404': description: Not found '422': description: Unprocessable entity '500': description: Internal server error summary: Update alias status tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/cards/{paymentCredentialId}: delete: description: Use this endpoint to delete an existing payment credential. operationId: deletePaymentCredential parameters: - description: Unique identifier of an existing payment credential. example: '1234567890' explode: false in: path name: paymentCredentialId required: true schema: type: string x-allowableValues: Existing payment credential ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '204': description: Success '404': description: Not found '500': description: Internal server error summary: Delete an existing payment credential tags: - Digital Wallets Management get: description: Use this endpoint to retrieve an existing payment credential. operationId: getCardByCardToken parameters: - description: Unique identifier of an existing payment credential. explode: false in: path name: paymentCredentialId required: true schema: type: string x-allowableValues: Existing payment credential ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '200': content: application/json: example: accountNumber: '4111111145551142' accountNumberType: TOKEN billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: 56 city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: 12 cardType: Visa Platinum createdOn: 2025-06-21 13:00:00.645000+00:00 currencyCode: USD expirationDate: 2026-01 externalId: 63421837-d597-4f0f-89e4-930c1a7b9e85 id: a44c9553-e687-4f3c-b7e7-a4245d9f238e issuerName: Bank A lastFourDigits: 1142 lastUpdatedOn: 2025-06-22 15:12:00.322000+00:00 nameOnCard: Alex Miller preferredFor: - date: 2025-01-01 type: RECEIVE status: ACTIVE type: CARD schema: $ref: '#/components/schemas/ads_cards_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve payment credential tags: - Digital Wallets Management put: description: Use this endpoint to update an existing payment credential. operationId: updatePaymentCredential parameters: - description: Unique identifier of an existing payment credential. explode: false in: path name: paymentCredentialId required: true schema: type: string x-allowableValues: Existing payment credential ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: billingAddress: addressLine1: 1000 Market Street addressLine2: Suite 101 buildingNumber: '56' city: San Francisco country: USA minorSubdivisionCode: CA postalCode: '94105' state: CA streetName: '12' cardToken: '4111111145551142' cardType: Visa Platinum currencyCode: USD issuerName: Bank A nameOnCard: John Doe preferredFor: - RECEIVE - SEND schema: $ref: '#/components/schemas/ads_card_details_request' required: true responses: '204': description: Success '400': description: User input error/Bad request '404': description: Not found '422': description: Unprocessable entity '500': description: Internal server error summary: Update payment credential tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/reports: post: description: Use this endpoint to create a new report request. operationId: createReport parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple requestBody: content: application/json: example: filters: aliasStatuses: - ACTIVE aliasType: PHONE billingEventTypes: - createAlias endDate: 2025-01-01 22:52:46+00:00 startDate: 2025-01-01 22:52:46+00:00 format: JSON reportType: PLATFORM_REQUESTS schema: $ref: '#/components/schemas/ads_create_report_request' required: true responses: '200': content: application/json: example: reportId: my_report_id_1234 schema: properties: reportId: description: Unique identifier of the report. maxLength: 36 type: string description: Success '400': description: User input error/Bad request '422': description: Unprocessable entity '500': description: Internal server error summary: Create a report request tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/reports/{reportId}: get: description: Use this endpoint to retrieve the status of a report by its report ID. operationId: getReportById parameters: - description: Unique identifier of the report. explode: false in: path name: reportId required: true schema: type: string x-allowableValues: Existing report ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '200': content: application/json: example: creationDateTime: 2025-01-01 22:52:46+00:00 dataClassification: VERY_IMPORTANT expirationDateTime: 2025-01-01 22:52:46+00:00 fileIds: - 000001-a96032e1-0ad9-4937-9320-a2a28b139ea5, 000002-a96032e1-0ad9-4937-9320-a2a28b139ea5 format: JSON id: a77ef5c5-c972-467b-9a11-ac550183b495 reportType: PLATFORM_REQUESTS status: COMPLETED schema: $ref: '#/components/schemas/ads_get_report_status_response' description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve report status by report ID tags: - Digital Wallets Management /digitalwallets/aliasdirectory/visa/reports/{reportId}/file/{fileId}: get: description: Use this endpoint to retrieve a file by its file ID and report ID. operationId: getFileByReportAndFileId parameters: - description: Unique identifier of the report. explode: false in: path name: reportId required: true schema: type: string x-allowableValues: Existing report ID style: simple - description: Unique identifier of the file. explode: false in: path name: fileId required: true schema: type: string x-allowableValues: Existing file ID style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) that is assigned to the program. example: '123456789001' explode: false in: header name: participant-id required: true schema: type: string style: simple responses: '200': content: application/json: example: - operationType: resolveAlias operationsCount: 18 originatorActorId: 012af73f-44d8-4c9c-bbee-628b07faae1c programId: baf85624-3cf6-4c52-b91f-b8f3493e7330 statusCode: 200 schema: items: $ref: '#/components/schemas/ads_report_file_response' type: array description: Success '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve file by file ID and report ID tags: - Digital Wallets Management /digitalwallets/clicktopay/mastercard/checkeligibility: get: description: 'Use 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 <>.' operationId: getClicktopayMastercardCheckeligibility parameters: - description: Prefix of the bank identification number. explode: true in: query name: bin_prefix required: true schema: type: string x-allowableValues: 'A six- to nine-digit number *NOTE:* It is preferable to use eight- or nine-digit BIN prefixes in production environments. Contact your Marqeta representative for the appropriate value to use.' style: form - description: Returns a list of image assets for the Click to Pay logo if set to `true`. explode: true in: query name: include_asset required: false schema: default: false type: boolean x-allowableValues: '`true`, `false`' style: form - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '200': content: application/json: example: image_assets: - media_content: data: iVBORw0KGgoAAAANSUhEUgAAAMAAAADACAYAAABS3GwHAAAAAXNSR0IArs4c6... (truncated for readability) height: 192px type: image/png width: 192px - media_content: data: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3... (truncated for readability) height: 192px type: image/svg+xml width: 192px is_eligible: true schema: $ref: '#/components/schemas/click_to_pay_check_eligibility_response' description: Eligibility check successful '400': description: Invalid binPrefix or other validation error '500': description: Internal server error summary: Check eligibility for Click to Pay for Mastercard tags: - Digital Wallets Management /digitalwallets/clicktopay/mastercard/enroll: post: description: 'Use this endpoint to enroll a card in Click to Pay for Mastercard. For more information about this ecommerce checkout solution, see <>.' operationId: postClicktopayMastercardEnroll parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: example: card_token: my_card_token_1234 locale_country: US locale_language: en user_details: - email_address: test@test.com mobile_number: country_code: '44' phone_number: '1234567890' user_token: my_user_token_1234 schema: $ref: '#/components/schemas/click_to_pay_enroll_request' required: true responses: '201': content: application/json: example: token: my_token_0000 schema: $ref: '#/components/schemas/click_to_pay_enroll_response' description: Enrollment Request Accepted '400': description: Invalid request or other validation error '500': description: Internal server error summary: Enroll a card to Click to Pay for Mastercard tags: - Digital Wallets Management /digitalwallets/clicktopay/mastercard/status/{token}: get: description: '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 <>.' operationId: getClicktopayMastercardStatusToken parameters: - description: Unique identifier of the Click to Pay request. explode: false in: path name: token required: true schema: type: string x-allowableValues: Existing Click to Pay request token style: simple - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '200': content: application/json: example: status: SUCCESS token: my_token_0000 token_reference_id: my_token_reference_id_1600 schema: $ref: '#/components/schemas/click_to_pay_status_response' description: Status retrieval successful '404': description: No provision request found with the token '500': description: Internal server error summary: Retrieve Click to Pay for Mastercard enrollment status tags: - Digital Wallets Management /digitalwallets/clicktopay/visa/cards: put: description: 'Use this endpoint to update card information for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>.' operationId: updateCardInfo parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. explode: false in: header name: external-consumer-id-owner-bid required: true schema: maxLength: 8 minLength: 1 type: string style: simple requestBody: content: application/json: example: card: billingAddress: address1: 123 Elm Street address2: APT 1 city: Oakland country: USA postalCode: '94607' state: CA cardToken: '2345678901' nameOnCard: John Smith userToken: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_update_card_request' required: true responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Update card information for Click to Pay for Visa tags: - Digital Wallets Management /digitalwallets/clicktopay/visa/cards/{card_token}: delete: description: 'Use this endpoint to delete card information for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>.' operationId: deleteCardInfo parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. explode: false in: header name: external-consumer-id-owner-bid required: true schema: maxLength: 8 minLength: 1 type: string style: simple - description: Unique identifier of the cardholder. example: '2345678901' explode: false in: path name: card_token required: true schema: maxLength: 36 minLength: 1 type: string style: simple responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Delete card information for Click to Pay for Visa tags: - Digital Wallets Management /digitalwallets/clicktopay/visa/enroll: post: description: 'Use this endpoint to enroll a new cardholder in Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>.' operationId: enrollCardholder parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. explode: false in: header name: external-consumer-id-owner-bid required: true schema: maxLength: 8 minLength: 1 type: string style: simple requestBody: content: application/json: example: card: billingAddress: address1: 123 Elm Street address2: APT 1 city: Oakland country: USA postalCode: '94607' state: CA cardToken: '2345678910' nameOnCard: John Smith user: country: USA email: example@email.com firstName: John lastName: Smith locale: en_US phone: 111-111-1111 userToken: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_enroll_request' required: true responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Enroll a cardholder to Click to Pay for Visa tags: - Digital Wallets Management /digitalwallets/clicktopay/visa/enrollcards: post: description: 'Use 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 <>.' operationId: enrollCard parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. explode: false in: header name: external-consumer-id-owner-bid required: true schema: maxLength: 8 minLength: 1 type: string style: simple requestBody: content: application/json: example: card: billingAddress: address1: 123 Elm Street address2: APT 1 city: Oakland country: USA postalCode: '94607' state: CA cardToken: '2345678901' nameOnCard: John Smith userToken: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_enroll_cards_request' required: true responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Enroll a card to Click to Pay for Visa tags: - Digital Wallets Management /digitalwallets/clicktopay/visa/getdata/{user_token}: get: description: 'Use this endpoint to get user data for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>.' operationId: getUserData parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Unique identifier of the cardholder. example: '1234567890' explode: false in: path name: user_token required: true schema: type: string x-allowableValues: Existing Visa Click To Pay User Token style: simple - description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. explode: false in: header name: external-consumer-id-owner-bid required: true schema: maxLength: 8 minLength: 1 type: string style: simple responses: '200': content: application/json: example: data: - consumerInformation: consent: presenter: Bank A timeOfConsent: 2020-05-05 12:12:12+00:00 version: '1.0' countryCode: USA emails: - alex123@hotmail.com externalConsumerID: 63421837-d597-4f0f-89e4-930c1a7b9e85 firstName: Alex lastName: Miller locale: en_US middleName: Robert nationalIdentifiers: - type: PASSPORT value: A123456 phones: - '16504005555' status: ACTIVE intent: type: PRODUCT_CODE value: CLICK_TO_PAY paymentInstruments: - accountNumber: '4111111145551140' billingAddress: addressLine1: 1000 Market Street addressLine2: Building 56 addressLine3: Suite 101 city: San Francisco country: USA postalCode: '94105' state: CA cardType: Visa Platinum expirationDate: 2030-01 issuerName: Bank A nameOnCard: John Doe panReferenceID: alikbndesfiluwbn1342fs paymentAccountReference: paymentAccountReferenceValues status: ACTIVE tokenDetails: tokenReferenceID: hflasdhflsdkfhoin3y038yfwn tokenRequestorID: '1234567890' type: CARD schema: $ref: '#/components/schemas/visa_click_to_pay_get_user_data_response' description: OK '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve user data for Click to Pay for Visa tags: - Digital Wallets Management /digitalwallets/clicktopay/visa/status/{requestTraceId}: get: description: 'Use this endpoint to return the status of a Click to Pay for Visa request. For more information about this ecommerce checkout solution, see <>.' operationId: getStatus parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Unique identifier of the Visa Click to Pay request. example: 2b6f0cc904d137be2e1730235f5664094b83 explode: false in: path name: requestTraceId required: true schema: maxLength: 36 minLength: 1 type: string style: simple - description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. explode: false in: header name: external-consumer-id-owner-bid required: true schema: maxLength: 8 minLength: 1 type: string style: simple responses: '200': content: application/json: example: consumerInformation: externalConsumerID: 63421837-d597-4f0f-89e4-930c1a7b9e85 externalConsumerIDOwnerBID: '10098765' details: - errorDetails: - field: string message: string reason: string intent: type: PRODUCT_CODE value: CLICK_TO_PAY status: SUCCESS status: IN_PROGRESS schema: $ref: '#/components/schemas/visa_click_to_pay_status_response' description: OK '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Retrieve Click to Pay for Visa request status tags: - Digital Wallets Management /digitalwallets/clicktopay/visa/users: delete: description: 'Use this endpoint to delete cardholder information for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>.' operationId: deleteCardHolderInfo parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Delete cardholder information for Click to Pay for Visa tags: - Digital Wallets Management put: description: 'Use this endpoint to update cardholder information for Click to Pay for Visa. For more information about this ecommerce checkout solution, see <>.' operationId: updateCardHolderInfo parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple - description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. explode: false in: header name: external-consumer-id-owner-bid required: true schema: maxLength: 8 minLength: 1 type: string style: simple requestBody: content: application/json: example: user: country: USA email: example@email.com firstName: John lastName: Smith locale: en_US phone: 111-111-1111 userToken: '1234567890' schema: $ref: '#/components/schemas/visa_click_to_pay_update_cardholder_request' required: true responses: '202': content: application/json: example: requestTraceId: 2b6f0cc904d137be2e1730235f5664094b83 schema: $ref: '#/components/schemas/visa_click_to_pay_response' description: Accepted '400': description: User input error/Bad request '404': description: Not found '500': description: Internal server error summary: Update cardholder information for Click to Pay for Visa tags: - Digital Wallets Management /digitalwallets/postTokenizationAuthenticationDecision: post: description: 'Use 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 MDES in real time. Marqeta then returns the MDES response back to the customer synchronously. This enables issuers to notify Mastercard Digital Enablement Service (MDES) of the cardholder''s authentication outcome following tokenization, ensuring that the token requestor receives timely and accurate decisioning.' operationId: postTokenizationAuthenticationDecision requestBody: content: application/json: schema: $ref: '#/components/schemas/PostTokenizationAuthenticationDecisionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PostTokenizationAuthenticationDecisionResponse' description: Successful response summary: Submit a post-tokenization authentication decision tags: - Digital Wallets Management /digitalwallets/wpp/applePayJWT: post: description: Use this endpoint to add a card to Apple Wallet via a web application. operationId: generateApplePayWPPJWT parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/request_for_apple_pay_wpp_JWT' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/web_push_provisioning_apple_pay_JWT_response' description: Ok headers: req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false schema: type: string style: simple '400': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Bad request headers: req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false schema: type: string style: simple '401': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Unauthorized headers: req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false schema: type: string style: simple '500': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Internal Server Error headers: req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false schema: type: string style: simple summary: Create request for Apple Wallet web push provisioning tags: - Digital Wallets Management /digitalwallets/wpp/googlePayPushProvisioningNotification: post: description: 'Use 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.' operationId: sendOPCDataToGooglePay parameters: - description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' example: 123d837e-958a-4e9f-bc97-4843ec948123 explode: false in: header name: req-sys-id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/sending_provisioning_data_to_google_pay_backend_request' required: true responses: '202': content: {} description: Accepted headers: req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false schema: type: string style: simple '400': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Bad request headers: req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false schema: type: string style: simple '401': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Unauthorized headers: req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false schema: type: string style: simple '500': content: application/json: schema: $ref: '#/components/schemas/error_message_from_web_push_provisioning_request' description: Internal Server Error headers: req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' explode: false schema: type: string style: simple summary: Create request for Google Wallet web push provisioning tags: - Digital Wallets Management /digitalwallettokens: get: description: Use this endpoint to retrieve a list of digital wallet tokens. operationId: getDigitalwallettokens parameters: - description: Number of digital wallet token resources to retrieve. explode: true in: query name: count required: false schema: default: 10 format: int32 maximum: 100 minimum: 1 type: integer style: form - description: Sort order index of the first digital wallet token resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: 'Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields.' explode: true in: query name: fields required: false schema: type: string style: form - description: 'Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order.' explode: true in: query name: sort_by required: false schema: default: -id type: string style: form - description: Date when the digital wallet token becomes active. explode: true in: query name: start_date required: false schema: type: string style: form - description: Expiration date of the digital wallet token. explode: true in: query name: end_date required: false schema: type: string style: form - description: 'Unique identifier of the digital wallet token primary account number (PAN) within the card network. This value may vary, depending on the digital wallet. For example, the `pan_reference_id` may be different in Apple Wallet and Google Wallet for the same digital wallet token.' explode: true in: query name: pan_reference_id required: false schema: type: string style: form - description: 'Unique identifier of the digital wallet token within the card network. The `token_reference_id` is unique at the card network level.' explode: true in: query name: token_reference_id required: false schema: type: string style: form - description: Unique value representing a tokenization request (Mastercard only). explode: true in: query name: correlation_id required: false schema: type: string style: form - description: Comma-delimited list of digital wallet token types to display. explode: true in: query name: token_type required: false schema: type: string style: form - description: 'Name of the token requestor within the card network. *NOTE:* The list of example values for this field is maintained by the card networks and is subject to change.' explode: true in: query name: token_requestor_name required: false schema: type: string style: form - description: Comma-delimited list of digital wallet token states to display. explode: true in: query name: state required: false schema: type: string style: form - description: An optional embedded user object. explode: true in: query name: embed required: false schema: enum: - user type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/DigitalWalletTokenListResponse' description: Success '400': content: {} description: User input error/Bad request '500': content: {} description: Server error summary: List digital wallet tokens tags: - Digital Wallets Management /digitalwallettokens/card/{card_token}: get: description: 'Use this endpoint to return an array of all digital wallet tokens for a particular card. This endpoint supports <>.' operationId: getDigitalwallettokensCardCardtoken parameters: - description: 'Unique identifier of the card. Used to minimize the need to exchange card details during subsequent calls, and also for troubleshooting.' explode: false in: path name: card_token required: true schema: type: string style: simple - description: Number of digital wallet token resources to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: Sort order index of the first digital wallet token resource in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: 'Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order.' explode: true in: query name: sort_by required: false schema: default: -id type: string style: form responses: '200': content: application/json: example: count: 1 data: - address_verification: name: Address Verification Name postal_code: '94703' street_address: 223 Elm Street card_token: my_card_token_1989 created_time: 2025-10-03 18:55:45+00:00 device: device_id: my_device_id_9575 ip_address: x.x.x.x language_code: eng location: +37.81/-122.26 name: Phone Name phone_number: '12345678900' type: MOBILE_PHONE fulfillment_status: PROVISIONED issuer_eligibility_decision: cardaccount.verified last_modified_time: 2025-01-26 22:36:10+00:00 state: ACTIVE state_reason: Card activated by cardholder token: my_token_0000 token_service_provider: pan_reference_id: my_pan_reference_id_0073 token_eligibility_decision: DECISION_GREEN token_reference_id: my_token_reference_id_1600 token_requestor_id: my_token_requestor_id_0373 token_requestor_name: Token Requestor Name token_score: '02' token_type: DEVICE_SECURE_ELEMENT wallet_provider_profile: account: score: '05' device_score: '03' pan_source: KEY_ENTERED risk_assessment: score: DECISION_YELLOW version: '0001.00' end_index: 0 is_more: true start_index: 0 schema: $ref: '#/components/schemas/DigitalWalletTokenListResponse' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Card not found '500': content: {} description: Server error summary: List digital wallet tokens for card tags: - Digital Wallets Management /digitalwallettokens/{token}: get: description: Use this endpoint to retrieve a specific digital wallet token. operationId: getDigitalwallettokensToken parameters: - description: Unique identifier of the digital wallet token (DWT). explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: address_verification: name: Address Verification Name postal_code: '94703' street_address: 223 Elm Street card_token: my_card_token_1989 created_time: 2025-10-03 18:55:45+00:00 device: device_id: my_device_id_9575 ip_address: x.x.x.x language_code: eng location: +37.81/-122.26 name: Phone Name phone_number: '12345678900' type: MOBILE_PHONE fulfillment_status: PROVISIONED issuer_eligibility_decision: cardaccount.verified last_modified_time: 2025-01-26 22:36:10+00:00 state: ACTIVE state_reason: Card activated by cardholder token: my_token_0000 token_service_provider: pan_reference_id: my_pan_reference_id_0073 token_eligibility_decision: DECISION_GREEN token_reference_id: my_token_reference_id_1600 token_requestor_id: my_token_requestor_id_0373 token_requestor_name: Token Requestor Name token_score: '02' token_type: DEVICE_SECURE_ELEMENT wallet_provider_profile: account: score: '05' device_score: '03' pan_source: KEY_ENTERED risk_assessment: score: DECISION_YELLOW version: '0001.00' schema: $ref: '#/components/schemas/digital_wallet_token' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Card not found '500': content: {} description: Server error summary: Retrieve digital wallet token tags: - Digital Wallets Management /digitalwallettokens/{token}/showtokenpan: get: description: 'Use 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}`.) [WARNING] Sending a request to this endpoint requires PCI 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 primary account number (PAN), personal identification number (PIN), and card expiration date.' operationId: getDigitalwallettokensTokenShowtokenpan parameters: - description: Unique identifier of the digital wallet token (DWT). explode: false in: path name: token required: true schema: type: string style: simple responses: '200': content: application/json: example: address_verification: name: Address Verification Name postal_code: '94703' street_address: 223 Elm Street card_token: my_card_token_1989 created_time: 2025-10-03 18:55:45+00:00 device: device_id: my_device_id_9575 ip_address: x.x.x.x language_code: eng location: +37.81/-122.26 name: Phone Name phone_number: '12345678900' type: MOBILE_PHONE fulfillment_status: PROVISIONED issuer_eligibility_decision: cardaccount.verified last_modified_time: 2025-01-26 22:36:10+00:00 state: ACTIVE state_reason: Card activated by cardholder token: my_token_0000 token_service_provider: pan_reference_id: my_pan_reference_id_0073 token_eligibility_decision: DECISION_GREEN token_pan: my_token_pan_6792 token_reference_id: my_token_reference_id_1600 token_requestor_id: my_token_requestor_id_0373 token_requestor_name: Token Requestor Name token_score: '02' token_type: DEVICE_SECURE_ELEMENT wallet_provider_profile: account: score: '05' device_score: '03' pan_source: KEY_ENTERED risk_assessment: score: DECISION_YELLOW version: '0001.00' schema: $ref: '#/components/schemas/digital_wallet_token' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Card not found '500': content: {} description: Server error summary: Retrieve digital wallet token PAN tags: - Digital Wallets Management /digitalwallettokentransitions: post: description: Use this endpoint to transition a digital wallet token from one state to another. operationId: postDigitalwallettokentransitions requestBody: content: application/json: example: digital_wallet_token: token: my_digital_wallet_token_0987 reason: Passed additional identity verification reason_code: '18' state: ACTIVE token: my_transition_04 schema: $ref: '#/components/schemas/digital_wallet_token_transition_request' required: false responses: '201': content: application/json: example: channel: API created_time: 2025-02-23 18:57:45+00:00 digital_wallet_token: token: my_digital_wallet_token_0987 fulfillment_status: PROVISIONED reason: Passed additional identity verification reason_code: '18' state: ACTIVE token: my_transition_04 type: state.activated schema: $ref: '#/components/schemas/digital_wallet_token_transition_response' description: Success '400': content: {} description: User input error/Bad request '409': content: {} description: Token already associated with a different payload '500': content: {} description: Server error summary: Create digital wallet token transition tags: - Digital Wallets Management /digitalwallettokentransitions/digitalwallettoken/{token}: get: description: 'Use this endpoint to return an array of all transitions for a particular digital wallet token. This endpoint supports <>, <>, and <>.' operationId: getDigitalwallettokentransitionsDigitalwallettokenToken parameters: - description: Unique identifier of the digital wallet token (DWT). explode: false in: path name: token required: true schema: type: string style: simple - description: Number of digital wallet transitions to retrieve. explode: true in: query name: count required: false schema: default: 5 format: int32 type: integer style: form - description: The sort order index of the first digital wallet token in the returned array. explode: true in: query name: start_index required: false schema: default: 0 format: int32 type: integer style: form - description: 'Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields.' explode: true in: query name: fields required: false schema: type: string style: form - description: 'Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order.' explode: true in: query name: sort_by required: false schema: default: -id type: string style: form responses: '200': content: application/json: example: count: 2 data: - channel: API created_time: 2025-02-23 18:57:45+00:00 digital_wallet_token: token: my_digital_wallet_token_0987 fulfillment_status: PROVISIONED reason: Passed additional identity verification reason_code: '18' state: ACTIVE token: my_transition_04 type: state.activated - channel: TOKEN_SERVICE_PROVIDER created_time: 2024-02-23 18:44:21+00:00 digital_wallet_token: token: my_digital_wallet_token_0987 fulfillment_status: DECISION_YELLOW reason: Additional identity verification required reason_code: '21' state: REQUESTED token: my_transition_04 type: fulfillment.requested end_index: 1 is_more: false start_index: 0 schema: $ref: '#/components/schemas/DigitalWalletTokenTransitionListResponse' description: Success '400': content: {} description: Bad request '500': content: {} description: Server error summary: List transitions for digital wallet token tags: - Digital Wallets Management /digitalwallettokentransitions/{token}: get: description: 'Use this endpoint to retrieve a specific digital wallet token transition. This endpoint supports <>.' operationId: getDigitalwallettokentransitionsToken parameters: - description: Unique identifier of the digital wallet token (DWT) transition. explode: false in: path name: token required: true schema: type: string style: simple - description: 'Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields.' explode: true in: query name: fields required: false schema: type: string style: form responses: '200': content: application/json: example: channel: API created_time: 2025-02-23 18:57:45+00:00 digital_wallet_token: token: my_digital_wallet_token_0987 fulfillment_status: PROVISIONED reason: Passed additional identity verification reason_code: '18' state: ACTIVE token: my_transition_04 type: state.activated schema: $ref: '#/components/schemas/digital_wallet_token_transition_response' description: Success '400': content: {} description: User input error/Bad request '404': content: {} description: Transition not found '500': content: {} description: Server error summary: Retrieve digital wallet token transition tags: - Digital Wallets Management components: schemas: ads_create_card_details_response: description: Response containing the payment credential associated with a Visa ADS alias. properties: externalId: description: External ID of the payment credential, which corresponds to Marqeta's card token. maxLength: 100 minLength: 1 type: string id: description: UUID generated by Alias Directory, a utility used to identify the payment credential. maxLength: 36 type: string type: description: Indicates the type of payment credential. enum: - CARD - BANK type: string required: - id - type type: object click_to_pay_status_response: properties: status: description: 'The status of the Click to Pay request. * `SUCCESS`: The Click to Pay request was successful. * `FAILED`: The Click to Pay request failed. * `RECEIVED`: The Click to Pay request was received.' enum: - SUCCESS - FAILED - RECEIVED type: string token: description: Unique identifier of the Click to Pay request, used to track the status of the request. maxLength: 36 type: string token_reference_id: description: Unique identifier of the digital wallet token within the card network. type: string type: object transaction_device: description: 'Contains information about the device used in the transaction to enhance the risk decisioning process. Use this data to improve fraud prevention and dispute resolution.' properties: binding_id: description: Unique identifier of the data component bound to the credential. type: string ip_address: description: 'IP address of the device. The presence of the IP address helps determine if the transaction was initiated from an unusual network, helping establish a pattern of safe device usage that further confirms the authenticity of the consumer who initiated the transaction.' type: string location: description: 'Geographic coordinates of the device. Contains the latitude and longitude of the device used when the cardholder was authenticated during checkout. This field helps to determine if the transaction was initiated from an unexpected location.' type: string phone_number: description: 'Telephone number of the device. Contains the phone number that was used to authenticate the consumer during checkout, or the consumer''s preferred phone number. The presence of the phone number helps establish the consumer''s authenticity when matching the phone number provided during checkout to a list of known phone numbers for the consumer.' type: string type: object ads_preferred_for: description: Details of the operation. properties: date: description: Date of the Receiving, Sending, or Paying operation. format: date maxLength: 10 minLength: 10 pattern: ^\d\d\d\d\-\d\d\-\d\d$ type: string type: description: Type of operation associated with the payment credential. enum: - RECEIVE - SEND - PAY type: string required: - type type: object visa_click_to_pay_user: description: User's email address, mobile phone number without country code, first name, last name, locale, and country. properties: country: description: ISO 3166-1 alpha-3 country code. maxLength: 3 minLength: 3 type: string email: description: User's email address. type: string firstName: description: User's first name. maxLength: 35 minLength: 1 type: string lastName: description: User's last name. maxLength: 35 minLength: 1 type: string locale: description: 'The user-provided language choice. The ISO 639-2 language code is a two-letter country code that represents a language. The ISO maintains the link:https://id.loc.gov/vocabulary/iso639-2.html[ISO 639-2 language codes, window="_blank"].' maxLength: 5 minLength: 2 type: string phone: description: 'User''s mobile phone number according to ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included.' maxLength: 16 minLength: 1 type: string userToken: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - country - email - firstName - lastName - locale - phone - userToken type: object click_to_pay_check_eligibility_response: properties: image_assets: description: List of image assets for the Click to Pay logo if `include_asset` is set to `true` in the request. items: $ref: '#/components/schemas/media_content' type: array is_eligible: default: false description: 'Indicates whether the `bin_prefix` is eligible for Click to Pay. * `true`: The `bin_prefix` is eligible for Click to Pay. * `false`: The `bin_prefix` is not eligible for Click to Pay.' type: boolean type: object xpay_push_tokenize_request_data: description: Contains details about a card tokenization push request. properties: card_type: description: Specifies the type of card. type: string display_name: description: 'Name of the card as displayed in the digital wallet, typically showing the card brand and last four digits of the primary account number (PAN). `Visa 5678`, for example.' type: string extra_provision_payload: description: Encrypted card or cardholder details. type: string last_digits: description: Last four digits of the primary account number of the physical or virtual card. type: string network: description: Specifies the card network of the physical or virtual card. type: string token_service_provider: description: Specifies the network that provides the digital wallet token service. type: string type: object web_push_provisioning_apple_pay_JWS_model: description: Object containing JSON Web Signature (JWS) data. properties: header: $ref: '#/components/schemas/web_push_provisioning_apple_pay_JWS_header' payload: description: JSON Web Signature (JWS) message payload. type: string protected: description: Contains header parameters that are integrity-protected by the JSON Web Signature (JWS). type: string signature: description: The JSON Web Signature (JWS). example: 5lD1znG2DD2DytqGUcSDOwJQMYbCGDCCCiXxyhpC1zOWTH1Y6jUJFAupl0jEud9nUvw3mmpuSt6zcAE1r4yb0w type: string required: - header - payload - protected - signature type: object ads_create_additional_aliases_request: description: Request to create an additional alias. properties: type: description: Type of the additional Visa Alias. enum: - EMAIL - PHONE type: string value: description: Unique identifier that represents the customer in the payment ecosystem. maxLength: 128 minLength: 1 type: string required: - type - value type: object risk_assessment: description: Contains the digital wallet provider's risk assessment for provisioning the digital wallet token. properties: score: description: Wallet provider's decision as to whether the digital wallet token should be provisioned. type: string version: description: Wallet provider's risk assessment version. type: string type: object web_push_provisioning_apple_pay_JWS_header: description: Contains header data for the JWS object. properties: kid: description: Unique identifier of the JSON Web Signature (JWS) public key of the key pair used to generate the signature. example: 8dc7aed4-29e3-41e4-9cdb-673a05e6615c type: string required: - kid type: object ads_get_report_status_response: description: Response containing the status of the report. properties: creationDateTime: description: The timestamp when the report was created in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z format: date-time type: string dataClassification: description: Data classification of the report. maxLength: 36 minLength: 1 type: string expirationDateTime: description: The timestamp after which the report won't be available for download in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z format: date-time type: string fileIds: description: UUIDs of the files generated by the report. items: description: UUIDs of the files generated by the report. type: string maxLength: 36 minLength: 1 type: array format: description: Format of the report. maxLength: 36 minLength: 1 type: string id: description: UUID generated by Alias Directory, which identifies the report. maxLength: 36 minLength: 1 type: string reportType: description: Indicates the type of report. enum: - PLATFORM_REQUESTS - DIRECTORY_STATUS - PAYMENT_CREDENTIAL_DETAILS type: string status: description: Indicates the status of the report. enum: - CREATED - IN_PROGRESS - COMPLETED type: string type: object ads_alias_inquiry_details: description: Visa Alias information associated with existing records. properties: aliasType: description: 'Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details. This field is returned if it exists in the resource.' enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: 'Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included.' maxLength: 128 minLength: 1 type: string directories: description: List of directories associated with the Visa Alias. items: $ref: '#/components/schemas/ads_directory_object' maxItems: 10 minItems: 0 type: array directoriesNames: description: List of directory names associated with the Visa Alias. items: maxLength: 128 minLength: 1 type: string maxItems: 10 minItems: 0 type: array type: object ads_consent: description: Visa Alias Directory Service (ADS) consent information. properties: expiryDateTime: description: 'Date and time when the validity of the Visa ADS consent ends. This field is returned if it exists in the resource.' format: date-time maxLength: 20 minLength: 20 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$ type: string intermediaries: description: Intermediaries of the Visa ADS consent. items: maxLength: 120 minLength: 1 type: string maxItems: 5 minItems: 0 type: array presenter: description: Presenter of the Visa Alias Directory Service (ADS) consent. maxLength: 120 minLength: 1 type: string validFromDateTime: description: Date and time when the validity of the Visa ADS consent begins. format: date-time maxLength: 20 minLength: 20 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$ type: string version: description: Version of the Visa ADS consent. maxLength: 9 minLength: 1 type: string required: - presenter - validFromDateTime - version type: object visa_click_to_pay_status_response: description: Response containing the status of a Visa Click to Pay request. properties: consumerInformation: description: Consumer information. properties: externalConsumerID: description: External consumer ID. maxLength: 100 minLength: 1 type: string externalConsumerIDOwnerBID: description: Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. maxLength: 8 minLength: 1 type: string type: object details: description: Additional status details of the operation. items: $ref: '#/components/schemas/visa_click_to_pay_status_details' type: array status: description: Status of the operation. enum: - IN_PROGRESS - COMPLETED type: string required: - status type: object ads_alias_inquiry_user_details: description: 'Details of the user requesting the Visa Alias information. The information must not contain personal identifiable information (PII).' properties: userName: description: Unique identifier of the user. maxLength: 50 minLength: 1 type: string type: object DigitalWalletTokenListResponse: properties: count: description: 'Number of resources returned. This field is returned if there are resources in your returned array.' format: int32 type: integer data: description: 'Array of digital wallet token resources. Resources are returned as appropriate to your query.' items: $ref: '#/components/schemas/digital_wallet_token' type: array end_index: description: 'Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array.' format: int32 type: integer is_more: default: false description: 'A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array.' type: boolean start_index: description: 'Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array.' format: int32 type: integer type: object ads_payment_credentials_response: description: Response containing the details of a payment credential. properties: externalId: description: External ID of the Visa Alias. maxLength: 100 minLength: 1 type: string id: description: Unique identifier of the additional Visa Alias generated by the Alias Directory. maxLength: 36 type: string type: description: The type of payment credential enum: - CARD - BANK type: string required: - id - type type: object digital_wallet_android_pay_provision_request: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string device_id: description: Unique identifier of the user's Google device, as provided by Google during the provisioning process. maxLength: 24 minLength: 1 type: string device_type: description: Type of device into which the digital wallet token will be provisioned. enum: - MOBILE_PHONE - WATCH - TABLET - WEARABLE_DEVICE - HOUSEHOLD_DEVICE - AUTOMOBILE_DEVICE type: string provisioning_app_version: description: 'Version of the application making the provisioning request. Used for debugging and fraud prevention.' maxLength: 50 minLength: 1 type: string wallet_account_id: description: User's Google Wallet account ID, as provided by Google during the provisioning process. maxLength: 50 minLength: 1 type: string required: - card_token - device_id - device_type - provisioning_app_version - wallet_account_id type: object ads_verification_details: description: 'Verification details associated with the Visa Alias. This field is returned if it exists in the resource.' properties: authDateTime: description: Time when the user provided the credentials for verification in ISO UTC format. format: date-time type: string authMethodReference: description: Authentication method used when the user provided the credentials for verification. type: string creationDateTime: description: Time when the user was created or enrolled in ISO UTC format. format: date-time type: string verifiedEmail: description: 'Returns `true` if an email was verified during the verification process. This email does not need to match the Alias or contact info if an email was used.' type: boolean verifiedPhone: description: 'Returns `true` if a phone number was verified during the verification process. This phone number does not need to match the Alias or contact info if a phone number was used.' type: boolean type: object visa_click_to_pay_response: description: Response containing the request trace ID of a Visa Click to Pay request. properties: requestTraceId: description: Unique identifier of the Visa Click to Pay request. maxLength: 36 minLength: 1 type: string required: - requestTraceId type: object ads_get_by_external_id_response: description: Response for retrieve by external ID request. properties: associatedIds: description: List of associated Visa Alias IDs. items: $ref: '#/components/schemas/ads_associated_ids' minItems: 0 type: array id: description: UUID generated by Alias Directory, which identifies the Visa Alias. maxLength: 36 minLength: 1 type: string required: - associatedIds type: object digital_wallet_samsung_pay_provision_response: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. type: string created_time: description: Date and time when the digital wallet provisioning request was created, in UTC. format: date-time type: string last_modified_time: description: Date and time when the digital wallet token provisioning request was last updated, in UTC. format: date-time type: string push_tokenize_request_data: $ref: '#/components/schemas/samsung_push_tokenize_request_data' required: - card_token - created_time - last_modified_time - push_tokenize_request_data type: object digital_wallet_token_hash: description: Contains identifiers of the digital wallet token resource and the card resource. properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string token: description: Unique identifier of the digital wallet token resource. maxLength: 36 minLength: 1 type: string required: - token type: object ads_card_details_request: description: Request object for creating or updating a Visa ADS card. properties: billingAddress: $ref: '#/components/schemas/ads_billing_address' cardToken: description: Unique identifier of the card token. maxLength: 36 minLength: 1 type: string cardType: description: Type of card for the payment credential. maxLength: 70 minLength: 1 type: string currencyCode: description: Three-digit ISO 4217 currency code for the payment credential. maxLength: 3 minLength: 3 type: string issuerName: description: Card issuer's name for the payment credential. maxLength: 150 minLength: 1 type: string nameOnCard: description: Name on the card for the payment credential. maxLength: 120 minLength: 1 type: string preferredFor: description: Indicates if a payment credential is a preferred Receiving, Sending, or Paying account. items: enum: - RECEIVE - SEND - PAYING type: string maxItems: 3 minItems: 0 type: array required: - billingAddress - cardToken - cardType - issuerName - nameOnCard type: object PostTokenizationAuthenticationDecisionResponse: additionalProperties: false properties: message: description: Human-readable description of the outcome. example: Authentication decision recorded and forwarded to Mastercard maxLength: 255 type: string status: description: Indicates if the operation was successful. enum: - SUCCESS - FAILED example: SUCCESS type: string required: - message - status type: object ads_directory_object: description: Directory object associated with the Visa Alias. properties: directoryName: description: The directory name for the Visa Alias. maxLength: 25 minLength: 0 type: string entities: description: List of entities associated with the directory. items: $ref: '#/components/schemas/ads_entity' maxItems: 10 minItems: 0 type: array type: object ads_create_alias_response: description: Response containing the unique identifier of the alias generated by Alias Directory. properties: externalId: description: External ID of the Visa Alias. maxLength: 100 minLength: 1 type: string id: description: UUID generated by Alias Directory, which identifies the Visa Alias. maxLength: 36 type: string paymentCredentials: description: 'List of payment credentials associated with the Visa Alias. This array is returned if the Visa Alias exists and one or more payment credentials are linked to it.' items: $ref: '#/components/schemas/ads_payment_credentials_response' maxItems: 10 minItems: 1 type: array required: - id type: object ads_alias_inquiry_response: description: 'Response object containing Visa Aliases available for alias resolution. One or more Visa Aliases maybe available.' properties: details: description: Information associated with available Visa Aliases. items: $ref: '#/components/schemas/ads_alias_inquiry_details' maxItems: 900 minItems: 0 type: array summary: $ref: '#/components/schemas/ads_alias_inquiry_summary' required: - summary type: object click_to_pay_enroll_response: properties: token: description: Unique identifier of the Click to Pay request. maxLength: 36 minLength: 1 type: string type: object AndroidPushTokenRequestAddress: description: Specifies the cardholder address. properties: address1: description: Street address of the cardholder. type: string address2: description: 'Additional address information for the cardholder, such as a suite or apartment number. `Suite 600`, for example.' type: string city: description: City of the cardholder. type: string country: description: 'Two-character link:https://www.iso.org/iso-3166-country-codes.html[ISO alpha-2 country code, window="_blank"]. `US`, for example.' type: string name: description: Name of the cardholder. type: string phone: description: Telephone number of the cardholder. type: string postal_code: description: 'Postal code of the cardholder, such as a United States ZIP code. `94612`, for example.' type: string state: description: 'Two-character state, provincial, or territorial abbreviation. For the complete list, see <>.' type: string zip: type: string type: object PostTokenizationAuthenticationDecisionRequest: additionalProperties: false properties: authRequestCorrelationId: description: Correlates multiple authentication requests. example: 550e8400-e29b-41d4-a716-446655440000 maxLength: 64 minLength: 1 type: string authenticationMethod: description: Authentication method used to verify the cardholder. enum: - Issuer Application - Web Portal example: Issuer Application type: string commentText: description: Optional comment related to the decision. example: Cardholder authentication performed post tokenization maxLength: 500 type: string decision: description: Issuer decision after cardholder authentication. enum: - SUCCESS - FAILED example: SUCCESS type: string tokenUniqueReference: description: Unique identifier of the token allocated to the card. example: DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c maxLength: 64 minLength: 1 type: string required: - authenticationMethod - decision - tokenUniqueReference type: object visa_click_to_pay_update_cardholder_request: description: Request to update cardholder information. properties: user: $ref: '#/components/schemas/visa_click_to_pay_user' required: - user type: object media_content: properties: data: description: Media data content. type: string height: description: 'Height of non-SVG image asset. Specified in pixels.' type: string type: description: 'Type of media. Specified as Multipurpose Internet Mail Extension (MIME). Supported media types include: * application/pdf * image/png * image/svg+xml * text/plain * text/html ' type: string width: description: 'Width of non-SVG image asset. Specified in pixels.' type: string type: object address_verification: description: Contains address verification information. properties: name: description: Name of the cardholder. type: string postal_code: description: Postal code. type: string street_address: description: Street address provided by the cardholder. type: string zip: description: United States ZIP code. type: string type: object digital_wallet_token: description: 'Contains information about the digital wallet that funded the transaction. Returned for all transactions funded by a digital wallet or related to digital wallet token provisioning. For more on digital wallets, see the <> API reference and <> developer guide.' properties: address_verification: $ref: '#/components/schemas/address_verification' card_token: description: Unique identifier of the card. type: string created_time: description: Date and time when the digital wallet token object was created, in UTC. format: date-time type: string device: $ref: '#/components/schemas/device' fulfillment_status: description: 'Digital wallet token''s provisioning status. For fulfillment status descriptions, see <>.' type: string issuer_eligibility_decision: description: 'The Marqeta platform''s decision as to whether the digital wallet token should be provisioned. * *0000* – The token should be provisioned. * *token.activation.verification.required* – Provisioning is pending; further action is required for completion. For all other values, check the value of the `fulfillment_status` field to definitively ascertain the provisioning outcome. *NOTE:* The value `invalid.cid` indicates an invalid CVV2 number.' type: string last_modified_time: description: Date and time when the digital wallet token object was last modified, in UTC. format: date-time type: string metadata: $ref: '#/components/schemas/digital_wallet_token_metadata' state: description: 'State of the digital wallet token. For state descriptions, see <>.' type: string state_reason: description: Reason why the digital wallet token transitioned to its current state. type: string token: description: Unique identifier of the digital wallet token. type: string token_service_provider: $ref: '#/components/schemas/token_service_provider' transaction_device: $ref: '#/components/schemas/transaction_device' user: $ref: '#/components/schemas/user_card_holder_response' wallet_provider_profile: $ref: '#/components/schemas/wallet_provider_profile' type: object visa_click_to_pay_payment_instrument: description: Object containing details of payment instruments for Visa Click to Pay. properties: accountNumber: description: Masked account number of the payment instrument. maxLength: 19 minLength: 16 type: string billingAddress: $ref: '#/components/schemas/visa_click_to_pay_billing_address' expirationDate: description: Date of the expiration in the format YYYY-MM. maxLength: 7 minLength: 7 type: string nameOnCard: description: Name on the card. maxLength: 120 minLength: 1 type: string paymentAccountReference: description: Reference of the payment account. maxLength: 50 minLength: 29 type: string status: description: Status of the payment instrument. enum: - ACTIVE - INACTIVE - SUSPENDED - DELETED type: string tokenDetails: properties: tokenReferenceID: description: Unique reference identifier for the token. maxLength: 50 minLength: 1 type: string tokenRequestorID: description: Unique token requestor identifier. maxLength: 11 minLength: 1 type: string required: - tokenReferenceID - tokenRequestorID type: object type: description: Type of the payment instrument. enum: - CARD type: string type: object ads_contact_info: description: 'Contact information in the Alias Directory Service (ADS) profile. This array is returned if the Visa Alias'' contact information details exist.' properties: type: description: Type of contact information in the Alias Directory Service (ADS) profile. enum: - EMAIL - PHONE - DIRECTORY_ALIASID type: string value: description: Contact information value, which is the email address or phone number. maxLength: 320 minLength: 1 type: string required: - type - value type: object digital_wallet_x_pay_provision_response: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. type: string created_time: description: Date and time when the digital wallet provisioning request was created, in UTC. format: date-time type: string last_modified_time: description: Date and time when the digital wallet token provisioning request was last updated, in UTC. format: date-time type: string push_tokenize_request_data: $ref: '#/components/schemas/xpay_push_tokenize_request_data' required: - card_token - created_time - last_modified_time - push_tokenize_request_data type: object digital_wallet_android_pay_provision_response: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. type: string created_time: description: Date and time when the digital wallet provisioning request was created, in UTC. format: date-time type: string last_modified_time: description: Date and time when the digital wallet token provisioning request was last updated, in UTC. format: date-time type: string push_tokenize_request_data: $ref: '#/components/schemas/android_push_tokenize_request_data' required: - card_token - created_time - last_modified_time - push_tokenize_request_data type: object visa_click_to_pay_user_data: description: Object containing user data. properties: consumerInformation: $ref: '#/components/schemas/visa_click_to_pay_consumer_information' intent: $ref: '#/components/schemas/visa_click_to_pay_intent' paymentInstruments: description: Array of objects containing details of payment instruments for Visa Click to Pay. items: $ref: '#/components/schemas/visa_click_to_pay_payment_instrument' type: array required: - consumerInformation - intent - paymentInstruments type: object DigitalWalletTokenTransitionListResponse: properties: count: description: 'Number of resources returned. This field is returned if there are resources in your returned array.' format: int32 type: integer data: description: 'Array of digital wallet token transition resources. Resources are returned as appropriate to your query.' items: $ref: '#/components/schemas/digital_wallet_token_transition_response' type: array end_index: description: 'Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array.' format: int32 type: integer is_more: default: false description: 'A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array.' type: boolean start_index: description: 'Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array.' format: int32 type: integer type: object account: description: Contains information related to the cardholder and provided by the digital wallet provider. properties: email_address: description: Digital wallet provider's email address for the cardholder. type: string id: description: Digital wallet provider's identity number for the cardholder. type: string score: description: Score from the digital wallet provider. type: string type: object ads_associated_ids: description: Associated payment credential IDs. properties: id: description: ID of the payment credential associated with the Visa Alias. maxLength: 64 minLength: 1 type: string type: description: Type of payment credential associated with the Visa Alias. enum: - ALIAS - PAYMENT_CREDENTIAL type: string type: object visa_click_to_pay_status_details: properties: errorDetails: description: Details of error occurred while executing the operation. items: properties: field: description: Field that caused the error in the operation. maxLength: 100 minLength: 1 type: string message: description: Message describing the error. maxLength: 256 minLength: 1 type: string reason: description: Description of why the error has occurred. maxLength: 100 minLength: 1 type: string required: - field - message - reason type: object type: array intent: $ref: '#/components/schemas/visa_click_to_pay_intent' status: description: Status of the operation. enum: - SUCCESS - FAILED type: string required: - errorDetails - intent - status type: object ads_card_response: description: Response containing the payment credential associated with a Visa ADS alias. properties: accountNumber: description: Account number of the payment credential. maxLength: 19 minLength: 12 type: string accountNumberType: description: Type of account number associated with the payment credential. enum: - PAN - NIUBIZ - TOKEN type: string billingAddress: $ref: '#/components/schemas/ads_billing_address' cardType: description: Type of card associated with the payment credential. maxLength: 70 minLength: 1 type: string createdOn: description: Date and time when the payment credential was created. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string currencyCode: description: Three-digit ISO 4217 currency code for the payment credential. maxLength: 3 minLength: 3 type: string expirationDate: description: Expiration date of the card. maxLength: 7 minLength: 7 pattern: ^\d{4}-\d{2}$ type: string externalId: description: External ID of the payment credential, which corresponds to Marqeta's card token. maxLength: 100 minLength: 1 type: string id: description: Unique identifier of the payment credential generated by Alias Directory. maxLength: 36 minLength: 1 type: string issuerName: description: Name of the issuer of the payment credential. maxLength: 150 minLength: 1 type: string lastFourDigits: description: Last four digits of the card number. maxLength: 4 minLength: 4 type: string lastUpdatedOn: description: Date and time when the payment credential was last updated. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string nameOnCard: description: Name on the card associated with the payment credential. maxLength: 120 minLength: 1 type: string preferredFor: description: 'Indicates if a payment credential is a preferred Receiving, Sending, or Paying account. This array is returned if you passed the `preferredFor` field when creating a Visa Alias or when adding a new payment credential to an existing Visa Alias.' items: $ref: '#/components/schemas/ads_preferred_for' maxItems: 3 minItems: 0 type: array status: description: Status of the payment credential associated with the Visa Alias. enum: - ACTIVE - BLOCKED - DISABLED - EXPIRED type: string type: description: Type of payment credential associated with the Visa Alias. enum: - CARD type: string required: - accountNumber - billingAddress - type type: object ads_entity: description: Information about the Visa ADS entities. properties: id: description: Unique identifier of the entity. maxLength: 36 minLength: 1 type: string preferredFor: description: List of preferred payment methods for the entity. items: $ref: '#/components/schemas/ads_preferred_for' maxItems: 10 minItems: 0 type: array type: object IdentificationResponseModel: description: Contains identifications associated with the cardholder. properties: expiration_date: description: Expiration date of the identification, if applicable. readOnly: true type: string issuing_country: readOnly: true type: string type: description: Type of identification. enum: - SSN - TIN - SIN - NIN - PASSPORT_NUMBER - DRIVERS_LICENSE - BUSINESS_NUMBER - BUSINESS_TAX_ID - TAXPAYER_REFERENCE readOnly: true type: string value: description: Number associated with the identification. readOnly: true type: string type: object sending_provisioning_data_to_google_pay_backend_request: properties: card_setting: description: 'Indicates if the Funding Primary Account Number (FPAN) will be attempted. * *1* - FPAN save will be attempted. * *0* - FPAN save will not be attempted.' enum: - 0 - 1 example: 0 format: int32 type: integer card_token: description: Unique identifier of the card resource. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string client_session_id: description: String provided by Google Wallet that identifies the client session. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string integrator_id: description: Google-assigned string that uniquely identifies both the integrator that is initiating the session and the issuer of the card. example: ACMEISSUER_1 type: string public_device_id: description: String provided by Google Wallet that identifies the Android device that will receive the digital wallet token. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string public_wallet_id: description: String provided by Google Wallet that identifies the device-scoped wallet that receives the digital wallet token. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string server_session_id: description: String provided by Google Wallet that identifies the backend session. example: 8c84fab9-889c-4cb7-a330-accac5799ea5 type: string token_setting: description: 'Indicates if tokenization will be attempted. * *1* - Tokenization will be attempted. * *0* - Tokenization will not be attempted.' enum: - 0 - 1 example: 0 format: int32 type: integer required: - card_setting - card_token - client_session_id - integrator_id - public_device_id - public_wallet_id - server_session_id - token_setting type: object token_service_provider: description: Contains information held and provided by the token service provider (card network). properties: correlation_id: description: 'For Mastercard only. Unique value representing a tokenization request.' type: string pan_reference_id: description: Unique identifier of the digital wallet token primary account number (PAN) within the card network. type: string token_assurance_level: description: 'For Mastercard only. Represents the confidence level in the digital wallet token.' type: string token_eligibility_decision: description: Digital wallet's decision as to whether the digital wallet token should be provisioned. type: string token_expiration: description: Expiration date of the digital wallet token. type: string token_pan: description: Primary account number (PAN) of the digital wallet token. type: string token_reference_id: description: Unique identifier of the digital wallet token within the card network. type: string token_requestor_id: description: 'Unique numerical identifier of the token requestor within the card network. These ID numbers map to `token_requestor_name` field values as follows: *Mastercard* * 50110030273 – `APPLE_PAY` * 50120834693 – `ANDROID_PAY` * 50139059239 – `SAMSUNG_PAY` *Visa* * 40010030273 – `APPLE_PAY` * 40010075001 – `ANDROID_PAY` * 40010043095 – `SAMSUNG_PAY` * 40010075196 – `MICROSOFT_PAY` * 40010075338 – `VISA_CHECKOUT` * 40010075449 – `FACEBOOK` * 40010075839 – `NETFLIX` * 40010077056 – `FITBIT_PAY` * 40010069887 – `GARMIN_PAY`' type: string token_requestor_name: description: 'Name of the token requestor within the card network. *NOTE:* The list of example values for this field is maintained by the card networks and is subject to change.' type: string token_score: description: Token score assigned by the digital wallet. type: string token_service_provider_id: type: string token_type: description: Type of the digital wallet token. type: string required: - pan_reference_id type: object user_card_holder_response: description: Contains information about a cardholder. properties: account_holder_group_token: description: Associates the specified account holder group with the cardholder. maxLength: 36 minLength: 0 type: string active: default: false description: Specifies if the cardholder is in the `ACTIVE` state on the Marqeta platform. type: boolean address1: description: Cardholder's address. maxLength: 255 minLength: 0 type: string address2: description: Additional address information for the cardholder. maxLength: 255 minLength: 0 type: string authentication: $ref: '#/components/schemas/Authentication' birth_date: description: Cardholder's date of birth. type: string birth_place: description: Country where the cardholder was born. maxLength: 255 minLength: 0 type: string business_token: description: Unique identifier of the business resource. type: string city: description: City where the cardholder resides. maxLength: 40 minLength: 0 type: string company: description: Company name. maxLength: 255 minLength: 0 type: string corporate_card_holder: default: false description: Specifies if the cardholder holds a corporate card. type: boolean country: description: Country where the cardholder resides. maxLength: 40 minLength: 0 type: string created_time: description: Date and time when the resource was created, in UTC. format: date-time type: string email: description: Valid email address of the cardholder. maxLength: 255 minLength: 1 type: string first_name: description: Cardholder's first name. maxLength: 40 minLength: 0 type: string gender: description: Gender of the cardholder. enum: - F - M maxLength: 1 minLength: 0 type: string honorific: description: 'Cardholder''s title or prefix: Dr., Miss, Mr., Ms., and so on.' maxLength: 10 minLength: 0 type: string id_card_expiration_date: description: Expiration date of the cardholder's identification. readOnly: true type: string id_card_number: description: Cardholder's identification card number. maxLength: 255 minLength: 0 type: string identifications: description: One or more objects containing identifications associated with the cardholder. items: $ref: '#/components/schemas/IdentificationResponseModel' type: array ip_address: description: Cardholder's IP address. maxLength: 39 minLength: 0 type: string last_modified_time: description: Date and time when the resource was last updated, in UTC. format: date-time type: string last_name: description: Cardholder's last name. maxLength: 40 minLength: 0 type: string metadata: additionalProperties: type: string description: Associates any additional metadata you provide with the cardholder. type: object middle_name: description: Cardholder's middle name. maxLength: 40 minLength: 0 type: string nationality: description: Cardholder's nationality. maxLength: 255 minLength: 0 type: string notes: description: Any additional information pertaining to the cardholder. maxLength: 255 minLength: 0 type: string parent_token: description: Unique identifier of the parent user or business resource. maxLength: 36 minLength: 1 type: string passport_expiration_date: description: Expiration date of the cardholder's passport. readOnly: true type: string passport_number: description: Cardholder's passport number. maxLength: 40 minLength: 0 type: string password: description: Password to the cardholder's user account on the Marqeta platform. maxLength: 255 minLength: 1 type: string phone: description: Cardholder's telephone number. maxLength: 255 minLength: 0 type: string postal_code: description: Postal code of the cardholder's address. maxLength: 10 minLength: 0 type: string ssn: description: Cardholder's Social Security Number (SSN). type: string state: description: State or province where the cardholder resides. maxLength: 2 minLength: 0 type: string status: description: Specifies the status of the cardholder on the Marqeta platform. enum: - UNVERIFIED - LIMITED - ACTIVE - SUSPENDED - CLOSED - TERMINATED type: string title: description: Professional title of the cardholder, such as Chief Comptroller. maxLength: 255 minLength: 0 type: string token: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string uses_parent_account: default: false description: Indicates whether the child shares balances with the parent (`true`), or the child's balances are independent of the parent (`false`). type: boolean zip: description: United States ZIP code of the cardholder's address. maxLength: 10 minLength: 0 type: string required: - created_time - last_modified_time type: object visa_click_to_pay_billing_address: description: Billing address for Visa Click to Pay. properties: address1: description: First line of the billing address. maxLength: 64 minLength: 1 type: string address2: description: Optional second line of the billing address. maxLength: 64 minLength: 1 type: string city: description: City of the billing address. maxLength: 32 minLength: 1 type: string country: description: Country of the billing address. maxLength: 3 minLength: 3 type: string postalCode: description: Postal code of the billing address. maxLength: 9 minLength: 1 type: string state: description: State of the billing address. maxLength: 3 minLength: 1 type: string required: - country type: object visa_click_to_pay_card: description: Card information for Visa Click to Pay. properties: billingAddress: $ref: '#/components/schemas/visa_click_to_pay_billing_address' cardToken: description: Unique identifier of the card. maxLength: 36 minLength: 1 type: string nameOnCard: description: Name of the cardholder that appears on the card. maxLength: 120 minLength: 1 type: string required: - billingAddress - cardToken - nameOnCard type: object click_to_pay_enroll_request: properties: basic_auth_password: description: 'Basic auth password to access your callback URL if authentication type is basic. If authentication type is basic, both username and password are required.' maxLength: 50 minLength: 20 type: string basic_auth_username: description: 'Basic auth username to access your callback URL if authentication type is basic. If authentication type is basic, both username and password are required.' maxLength: 50 minLength: 1 type: string callback_authentication_type: description: 'The type of authentication required for the callback URL. * `OAUTH_BEARER_TOKEN`: OAuth bearer token for the callback URL. * `BASIC_AUTH`: Basic auth username and password for the callback URL.' enum: - OAUTH_BEARER_TOKEN - BASIC_AUTH type: string callback_secret_for_signature: description: 'Randomly chosen string used for implementing HMAC-SHA1. HMAC-SHA1 provides an added layer of security by authenticating the message and validating message integrity. Using this functionality requires that your callback endpoint verify the message signature. For information about implementing this functionality, see <>.' maxLength: 50 minLength: 20 type: string callback_url: description: The URL to which the Click to Pay request status is sent via webhooks. type: string card_token: description: Unique identifier of the card resource. maxLength: 36 minLength: 1 type: string locale_country: description: 'The user-provided country code. The ISO 3166 country code is a two-letter country code that represents a country. For example, the numeric code for the United States is `US`. The ISO maintains the link:https://www.iso.org/iso-3166-country-codes.html[ISO-3166 country codes, window="_blank"].' maxLength: 2 minLength: 2 type: string locale_language: description: 'The user-provided language choice. The ISO 639-2 language code is a two-letter country code that represents a language. The ISO maintains the link:https://id.loc.gov/vocabulary/iso639-2.html[ISO 639-2 language codes, window="_blank"].' maxLength: 2 minLength: 2 type: string oauth_bearer_token: description: OAuth bearer token to access your callback URL if the `callback_authentication_type` is `OAUTH_BEARER_TOKEN`. type: string user_details: description: User's email address and mobile phone number with country code. items: $ref: '#/components/schemas/click_to_pay_enroll_request_user_details' type: array user_token: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - card_token - locale_country - locale_language - user_details - user_token type: object visa_click_to_pay_consumer_information: description: Object containing cardholder details for Visa Click to Pay operation. properties: countryCode: description: Country code of the cardholder. type: string emails: description: Email addresses of the cardholder. items: type: string type: array externalConsumerID: description: Unique identifier of the cardholder. type: string firstName: description: First name of the cardholder. type: string lastName: description: Last name of the cardholder. type: string locale: description: Language and country in which the Visa Click to Pay service communicates with the cardholder, in ISO-639-1 format. type: string middleName: description: Middle name of the cardholder. type: string phones: description: Phone numbers of the cardholder. items: type: string type: array state: description: State of the cardholder. type: string type: object click_to_pay_enroll_request_user_details: description: User's email address and mobile phone number with country code. properties: email_address: description: User's email address. type: string mobile_number: $ref: '#/components/schemas/click_to_pay_enroll_request_user_mobile_number' required: - email_address - mobile_number type: object ads_transaction_detail: description: Details of the transaction associated with the Alias. properties: currencyCode: description: The currency code for the transaction in link:https://www.iso.org/iso-4217-currency-codes.html[ISO 4217 (Alpha-3), window=“_blank”] format. maxLength: 3 minLength: 3 type: string type: object digital_wallet_samsung_pay_provision_request: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string device_id: description: User's Samsung device unique identifier, as provided by Samsung during the provisioning process. maxLength: 24 minLength: 1 type: string device_type: description: Type of device into which the digital wallet token will be provisioned. enum: - MOBILE_PHONE - WATCH - TABLET - WEARABLE_DEVICE - HOUSEHOLD_DEVICE - AUTOMOBILE_DEVICE type: string provisioning_app_version: description: 'Version of the application making the provisioning request. Used for debugging and fraud prevention.' maxLength: 50 minLength: 1 type: string wallet_user_id: description: User's Samsung Wallet account ID, as provided by Samsung during the provisioning process. maxLength: 50 minLength: 1 type: string required: - card_token - device_id - device_type - provisioning_app_version - wallet_user_id type: object digital_wallet_apple_pay_provision_request: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string certificates: description: '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.' items: description: '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.' type: string type: array device_type: description: Type of device into which the digital wallet token will be provisioned. enum: - MOBILE_PHONE - WATCH - TABLET - WEARABLE_DEVICE - HOUSEHOLD_DEVICE - AUTOMOBILE_DEVICE type: string nonce: description: One-time-use nonce provided by Apple for security purposes. type: string nonce_signature: description: Apple-provided signature to the nonce. type: string provisioning_app_version: description: 'Version of the application making the provisioning request. Used for debugging and fraud prevention.' maxLength: 50 minLength: 1 type: string required: - card_token - certificates - device_type - nonce - nonce_signature - provisioning_app_version type: object android_push_tokenize_request_data: description: Contains details about a card tokenization push request. properties: display_name: description: 'Name of the card as displayed in the digital wallet, typically showing the card brand and last four digits of the primary account number (PAN). `Visa 5678`, for example.' type: string last_digits: description: Last four digits of the primary account number of the physical or virtual card. type: string network: description: Specifies the card network of the physical or virtual card. type: string opaque_payment_card: description: Encrypted data field created by the issuer and passed to Google Wallet during the push provisioning process. type: string token_service_provider: description: Specifies the network that provides the digital wallet token service. type: string user_address: $ref: '#/components/schemas/AndroidPushTokenRequestAddress' type: object ads_get_by_external_id_request: description: Request to get a Visa Alias by external ID. properties: externalId: description: External ID of the Visa Alias. maxLength: 100 minLength: 1 type: string type: description: 'Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials.' enum: - ALIAS - PAYMENT_CREDENTIAL type: string required: - externalId - type type: object digital_wallet_apple_pay_provision_response: properties: activation_data: description: Cryptographic one-time passcode conforming to the payment network operator or service provider specifications. type: string card_token: description: Unique identifier of the card resource to use for the provisioning request. type: string created_time: description: Date and time when the digital wallet provisioning request was created, in UTC. format: date-time type: string encrypted_pass_data: description: Payload encrypted with a shared key derived from the Apple Public Certificates and the generated ephemeral private key. type: string ephemeral_public_key: description: Ephemeral public key used for the provisioning attempt. type: string last_modified_time: description: Date and time when the digital wallet token provisioning request was last updated, in UTC. format: date-time type: string required: - activation_data - card_token - created_time - encrypted_pass_data - ephemeral_public_key - last_modified_time type: object visa_click_to_pay_intent: description: Intent of the Visa Click to Pay operation. properties: type: description: Type of the operation. enum: - PRODUCT_CODE type: string value: description: Value of the operation. enum: - CLICK_TO_PAY type: string required: - type - value type: object ads_create_report_request: description: ADS create report request. properties: filters: $ref: '#/components/schemas/ads_report_filters' format: description: The format of the report maxLength: 36 minLength: 1 type: string reportType: description: Indicates the type of report. enum: - DIRECTORY_STATUS - PLATFORM_REQUESTS - RESOLUTION_RECONCILIATION - DIRECTORY_ACTIVITY - PAYMENT_CREDENTIAL_DETAILS type: string required: - filters - format - reportType type: object digital_wallet_token_transition_request: properties: channel: description: Mechanism by which the transition was initiated. enum: - TOKEN_SERVICE_PROVIDER - TOKEN_SERVICE_PROVIDER_API - DIGITAL_WALLET - API - IVR - FRAUD - ADMIN - SYSTEM type: string digital_wallet_token: $ref: '#/components/schemas/digital_wallet_token_hash' reason: description: The reason for the transition. maxLength: 255 minLength: 0 type: string reason_code: description: 'Standard code describing the reason for the transition. *NOTE:* This field is required if your program uses v2 of the `user_card_state_version`, which is a program-specific configuration value that is managed by Marqeta and cannot be accessed via the API. To learn more about the `user_card_state_version` program configuration, contact your Marqeta representative. * *00:* Object activated for the first time * *01:* Requested by you * *02:* Inactivity over time * *03:* This address cannot accept mail or the addressee is unknown * *04:* Negative account balance * *05:* Account under review * *06:* Suspicious activity was identified * *07:* Activity outside the program parameters was identified * *08:* Confirmed fraud was identified * *09:* Matched with an Office of Foreign Assets Control list * *10:* Card was reported lost * *11:* Card information was cloned * *12:* Account or card information was compromised * *13:* Temporary status change while on hold/leave * *14:* Initiated by Marqeta * *15:* Initiated by issuer * *16:* Card expired * *17:* Failed KYC * *18:* Changed to `ACTIVE` because information was properly validated * *19:* Changed to `ACTIVE` because account activity was properly validated * *20:* Change occurred prior to the normalization of reason codes * *21:* Initiated by a third party, often a digital wallet provider * *22:* PIN retry limit reached * *23:* Card was reported stolen * *24:* Address issue * *25:* Name issue * *26:* SSN issue * *27:* DOB issue * *28:* Email issue * *29:* Phone issue * *30:* Account/fulfillment mismatch * *31:* Other reason * *32:* Unblock request * *86:* Notification of death' enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - 08 - 09 - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string state: description: 'Specifies the state to which the digital wallet token will transition. The original state is `REQUESTED`. You cannot modify the state if its current value is either `REQUEST_DECLINED` or `TERMINATED`.' enum: - ACTIVE - SUSPENDED - TERMINATED type: string token: description: 'The unique identifier of the digital wallet token transition (not the identifier of the digital wallet token itself). If you do not include a value for the `token` field, the system will generate one automatically. This value is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.' maxLength: 36 minLength: 1 type: string token_reference_id: description: 'The unique identifier of the digital wallet token within the card network. The `token_reference_id` is unique at the card network level.' type: string required: - digital_wallet_token - state type: object error_message_from_web_push_provisioning_request: properties: error_code: description: Code for the error that occurred. example: '400401' type: string error_message: description: Descriptive error message. example: 'Invalid input(s): invalid user token' type: string required: - error_code - error_message type: object samsung_push_tokenize_request_data: description: Contains details about a card tokenization push request. properties: card_type: description: Specifies the type of card. type: string display_name: description: 'Name of the card as displayed in the digital wallet, typically showing the card brand and last four digits of the primary account number (PAN). `Visa 5678`, for example.' type: string extra_provision_payload: description: Encrypted card or cardholder details. type: string last_digits: description: Last four digits of the primary account number of the physical or virtual card. type: string network: description: Specifies the card network of the physical or virtual card. type: string token_service_provider: description: Specifies the network that provides the digital wallet token service, as determined by the Samsung Wallet library. type: string type: object ads_billing_address: description: Billing address for the payment credential. properties: addressLine1: description: Address line 1 of the billing address associated with the payment credential. maxLength: 99 minLength: 0 type: string addressLine2: description: Address line 2 of the billing address associated with the payment credential. maxLength: 99 minLength: 0 type: string buildingNumber: description: Building number of the billing address associated with the payment credential. maxLength: 60 minLength: 1 type: string city: description: City of the billing address associated with the payment credential. maxLength: 35 minLength: 1 type: string country: description: 'Country of the billing address associated with the payment credential, expressed as an ISO 3166 code. For example, the numeric code for the United States is `840` and the alpha-3 code is `USA`. The ISO maintains the link:https://www.iso.org/iso-3166-country-codes.html[full list of ISO 3166 country codes, window="_blank"].' maxLength: 3 minLength: 3 type: string minorSubdivision: description: Minor subdivision of the billing address associated with the payment credential. maxLength: 50 minLength: 1 type: string postalCode: description: Postal code of the billing address associated with the payment credential. maxLength: 16 minLength: 1 type: string state: description: State of the billing address associated with the payment credential. maxLength: 16 minLength: 1 type: string streetName: description: Street name of the billing address associated with the payment credential. maxLength: 60 minLength: 1 type: string required: - country type: object Authentication: description: Contains the cardholder's email address and password information. properties: email_verified: default: false description: Specifies whether the email address has been verified. type: boolean email_verified_time: description: Date and time when the email address was verified. format: date-time type: string last_password_update_channel: description: Specifies the channel through which the password was last changed. enum: - USER_CHANGE - USER_RESET type: string last_password_update_time: description: Date and time when the password was last changed. format: date-time type: string type: object ads_profile: description: Alias Directory Service (ADS) profile information. properties: contactInfo: description: 'Contact information in the Alias Directory Service (ADS) profile. This array is returned if the Visa Alias'' contact information details exist.' items: $ref: '#/components/schemas/ads_contact_info' maxItems: 2 minItems: 0 type: array dateOfBirth: description: 'Date of birth in the Alias Directory Service (ADS) profile. This field is returned if it exists in the resource.' format: date maxLength: 10 minLength: 10 pattern: ^\d\d\d\d\-\d\d\-\d\d$ type: string firstName: description: First name in the Alias Directory Service (ADS) profile. maxLength: 35 minLength: 1 type: string firstNameLocal: description: 'First name in the Alias Directory Service (ADS) profile, expressed in the user''s local language. This field is returned if it exists in the resource.' maxLength: 35 minLength: 1 type: string lastName: description: 'Last name in the Alias Directory Service (ADS) profile. Participants in the CEMEA and EU regions must only use the initial of the consumer’s last name followed by a period to create or modify a Visa Alias record.' maxLength: 35 minLength: 1 type: string lastNameLocal: description: 'Last name in the Alias Directory Service (ADS) profile, expressed in the user''s local language. This field is returned if it exists in the resource.' maxLength: 35 minLength: 1 type: string middleName: description: 'Middle name in the Alias Directory Service (ADS) profile. This field is returned if it exists in the resource.' maxLength: 35 minLength: 1 type: string middleNameLocal: description: 'Middle name in the Alias Directory Service (ADS) profile, expressed in the user''s local language. This field is returned if it exists in the resource.' maxLength: 35 minLength: 1 type: string preferredName: description: 'Preferred name in the Alias Directory Service (ADS) profile, as provided by the user. This field is returned if it exists in the resource.' maxLength: 35 minLength: 1 type: string required: - firstName - lastName type: object ads_create_alias_request: properties: aliasType: description: 'Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details.' enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: 'Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included.' maxLength: 128 minLength: 1 type: string consent: $ref: '#/components/schemas/ads_consent' identification: $ref: '#/components/schemas/ads_identification' paymentCredentials: description: 'List of payment credentials associated with the Visa Alias. This array is returned if the Visa Alias exists and one or more payment credentials are linked to it.' items: $ref: '#/components/schemas/ads_card_details_request' maxItems: 10 minItems: 1 type: array profile: $ref: '#/components/schemas/ads_profile' userToken: description: Unique identifier of the user. maxLength: 128 minLength: 1 type: string required: - aliasType - aliasValue - consent - paymentCredentials - profile - userToken type: object ads_alias_inquiry_summary: description: Summary of available Visa Aliases. properties: aliasesFound: description: Number of available Visa Aliases found. maximum: 900 minimum: 0 type: integer aliasesNotFound: description: Number of Visa Aliases not found. maximum: 900 minimum: 0 type: integer aliasesRepeated: description: Number of duplicate Visa Aliases. maximum: 900 minimum: 0 type: integer aliasesTotal: description: Total number of available Visa Aliases. maximum: 900 minimum: 0 type: integer required: - aliasesFound - aliasesNotFound - aliasesRepeated - aliasesTotal type: object visa_click_to_pay_get_user_data_response: description: Response containing the information of a Visa Click to Pay cardholder. properties: data: description: Array of objects containing information of a Visa Click to Pay cardholder items: $ref: '#/components/schemas/visa_click_to_pay_user_data' type: array required: - data type: object ads_create_additional_alias_response: description: Response containing the unique identifier of the additional alias generated by Alias Directory. properties: id: description: UUID generated by Alias Directory, which identifies the Visa Alias. maxLength: 36 minLength: 1 type: string required: - id type: object visa_click_to_pay_enroll_cards_request: description: Request to enroll a card for an existing cardholder. properties: card: $ref: '#/components/schemas/visa_click_to_pay_card' userToken: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - card - userToken type: object device: description: Contains information related to the device being provisioned. properties: device_id: description: Identity number of the device. type: string ip_address: description: Device's IP address. type: string language_code: description: Language the device is configured to use. type: string location: description: Geographic coordinates of the device. type: string name: description: Name of the device. type: string phone_number: description: Device's telephone number. type: string token: description: Unique identifier of the device object. type: string type: description: Type of device being provisioned. type: string type: object visa_click_to_pay_update_card_request: description: Request to update a card for an existing cardholder. properties: card: $ref: '#/components/schemas/visa_click_to_pay_card' userToken: description: Unique identifier of the cardholder. maxLength: 36 minLength: 1 type: string required: - card - userToken type: object ads_report_filters: description: Filters for the report. properties: aliasStatuses: items: enum: - ACTIVE - DISABLED - BLOCKED - EXPIRED - DELETED type: string maxItems: 3 minItems: 1 type: array aliasType: description: 'Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details.' enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string billingEventTypes: items: description: 'The billing event types. Possible values are: aliasInquiry, createAlias, createBatch, createPaymentCredential, createReport, deleteAlias, deletePaymentCredential, getAlias, getAliasId, getAliasOnlineReport, getBatch, getBatchKeys, getBatchResult, getByExternalId, getPaymentCredential, getPaymentCredentials, getReport, getReportFile, resolveAlias, updateAlias, updateAliasStatus, updateBankPaymentCredential.' type: string type: array endDate: description: Date when the report ends in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z type: string startDate: description: Date when the report starts in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z type: string required: - aliasStatuses - aliasType - endDate - startDate type: object request_for_apple_pay_wpp_JWT: properties: card_token: description: Unique identifier of the card resource. example: 5855opl9-abcc-4cb7-a330-xyze5799ea5 type: string req-sys-id: description: 'Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta.' type: string required: - card_token type: object ads_report_file_response: description: The response schema for the ADS report file. properties: operationType: description: The type of the operation type: string operationsCount: description: The number of operations in the report type: integer originatorActorId: description: The Originator Actor Id maxLength: 36 type: string programId: description: The program ID maxLength: 36 type: string statusCode: description: The status code of the operation type: integer type: object ads_cards_response: description: Response containing the payment credentials associated with a Visa Alias Directory Service (ADS) alias. properties: GetPaymentCredentialsResponse: description: 'Response containing the payment credentials associated with a Visa Alias. This array is returned if the Visa Alias exists and one or more payment credentials are linked to it.' items: $ref: '#/components/schemas/ads_card_response' maxItems: 2 minItems: 1 type: array type: object ads_alias_response: description: Visa Alias response object for retrieving information. properties: aliasType: description: 'Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials. This field is returned if it exists in the resource.' enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: 'Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included.' maxLength: 128 minLength: 1 type: string consent: $ref: '#/components/schemas/ads_consent' createdOn: description: Date and time when the Visa Alias was created. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string identification: $ref: '#/components/schemas/ads_identification' lastModifiedOn: description: Date and time when the Visa Alias was last modified. format: date-time maxLength: 24 minLength: 24 pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.000Z$ type: string profile: $ref: '#/components/schemas/ads_profile' status: description: Status of the Visa Alias. enum: - ACTIVE - DISABLED - BLOCKED - EXPIRED type: string type: object wallet_provider_profile: description: Contains information held and provided by the digital wallet provider. properties: account: $ref: '#/components/schemas/account' device_score: description: Score from the device. type: string pan_source: description: Source from which the digital wallet provider obtained the card primary account number (PAN). type: string reason_code: description: 'Reason for the wallet provider''s provisioning decision. * *01* – Cardholder''s wallet account is too new relative to launch. * *02* – Cardholder''s wallet account is too new relative to provisioning request. * *03* – Cardholder''s wallet account/card pair is newer than date threshold. * *04* – Changes made to account data within the account threshold. * *05* – Suspicious transactions linked to this account. * *06* – Account has not had activity in the last year. * *07* – Suspended cards in the secure element. * *08* – Device was put in lost mode in the last seven days for longer than the duration threshold. * *09* – The number of provisioning attempts on this device in 24 hours exceeds threshold. * *0A* – There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours. * *0B* – The card provisioning attempt contains a distinct name in excess of the threshold. * *0C* – The device score is less than 3. * *0D* – The account score is less than 4. * *0E* – Device provisioning location outside of the cardholder''s wallet account home country. * *0G* – Suspect fraud.' type: string recommendation_reasons: description: Array of recommendation reasons from the digital wallet provider. items: type: string type: array risk_assessment: $ref: '#/components/schemas/risk_assessment' type: object visa_click_to_pay_enroll_request: description: Request to enroll a new cardholder and card. properties: card: $ref: '#/components/schemas/visa_click_to_pay_card' user: $ref: '#/components/schemas/visa_click_to_pay_user' required: - card - user type: object ads_alias_inquiry_filter: description: Field and/or value filter to check the availability of the Visa Alias. properties: field: description: Fields used to filter the Visa Aliases. enum: - DIRECTORY_NAME - EXCLUDED_DIRECTORY_NAME - ENTITY_ID type: string value: description: 'Values used to filter the Visa Aliases. Visa Alias values are either an email address or phone number.' items: maxLength: 128 minLength: 1 type: string maxItems: 3 minItems: 1 type: array type: object digital_wallet_x_pay_provision_request: properties: card_token: description: Unique identifier of the card resource to use for the provisioning request. maxLength: 36 minLength: 1 type: string device_id: description: Unique identifier of the user's XPay device, as provided by XPay during the provisioning process. maxLength: 24 minLength: 1 type: string device_type: description: Type of device into which the digital wallet token will be provisioned. enum: - MOBILE_PHONE - WATCH - TABLET - WEARABLE_DEVICE - HOUSEHOLD_DEVICE - AUTOMOBILE_DEVICE type: string provisioning_app_version: description: 'Version of the application making the provisioning request. Used for debugging and fraud prevention.' maxLength: 50 minLength: 1 type: string token_requestor_id: description: 'Unique numerical identifier of the digital wallet token requestor within the card network. These ID numbers map to `token_requestor_name` field values as follows: *Mastercard* * 50110030273 – `APPLE_PAY` * 50120834693 – `ANDROID_PAY` * 50139059239 – `SAMSUNG_PAY` *Visa* * 40010030273 – `APPLE_PAY` * 40010075001 – `ANDROID_PAY` * 40010043095 – `SAMSUNG_PAY` * 40010075196 – `MICROSOFT_PAY` * 40010075338 – `VISA_CHECKOUT` * 40010075449 – `FACEBOOK` * 40010075839 – `NETFLIX` * 40010077056 – `FITBIT_PAY` * 40010069887 – `GARMIN_PAY`' maxLength: 11 minLength: 0 type: string wallet_account_id: description: User's XPay account identifier, as provided by XPay during the provisioning process. maxLength: 50 minLength: 1 type: string required: - card_token - device_id - device_type - provisioning_app_version - token_requestor_id - wallet_account_id type: object digital_wallet_token_metadata: description: Contains additional information about the digital wallet token. properties: cardproduct_preferred_notification_language: description: 'Language specified in the `config.transaction_controls.notification_language` field of the card product: * *ces* – Czech * *deu* – German * *eng* – English * *fra* – French * *grc* – Greek * *ita* – Italian * *nld* – Dutch * *pol* – Polish * *por* – Portuguese * *rou* – Romanian * *spa* – Spanish * *swe* – Swedish By default, notifications are sent in English. The ISO maintains the link:https://www.iso.org/iso-3166-country-codes.html[full list of ISO 3166 two- and three-digit numeric country codes, window="_blank"].' type: string issuer_product_config_id: description: Unique identifier of the product configuration on the Marqeta platform. type: string type: object digital_wallet_token_transition_response: properties: card_swap: $ref: '#/components/schemas/card_swap_hash' channel: description: Mechanism by which the transition was initiated. enum: - TOKEN_SERVICE_PROVIDER - DIGITAL_WALLET - API - IVR - FRAUD - ADMIN - SYSTEM - TOKEN_SERVICE_PROVIDER_API type: string created_time: description: Date and time when the transition was created, in UTC. format: date-time type: string digital_wallet_token: $ref: '#/components/schemas/digital_wallet_token_hash' fulfillment_status: description: Provisioning status of the digital wallet token. enum: - DECISION_RED - DECISION_YELLOW - DECISION_GREEN - REJECTED - PROVISIONED type: string reason: description: Reason for the transition. maxLength: 255 minLength: 0 type: string reason_code: description: 'Standard code describing the reason for the transition: * *00:* Object activated for the first time * *01:* Requested by you * *02:* Inactivity over time * *03:* This address cannot accept mail or the addressee is unknown * *04:* Negative account balance * *05:* Account under review * *06:* Suspicious activity was identified * *07:* Activity outside the program parameters was identified * *08:* Confirmed fraud was identified * *09:* Matched with an Office of Foreign Assets Control list * *10:* Card was reported lost * *11:* Card information was cloned * *12:* Account or card information was compromised * *13:* Temporary status change while on hold/leave * *14:* Initiated by Marqeta * *15:* Initiated by issuer * *16:* Card expired * *17:* Failed KYC * *18:* Changed to `ACTIVE` because information was properly validated * *19:* Changed to `ACTIVE` because account activity was properly validated * *20:* Change occurred prior to the normalization of reason codes * *21:* Initiated by a third party, often a digital wallet provider * *22:* PIN retry limit reached * *23:* Card was reported stolen * *24:* Address issue * *25:* Name issue * *26:* SSN issue * *27:* DOB issue * *28:* Email issue * *29:* Phone issue * *30:* Account/fulfillment mismatch * *31:* Other reason * *32:* Unblock request * *86:* Notification of death' enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - 08 - 09 - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '86' type: string state: description: Specifies the state to which the digital wallet token is transitioning. enum: - REQUESTED - REQUEST_DECLINED - ACTIVE - SUSPENDED - TERMINATED type: string token: description: Unique identifier of the digital wallet token transition, and not the identifier of the digital wallet token itself. maxLength: 36 minLength: 1 type: string type: description: 'Type of digital wallet token transition. `state.activated`, for example.' maxLength: 36 minLength: 0 readOnly: true type: string required: - channel - digital_wallet_token - fulfillment_status - state - token - type type: object ads_update_alias_request: description: Ads update alias request. properties: consent: $ref: '#/components/schemas/ads_consent' identification: $ref: '#/components/schemas/ads_identification' profile: $ref: '#/components/schemas/ads_profile' required: - consent - profile type: object ads_alias_inquiry_request: description: 'Request object that checks for Visa Aliases that are available for alias resolution. One or more Visa Aliases may be available.' properties: aliases: description: List of Visa Aliases to check for availability. items: maxLength: 128 minLength: 1 type: string maxItems: 1000 minItems: 1 type: array filters: description: List of filters to apply in the request to check Visa Alias availability. items: $ref: '#/components/schemas/ads_alias_inquiry_filter' maxItems: 3 minItems: 1 type: array transactionDetails: $ref: '#/components/schemas/ads_transaction_detail' userDetails: $ref: '#/components/schemas/ads_alias_inquiry_user_details' required: - aliases type: object web_push_provisioning_apple_pay_JWT_response: properties: jws: $ref: '#/components/schemas/web_push_provisioning_apple_pay_JWS_model' state: description: 'Unique state associated with the digital wallet token. The Marqeta platform returns a universally unique identifier (UUID) in this field.' example: e2675f06-7e4d-11ec-90d6-0242ac120003 type: string required: - jws - state type: object ads_alias_resolve_request: description: Request object to resolve one or more Visa Aliases. properties: aliasType: description: 'Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details.' enum: - EMAIL - PHONE - DIRECTORY_ALIASID - PAYNAME type: string aliasValue: description: 'Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. *NOTE:* In the E.164 format, the "+" sign is not included.' maxLength: 128 minLength: 1 type: string filters: description: List of filters to apply in the request for Visa Alias resolution. items: $ref: '#/components/schemas/ads_alias_inquiry_filter' maxItems: 3 minItems: 1 type: array transactionDetails: $ref: '#/components/schemas/ads_transaction_detail' userDetails: $ref: '#/components/schemas/ads_alias_inquiry_user_details' required: - aliasType - aliasValue type: object ads_alias_resolve_response: description: Response object to resolve one or more Visa Aliases. properties: directoryName: description: The directory name of the Visa Alias. maxLength: 128 minLength: 1 type: string identification: $ref: '#/components/schemas/ads_identification' paymentCredentials: description: List of payment credentials associated with the Visa Alias. items: $ref: '#/components/schemas/ads_card_response' maxItems: 10 minItems: 0 type: array profile: $ref: '#/components/schemas/ads_profile' required: - profile type: object card_swap_hash: description: Contains identifiers for swapping digital wallet tokens between cards. properties: new_card_token: description: Unique identifier of the new card resource to which the digital wallet tokens are assigned. maxLength: 36 minLength: 1 type: string previous_card_token: description: Unique identifier of the existing card resource that has digital wallet tokens assigned to it. maxLength: 36 minLength: 1 type: string required: - new_card_token - previous_card_token type: object ads_identification: description: Identification of the user associated with the Visa Alias. properties: type: description: Type of identification provided by the user associated with the Visa Alias. enum: - DNI - CE - PASSPORT - PTP - FFPP - FFAA - CCD - COI - PN - CIE - CPF - DL - DPI - NIDN type: string value: description: 'Value of the identification provided by the user associated with the Visa Alias, which is used to validate the user. Passport number, for example.' maxLength: 35 minLength: 1 type: string verificationDetails: $ref: '#/components/schemas/ads_verification_details' required: - type - value type: object click_to_pay_enroll_request_user_mobile_number: description: User's mobile phone number and country code. properties: country_code: description: User's mobile phone number country code only. type: string phone_number: description: User's mobile phone number without country code. type: string required: - country_code - phone_number type: object securitySchemes: mqAppAndAccessToken: scheme: basic type: http