Visa In-App Provisioning is a technology that allows consumers to securely add their Visa payment cards to various mobile applications for use in making purchases. This innovative solution enables users to easily and conveniently link their cards to participating merchants and payment services within the app ecosystem.
openapi: 3.0.1
info:
title: Visa In-App Provisioning
description: ''
version: '1'
servers:
- url: https://sandbox.api.visa.com
description: Sandbox server
security: []
tags:
- name: In-App Provisioning for Apple Pay
description: In-App Provisioning for Apple Pay
- name: In-App Provisioning for Google Pay
description: In-App Provisioning for Google Pay
- name: In-App Provisioning for Samsung Pay
description: In-App Provisioning for Samsung Pay
- name: Universal Card Enrollment
description: Universal Card Enrollment
paths:
/inapp/provisioning/cardData/applePay:
post:
tags:
- In-App Provisioning for Apple Pay
summary: Create Card Data Apple Pay
description: >-
Card data for provisioning a Visa Token in ApplePay using vCardId or
encrypted card as input
operationId: provisionForApplePayUsingPOST
parameters:
- name: apikey
in: query
description: API key from Visa Developer Platform (VDP)
required: true
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: application/json
required: true
style: simple
explode: false
schema:
type: string
- name: x-pay-token
in: header
description: >-
API Key-Shared Secret Authentication. Please refer to
https://developer.visa.com/pages/working-with-visa-apis/x-pay-token
for more details.
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: >-
Create Card Data for ApplePay provisioning using vCardID or Encrypted
Card.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplePayProvisioningRequest'
examples:
Default:
summary: Default
value:
vCardID: v-123-b25dd0af-2960-420b-8aaa-49b3e466c00f
deviceCert: >-
MIID/TCCA6OgAwIBAgIIMq/qUa9Z2nMwCgYIKoZIzj0EAwIwgYAxNDAyBgNVBAMMK0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0gRzIxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xODA2MDEyMjAzMTBaFw0yMDA2MzAyMjAzMTBaMGwxNTAzBgNVBAMMLGVjYy1jcnlwdG8tc2VydmljZXMtZW5jaXBoZXJtZW50X1VDNi1TQU5EQk9YMREwDwYDVQQLDAhBcHBsZVBheTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATGiJjmEMmvOZBGj+tdj2ED7xnc9y1C0vNVaqZva7lvKkbgrfcWdo0/NdIJZ5wDcZ0eBtPuRJ+q/eSP9FLXQ19wo4ICGDCCAhQwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSEtoTMOoZichZZlOgao71I3zrfCzBHBggrBgEFBQcBAQQ7MDkwNwYIKwYBBQUHMAGGK2h0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDMtYXBwbGV3d2RyY2EyMDUwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxld3dkcmNhMi5jcmwwHQYDVR0OBBYEFMNruSHk5gH1LauD+wBI/9sgl/VpMA4GA1UdDwEB/wQEAwIDKDASBgkqhkiG92NkBicBAf8EAgUAMAoGCCqGSM49BAMCA0gAMEUCIQDhL+sL9bcrvAVO3UvswA805EHujfL7iVDrbEuJfOSJoAIgBPKehtuILl9x/SJ5kxReiml1zkJqUB8nTy0UOfUNIIQ=
nonceSignature: >-
QHuLYArUCO2OZevP0rHc99g9RJp4O1dgsZuVpUdlA7zPWqCDhVQo9Mxr1uPS6GVyjZYo3YElIhHRV4Mv3wEJ3hGOaxK1gResup88QWDK1fL0
encCard: >-
eyJraWQiOiJOT0xRRjhHNjE0QkozUVpVNE1CMjExdEg0cURjNWx6Y28tWF94bWNEREZjNGpBRlhjIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.ITlIHG7yOZBXehlNY_WeFTu-6JuP3OVub89MRdYFmnMABEBFKTYrAuDny1ru1HCeI3nP8_xwP88zlk9S4KSKBBYoHme-rEdiRlM-OHNcegEVorElCRCS1yU_C4jJIrexRYmmsr5Kv__7wsyfpVimhBncMsz0JLT33uwk_6WPNd_y7fZOC0p9KiMHX2hlIXkU-EuA_My_SNgoDahEbOFSvab97iYXBz-a7zK-xLk73Jjm90WKGCcxJgmbUdLHJ_FKttcQA5HCliwbzR8DLtJpJMXjicEz3rjrUgKMp-SekVrILHVaie_iDojhW8yRnyjJni_JnD2IBolqcHogTieFdQ.UYTvbk6ha9jwj6_i.g2fejtkRSVaFUvYeUmWJETF5tRkGeN1B5zqATfIpwBZVhICt6M2gEFzHz_0zZtBwuyVIp1hBijtfcIchXrg0dVOb1znO0l3m-iGFcNduByqYwODHfz2yxmOXE0OCHl9HAZY6AGPl5xrqLx03gytJnfHUwDqYtuYL8LDBl-AxaOL73QAc0hBdOgITACKiEudd09TnmwWLhgHytluenOUkIQ-S0SLn2Cu5TqGu2y63L8CHZ8EhFQYE794KuyHtZUAlrNxQDHw5NBQtpuVyMuWWgIZAobI6xznv3BOhskPoSCKVY--nMPeSpBLJ7zjTW1jCgModDoExxUPJasJmu4vUj_rYtmiOhs5YOlxhaAyqnX_eOCHwmUTTVUpKVetQ4T_IxiokRabRi8e0aw.lF9yuWYaGTTCnULlS6KI_A
nonce: kauVuA==
tokenServiceProvider: V
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApplePayProvisioningResponse'
example:
vCardID: v-123-b25dd0af-2960-420b-8aaa-49b3e466c00f
activationData: >-
TUJQQUMtMS1GSy00MDEyMDAuMS0tVERFQS1CMEQwQjcxNDNFN0M1QTc3M0I5MTc1OTA3RENCMUEzRUNCRENCQjJEMzI2MDBEOEY4RTU5OEI5QzE4OTlGNzA3RjFCMDQ2RDY3RDNDREUwMg==
encryptedPassData: >-
V3bICnkm37BmBKEF9FAKK2zh2SvLhe6PqjvJaHS2t0eJaKVL/SfQ8mXOkDN7o4h7ayFmSuBy7A4R9uYWqWdZbo7fc0xOcsQLCgwQdVkW90JHAgL6j9axg26+OxrWyo7T9qm6NBlZzQFAy1oqYmw1tq6QMAEfbv7W6omlZMojl7aJjvzETINq/YXY8Xp76hoMQFsNDpnNfFuAONmCaCm5Vd6a1zW4ULI0SC1OPo8SdiEULTtZQO1XwiMtbD31JkSUhvHAEP2uo9bEeytPQwr82u6lxzzjLhBP30JByQeOJ2y2o/k83XNGanZhlR1yojp9gObw6m/wyj/rfGxMFVhZtzDVFDblgp1NzvCkPx0iyMRTURGLLmzyrLpzwVGIqv39GorEesOL1KtHb15KuwCtawdej3QiL95rPRTW58stEr/PxLh3Bp9AjlV07tJTXdrKNz357j8hLo1AmRv2p8prnZDF0A0j3jn71P68kvwvWhvZ3F+R0sNuC+E16IV1sJrWIlChU4NvcmsLBsv+ewsFqqGquDlpbFc3LuCQhE9PUu6wEGa7Im4e+Cbk79tcg+ZYFS1X4W7sAWLlxM0JzTMWdzSkqydLjiVc9FvoM3gBFrm/1rs7I5CACNg0vyHpXDhPFTM3a9eysWef7qRdTxLIA7CUKDx59r4VTWtGijz1Pwb5uZCnYvZd3i/+T7ra4xZ+9Z6u/nCqfWkZxNTfEfc3NOXte8s=
ephemeralPublicKey: >-
BBSV6JzHhqoS0pLO6xMV6Z5yRhoOnpxaLtdjHxb7pPXpmNGra65K3kvUnlwfRTkWjA7v2+rp+/sK/RhLqLdEGok=
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: >-
Name on Card not Available. The card referenced in this request is
already enrolled but has no nameOnCard value. And, there is no
Customer associated with this card so that the nameOnCard can not be
derived from Customer name.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'502':
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'504':
description: Gateway Timeout
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-samplePayload:
nonce: kauVuA==
encCard: >-
eyJraWQiOiJOT0xRRjhHNjE0QkozUVpVNE1CMjExdEg0cURjNWx6Y28tWF94bWNEREZjNGpBRlhjIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.ITlIHG7yOZBXehlNY_WeFTu-6JuP3OVub89MRdYFmnMABEBFKTYrAuDny1ru1HCeI3nP8_xwP88zlk9S4KSKBBYoHme-rEdiRlM-OHNcegEVorElCRCS1yU_C4jJIrexRYmmsr5Kv__7wsyfpVimhBncMsz0JLT33uwk_6WPNd_y7fZOC0p9KiMHX2hlIXkU-EuA_My_SNgoDahEbOFSvab97iYXBz-a7zK-xLk73Jjm90WKGCcxJgmbUdLHJ_FKttcQA5HCliwbzR8DLtJpJMXjicEz3rjrUgKMp-SekVrILHVaie_iDojhW8yRnyjJni_JnD2IBolqcHogTieFdQ.UYTvbk6ha9jwj6_i.g2fejtkRSVaFUvYeUmWJETF5tRkGeN1B5zqATfIpwBZVhICt6M2gEFzHz_0zZtBwuyVIp1hBijtfcIchXrg0dVOb1znO0l3m-iGFcNduByqYwODHfz2yxmOXE0OCHl9HAZY6AGPl5xrqLx03gytJnfHUwDqYtuYL8LDBl-AxaOL73QAc0hBdOgITACKiEudd09TnmwWLhgHytluenOUkIQ-S0SLn2Cu5TqGu2y63L8CHZ8EhFQYE794KuyHtZUAlrNxQDHw5NBQtpuVyMuWWgIZAobI6xznv3BOhskPoSCKVY--nMPeSpBLJ7zjTW1jCgModDoExxUPJasJmu4vUj_rYtmiOhs5YOlxhaAyqnX_eOCHwmUTTVUpKVetQ4T_IxiokRabRi8e0aw.lF9yuWYaGTTCnULlS6KI_A
vCardID: v-123-b25dd0af-2960-420b-8aaa-49b3e466c00f
deviceCert: >-
MIID/TCCA6OgAwIBAgIIMq/qUa9Z2nMwCgYIKoZIzj0EAwIwgYAxNDAyBgNVBAMMK0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0gRzIxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xODA2MDEyMjAzMTBaFw0yMDA2MzAyMjAzMTBaMGwxNTAzBgNVBAMMLGVjYy1jcnlwdG8tc2VydmljZXMtZW5jaXBoZXJtZW50X1VDNi1TQU5EQk9YMREwDwYDVQQLDAhBcHBsZVBheTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATGiJjmEMmvOZBGj+tdj2ED7xnc9y1C0vNVaqZva7lvKkbgrfcWdo0/NdIJZ5wDcZ0eBtPuRJ+q/eSP9FLXQ19wo4ICGDCCAhQwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSEtoTMOoZichZZlOgao71I3zrfCzBHBggrBgEFBQcBAQQ7MDkwNwYIKwYBBQUHMAGGK2h0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDMtYXBwbGV3d2RyY2EyMDUwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxld3dkcmNhMi5jcmwwHQYDVR0OBBYEFMNruSHk5gH1LauD+wBI/9sgl/VpMA4GA1UdDwEB/wQEAwIDKDASBgkqhkiG92NkBicBAf8EAgUAMAoGCCqGSM49BAMCA0gAMEUCIQDhL+sL9bcrvAVO3UvswA805EHujfL7iVDrbEuJfOSJoAIgBPKehtuILl9x/SJ5kxReiml1zkJqUB8nTy0UOfUNIIQ=
nonceSignature: >-
QHuLYArUCO2OZevP0rHc99g9RJp4O1dgsZuVpUdlA7zPWqCDhVQo9Mxr1uPS6GVyjZYo3YElIhHRV4Mv3wEJ3hGOaxK1gResup88QWDK1fL0
tokenServiceProvider: V
x-name: Create Card Data for Apple Pay using vCardId or encrypted card
x-notes: >-
Card data for provisioning a Visa Token in ApplePay using vCardId or
encrypted card
x-codegen-request-body-name: body
x-operationVersions:
- label: v1 - Latest
operationPointer: '#/paths/~1inapp~1provisioning~1cardData~1applePay/post'
default: false
x-hideTryIt: true
/inapp/provisioning/cardData/googlePay:
post:
tags:
- In-App Provisioning for Google Pay
summary: Create Card Data Google Pay
description: >-
Card data for provisioning a Visa Token in GooglePay using vCardId or
encrypted card as input
operationId: provisionForGooglePayUsingPOST
parameters:
- name: apikey
in: query
description: API key from Visa Developer Platform (VDP)
required: true
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: application/json
required: true
style: simple
explode: false
schema:
type: string
- name: x-pay-token
in: header
description: >-
API Key-Shared Secret Authentication. Please refer to
https://developer.visa.com/pages/working-with-visa-apis/x-pay-token
for more details.
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: >-
Create Card Data for Google Pay provisioning using vCardID or
encrypted card
content:
application/json:
schema:
$ref: '#/components/schemas/GooglePayProvisioningRequest'
examples:
Default:
summary: Default
value:
vCardID: v-123-ac7aa6f4-3d84-4fa1-8243-790a90ea5b02
encCard: >-
eyJraWQiOiJOT0xRRjhHNjE0QkozUVpVNE1CMjExdEg0cURjNWx6Y28tWF94bWNEREZjNGpBRlhjIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.ITlIHG7yOZBXehlNY_WeFTu-6JuP3OVub89MRdYFmnMABEBFKTYrAuDny1ru1HCeI3nP8_xwP88zlk9S4KSKBBYoHme-rEdiRlM-OHNcegEVorElCRCS1yU_C4jJIrexRYmmsr5Kv__7wsyfpVimhBncMsz0JLT33uwk_6WPNd_y7fZOC0p9KiMHX2hlIXkU-EuA_My_SNgoDahEbOFSvab97iYXBz-a7zK-xLk73Jjm90WKGCcxJgmbUdLHJ_FKttcQA5HCliwbzR8DLtJpJMXjicEz3rjrUgKMp-SekVrILHVaie_iDojhW8yRnyjJni_JnD2IBolqcHogTieFdQ.UYTvbk6ha9jwj6_i.g2fejtkRSVaFUvYeUmWJETF5tRkGeN1B5zqATfIpwBZVhICt6M2gEFzHz_0zZtBwuyVIp1hBijtfcIchXrg0dVOb1znO0l3m-iGFcNduByqYwODHfz2yxmOXE0OCHl9HAZY6AGPl5xrqLx03gytJnfHUwDqYtuYL8LDBl-AxaOL73QAc0hBdOgITACKiEudd09TnmwWLhgHytluenOUkIQ-S0SLn2Cu5TqGu2y63L8CHZ8EhFQYE794KuyHtZUAlrNxQDHw5NBQtpuVyMuWWgIZAobI6xznv3BOhskPoSCKVY--nMPeSpBLJ7zjTW1jCgModDoExxUPJasJmu4vUj_rYtmiOhs5YOlxhaAyqnX_eOCHwmUTTVUpKVetQ4T_IxiokRabRi8e0aw.lF9yuWYaGTTCnULlS6KI_A
deviceID: uztEQocBRFrbK5hCgcDbxqw_
clientCustomerID: dead-beef-123
tokenServiceProvider: V
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GooglePayProvisioningResponse'
examples:
Default:
summary: Default
value:
last4: '4008'
vCardID: v-123-ac7aa6f4-3d84-4fa1-8243-790a90ea5b02
opaquePaymentCard: >-
eyJhdWQiOiIxODk5NzZhNi0yZmFjLTRlZDEtOTM0ZS03MjY5NmVhMDgxMzEiLCJraWQiOiJYS1ZYNUlHNTVDWTFRM0FVR0JLQTExbV9VNGR2b2FROVVzZ3lESUxqQjNUempCYmU4IiwiaXNzIjoiODM3NjVhZjUtZGZhZS0zNWI0LTViNGItMWM5OWJhN2EwZDAxIiwidHlwIjoiSk9TRSIsImNoYW5uZWxTZWN1cml0eUNvbnRleHQiOiJTSEFSRURfU0VDUkVUIiwiZW5jIjoiQTI1NkdDTSIsInRhZyI6ImVvN3d5eDFXU29EQVZUWm9jZlc3N3ciLCJpYXQiOjE1ODgyNDM1NjAsImFsZyI6IkEyNTZHQ01LVyIsIml2IjoiaHN5TWwwbEp3Qk5rbWxtUiJ9.GL-_-PaVQ8xQzv7s6VNC4t75dfa7ZzglsvQG1S1BfL8.9W0-tgfN0eOEWnY7.a9XxDeQsDr55HXsHdIOjmdytTvTv3CFDHo668K-fe9Bk6p8eqbSz3QwwbjB3pRdwpBkzhqjqhKW6C-_Fe1RUliN01z648XBLYYW4VGoT1LxS4eCnucTGaTj-J7xTl3MGCCjrnL38sqpXGs-jWgwaHYpjZ4PlMG9dPeLiUxkodArI98Ph953VYHE_0UPLzB-bkUGKc_y86VH8DYuFTxYAE6LAr0J3R5o6Var7YnseUZrXMvQCf_yHisFNjHkCW4EY8xIWEoiK1vYvPJXOHr9KdAYgdFBJKDoCgs3Vb7AuI_zDEh4jNtkSauQuKZUjD_WCNDcSl75xDiSzT1nX3BMcGLXUbaWvzHARqYheZQ_fKQ8D3xI38yTklf0oJVYLE-Id1XuN437ECyaKHtyxz1L3fXk_n4xpD80f3gy_xwqJelzZFtSlZQVhG925YhQsYjKZjNt_pIFz9RYeDPSP8tflMEx3huFRBmbjNXS9c6jdMk6z5kskOci9p0ur4J3gcKqGjetrp-0bVDJYnpr6d1RffiEvXDuRBIaabMjr5iRuxuGCIT0w0_sL9VcClKxg10MoacGXV3jcnYU2XjUe3aqOZJwbwLnQPWn_V3ke7xvdAdd_52rdiaoJ.P3YDNNCCX5sVgD2QVcDGoQ
encAddress: >-
eyJraWQiOiIyRjNDOUZEMyIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.HBI8Vcz7VGXuHLSoPwWKu_X8vVhIZjCxcnk3trpBHPfWv17WeIgtxLMfrBBcZA7sLEESyEPjCsZuuiYtNHQ-CGdQ5XaMVTN2pQNJ8DAk2swELjYU0ukxphosI1WduUZbUUIaCuaUnFxVps8n8QnjHoYcl5S2QCoSjIDAaq6UFhVMPTl5Z8h80VE0BJUufwpFn60ccxflmTFtZcbA03Zib74OJtwBWDYVFqUoPeDVI4-eTyOQVvUNfsFRd6C4wQhbcGsehqnHZpxVV_dadPvv884Udim5Vi8QOFXBE7k9Q-9JZV9VKPtz7TErIP5iWDP0cb2GBu6A6X8RwXIhSfOxcw.mTT0c2QP5L9zJ7ys.GOBZF8wHW9HaSMjuZhvCW1PAl15r616BsbG6LsKt5Uo9rFiKCUnM5mXPKjvFKspmjyDxARVgW1q3mkO4uFGICnFljM5XLBhHHBok9dy_8gm9gGbjT9XeIdEb0-nscXyMeV8MI4e5NvQ1zCw1hAvzSIqqR_xYmN3aLjPoxTE-GZBBDVIw4QUdSlaZfw.TCoV1n8rlJU3hg8_IXbHUQ
expirationDate:
month: '01'
year: '2020'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: >-
Name on Card not Available. The card referenced in this request is
already enrolled but has no nameOnCard value. And, there is no
Customer associated with this card so that the nameOnCard can not be
derived from Customer name.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'502':
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'504':
description: Gateway Timeout
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-samplePayload:
encCard: >-
eyJraWQiOiJOT0xRRjhHNjE0QkozUVpVNE1CMjExdEg0cURjNWx6Y28tWF94bWNEREZjNGpBRlhjIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.ITlIHG7yOZBXehlNY_WeFTu-6JuP3OVub89MRdYFmnMABEBFKTYrAuDny1ru1HCeI3nP8_xwP88zlk9S4KSKBBYoHme-rEdiRlM-OHNcegEVorElCRCS1yU_C4jJIrexRYmmsr5Kv__7wsyfpVimhBncMsz0JLT33uwk_6WPNd_y7fZOC0p9KiMHX2hlIXkU-EuA_My_SNgoDahEbOFSvab97iYXBz-a7zK-xLk73Jjm90WKGCcxJgmbUdLHJ_FKttcQA5HCliwbzR8DLtJpJMXjicEz3rjrUgKMp-SekVrILHVaie_iDojhW8yRnyjJni_JnD2IBolqcHogTieFdQ.UYTvbk6ha9jwj6_i.g2fejtkRSVaFUvYeUmWJETF5tRkGeN1B5zqATfIpwBZVhICt6M2gEFzHz_0zZtBwuyVIp1hBijtfcIchXrg0dVOb1znO0l3m-iGFcNduByqYwODHfz2yxmOXE0OCHl9HAZY6AGPl5xrqLx03gytJnfHUwDqYtuYL8LDBl-AxaOL73QAc0hBdOgITACKiEudd09TnmwWLhgHytluenOUkIQ-S0SLn2Cu5TqGu2y63L8CHZ8EhFQYE794KuyHtZUAlrNxQDHw5NBQtpuVyMuWWgIZAobI6xznv3BOhskPoSCKVY--nMPeSpBLJ7zjTW1jCgModDoExxUPJasJmu4vUj_rYtmiOhs5YOlxhaAyqnX_eOCHwmUTTVUpKVetQ4T_IxiokRabRi8e0aw.lF9yuWYaGTTCnULlS6KI_A
vCardID: v-123-ac7aa6f4-3d84-4fa1-8243-790a90ea5b02
deviceID: uztEQocBRFrbK5hCgcDbxqw_
clientCustomerID: dead-beef-123
tokenServiceProvider: V
x-name: Create Card Data for Google Pay using vCardID or Encrypted Card.
x-notes: >-
Card data for provisioning a Visa Token in GooglePay using vCardID or
Encrypted Card.
x-codegen-request-body-name: body
x-operationVersions:
- label: v1 - Latest
operationPointer: '#/paths/~1inapp~1provisioning~1cardData~1googlePay/post'
default: false
x-hideTryIt: true
/inapp/provisioning/cardData/samsungPay:
post:
tags:
- In-App Provisioning for Samsung Pay
summary: Create Card Data Samsung Pay
description: >-
Card data for provisioning a Visa Token in SamsungPay using vCardId or
encrypted card as input
operationId: provisionForSamsungPayUsingPOST
parameters:
- name: apikey
in: query
description: API key from Visa Developer Platform (VDP)
required: true
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: application/json
required: true
style: simple
explode: false
schema:
type: string
- name: x-pay-token
in: header
description: >-
API Key-Shared Secret Authentication. Please refer to
https://developer.visa.com/pages/working-with-visa-apis/x-pay-token
for more details.
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: >-
Create card data for Samsung Pay provisioning using vCardID or
encrypted card
content:
application/json:
schema:
$ref: '#/components/schemas/SamsungPayProvisioningRequest'
examples:
Default:
summary: Default
value:
vCardID: v-123-ac7aa6f4-3d84-4fa1-8243-790a90ea5b02
encCard: >-
eyJraWQiOiJOT0xRRjhHNjE0QkozUVpVNE1CMjExdEg0cURjNWx6Y28tWF94bWNEREZjNGpBRlhjIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.ITlIHG7yOZBXehlNY_WeFTu-6JuP3OVub89MRdYFmnMABEBFKTYrAuDny1ru1HCeI3nP8_xwP88zlk9S4KSKBBYoHme-rEdiRlM-OHNcegEVorElCRCS1yU_C4jJIrexRYmmsr5Kv__7wsyfpVimhBncMsz0JLT33uwk_6WPNd_y7fZOC0p9KiMHX2hlIXkU-EuA_My_SNgoDahEbOFSvab97iYXBz-a7zK-xLk73Jjm90WKGCcxJgmbUdLHJ_FKttcQA5HCliwbzR8DLtJpJMXjicEz3rjrUgKMp-SekVrILHVaie_iDojhW8yRnyjJni_JnD2IBolqcHogTieFdQ.UYTvbk6ha9jwj6_i.g2fejtkRSVaFUvYeUmWJETF5tRkGeN1B5zqATfIpwBZVhICt6M2gEFzHz_0zZtBwuyVIp1hBijtfcIchXrg0dVOb1znO0l3m-iGFcNduByqYwODHfz2yxmOXE0OCHl9HAZY6AGPl5xrqLx03gytJnfHUwDqYtuYL8LDBl-AxaOL73QAc0hBdOgITACKiEudd09TnmwWLhgHytluenOUkIQ-S0SLn2Cu5TqGu2y63L8CHZ8EhFQYE794KuyHtZUAlrNxQDHw5NBQtpuVyMuWWgIZAobI6xznv3BOhskPoSCKVY--nMPeSpBLJ7zjTW1jCgModDoExxUPJasJmu4vUj_rYtmiOhs5YOlxhaAyqnX_eOCHwmUTTVUpKVetQ4T_IxiokRabRi8e0aw.lF9yuWYaGTTCnULlS6KI_A
clientAppID: VMCPTest
deviceID: uztEQocBRFrbK5hCgcDbxqw_
clientCustomerID: dead-beef-123
tokenServiceProvider: V
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SamsungPayProvisioningResponse'
example:
last4: '3757'
vCardID: v-123-ac7aa6f4-3d84-4fa1-8243-790a90ea5b02
cardType: CREDIT
opaquePaymentCard: >-
eyJhdWQiOiIwNTc3NjFiNy00YmM1LWVkZTktNjRjYy0xM2U4MGNkODkzMDEiLCJraWQiOiJYS1ZYNUlHNTVDWTFRM0FVR0JLQTExbV9VNGR2b2FROVVzZ3lESUxqQjNUempCYmU4IiwiaXNzIjoiODM3NjVhZjUtZGZhZS0zNWI0LTViNGItMWM5OWJhN2EwZDAxIiwidHlwIjoiSk9TRSIsImNoYW5uZWxTZWN1cml0eUNvbnRleHQiOiJTSEFSRURfU0VDUkVUIiwiZW5jIjoiQTI1NkdDTSIsInRhZyI6InNBR0xGNGdjNzRKZWl3Y0RXbXJyWnciLCJpYXQiOjE1ODgyNDM2NzUsImFsZyI6IkEyNTZHQ01LVyIsIml2IjoiWmZQd2QxSFBUTGxRRWRENiJ9.i19152t-dx22C1V7SoLuI216M516IQDCeyZ6-p2emAk.KJy_YLzGIqyQtkkZ.vgVTvD_Nsg3ca_L_5G_zUrVFiaW7hi6Np2HrpOVIayeLWiq17qTmRRhbmbl1Eh1a8E06HIraXeXOenm4zb8qR4sMg6dLhIbXC9oqvbypQpT_FQa5TjpnXDe9QX3U4jMrRPsxfSqhPwvdgIyf61RZtEq8SzeY-CrvlHufmtqED7sP3-e1OCFLvxP-nD56wGTcEW3UYwNHZmXB1u-HIUO8WETBjTZ5klyWQ-SSFkWySqdxASFjSl-jNgzwjxEW_5LX17HyjvwNlEYEdvHlJqVaUwkYD7Zu-S6wUzKHflFevk_rdvl7WyY_Yn5o4EBcz7Sj03vO5HuAE0Zx6HFdNPXP70xkhBz7zk9yklz4lSmHzORn0H8feu1zTK-ycvZiTRlIIZO5wg2F2iO3_MwHnHJzkIBvs82c-fptWXFVdB-14hO2c2_PNQoW-KAHBWyQuVFwm5LVUKl7bFA6CPlkaZqUC3G1AeEUcVj7MaiwQqP0cMARTB8Vr1V7y1tiJKYnlAXEVM4sc7OCvS_NZTGi-UAgqCZmI2rbmxLuZiSBgiAB-WhPN9mH3VpFgUEu16Q5uhtQH5Pvx5Oi0dY_ifakUzU_dc1BITckVVrwCoJTDhNXvfw8BJB41GUB.GHGNmrd5eo5fiL4NxjN5Aw
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'502':
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'504':
description: Gateway Timeout
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-samplePayload:
encCard: >-
eyJraWQiOiJOT0xRRjhHNjE0QkozUVpVNE1CMjExdEg0cURjNWx6Y28tWF94bWNEREZjNGpBRlhjIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.ITlIHG7yOZBXehlNY_WeFTu-6JuP3OVub89MRdYFmnMABEBFKTYrAuDny1ru1HCeI3nP8_xwP88zlk9S4KSKBBYoHme-rEdiRlM-OHNcegEVorElCRCS1yU_C4jJIrexRYmmsr5Kv__7wsyfpVimhBncMsz0JLT33uwk_6WPNd_y7fZOC0p9KiMHX2hlIXkU-EuA_My_SNgoDahEbOFSvab97iYXBz-a7zK-xLk73Jjm90WKGCcxJgmbUdLHJ_FKttcQA5HCliwbzR8DLtJpJMXjicEz3rjrUgKMp-SekVrILHVaie_iDojhW8yRnyjJni_JnD2IBolqcHogTieFdQ.UYTvbk6ha9jwj6_i.g2fejtkRSVaFUvYeUmWJETF5tRkGeN1B5zqATfIpwBZVhICt6M2gEFzHz_0zZtBwuyVIp1hBijtfcIchXrg0dVOb1znO0l3m-iGFcNduByqYwODHfz2yxmOXE0OCHl9HAZY6AGPl5xrqLx03gytJnfHUwDqYtuYL8LDBl-AxaOL73QAc0hBdOgITACKiEudd09TnmwWLhgHytluenOUkIQ-S0SLn2Cu5TqGu2y63L8CHZ8EhFQYE794KuyHtZUAlrNxQDHw5NBQtpuVyMuWWgIZAobI6xznv3BOhskPoSCKVY--nMPeSpBLJ7zjTW1jCgModDoExxUPJasJmu4vUj_rYtmiOhs5YOlxhaAyqnX_eOCHwmUTTVUpKVetQ4T_IxiokRabRi8e0aw.lF9yuWYaGTTCnULlS6KI_A
vCardID: v-123-ac7aa6f4-3d84-4fa1-8243-790a90ea5b02
deviceID: uztEQocBRFrbK5hCgcDbxqw_
clientAppID: VMCPTest
clientCustomerID: dead-beef-123
tokenServiceProvider: V
x-name: Create Card Data for Samsung Pay using vCardID or encrypted card
x-notes: >-
Card data for provisioning a Visa Token in SamsungPay using vCardID or
encrypted card
x-codegen-request-body-name: body
x-operationVersions:
- label: v1 - Latest
operationPointer: '#/paths/~1inapp~1provisioning~1cardData~1samsungPay/post'
default: false
x-hideTryIt: true
/universal/core/customers:
post:
tags:
- Universal Card Enrollment
summary: Create Customer
description: Creates a new `Customer` object for which `Card` object will belong to
operationId: Create Customer
parameters:
- name: apikey
in: query
description: API key from Visa Developer Platform (VDP)
required: true
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: application/json
required: true
style: simple
explode: false
schema:
type: string
- name: x-pay-token
in: header
description: >-
API Key-Shared Secret Authentication. Please refer to
https://developer.visa.com/pages/working-with-visa-apis/x-pay-token
for more details.
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: Enroll `Customer`
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerRequest'
examples:
Default:
summary: Default
value:
lastName: Narayanan
firstName: Shankara Child
encMobileNumber: >-
eyJraWQiOiIyRUkzRE5WU1pHTUFERFlOTUtNMDExd2o3Z2V4WUJILWhOMkpzSFg5NHlkaktjb0VVIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.qlj0Ws5TusSxBPBpt_E7GMIfSqBM2Hrpq_SIDXS8fPy_FwJHdIOrWrK2Kh08aGP1BAVYzLlYBum_r4UljEPfvhFRZdZ9AaHH0e5jgTEIVYazhmn-9q__-2qGoQLwzzJBRwxNS12IoQghPjj6bC5PwevgrjIqsxpdFJFzrrPnCITW1Fj7cLw6yTehCQ1XVdPTDTZIHLVAiUZZxjnAmUuFQILrWRIUafdcmVtsjqrM-8q2ts4WySQmZ3pn3KoEnpIbRlyfOcxi-s5hcBWXAOVYDUYB7qK-Y2dxcelNaa7YD1QipNnYaab6XeNP1hmD4jsn1cc80iZQ-MnkVXxmK316Ig.Xl_o9k8iN2yATW-3.y-nD47IiBTrVURKO5BY9tRryIoB4yk1qelke0JvcfTl2BzPFmcA5ZYHcCo5tMPDjYF8Dk4G6UN2jiA.FJr7P5P4W8b-YZysKqY2nQ
locale: en_US
encEmailAddress: >-
eyJraWQiOiIyRUkzRE5WU1pHTUFERFlOTUtNMDExd2o3Z2V4WUJILWhOMkpzSFg5NHlkaktjb0VVIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.UxcxOPvMDDW8VN1ZBGId5L1DavD5_HTY_Z6EySCBcjziv_Yogq56_K55paab-IC9bHwEDQQ5Fo6S_D34dZws1WDkUa3oQpRaZ3TTyfv2OMz5mVPMwcJU9qPF3V0Y1JKxoThWp2LOkmCgIC9wo3AxWVzlcq0pkDUpauNVXW3HfxXDBtE662g6K4gwSReJgm-pnrUkwA723dgKCPwtyrKkbpq1Fop0poNHB35TGMuc778Psd0r0YauRXY0VhHdJzZBrVekeFQZF3HfpYRP8vqEIAMFrGFJu8smI1O7R_s30YzEgI7rFLtsRPAim4M_3dbuKecHOsGXuE5AmLCq9bBc0Q.mhtgNtKjNGWt5OKo.k6JhkcQ5Pd1RsMVewQ.79s0w1JCEp-nP1mj5qq_nQ
encAddress: >-
eyJraWQiOiIyRUkzRE5WU1pHTUFERFlOTUtNMDExd2o3Z2V4WUJILWhOMkpzSFg5NHlkaktjb0VVIiwiZW5jIjoiQTI1NkdDTSIsImFsZyI6IlJTQS1PQUVQLTI1NiJ9.mULzqjvIqm8W1FuhBizKUDFDPkMxpZZAfzfByXdByvpE89QDWSkri2TONET-9ZXnS-LiYFrF9XAGD_zlMIferi8L1h3FznvLx21KpmpUJZ2LIaMFwryX8QMnOAUqaumkhM46cE1s0O0D6wWnG7jDZpFvxdG-jhSzfEsR_b_lpzvtJuYmIbNXg-a9SRh4-6K-AK-4TCCR6qpJkbNP2NMG9sOq2f8gCfF-G8QejFgpdhb1dwLZcXekdyQMkPSboaua6MGgWq9YhPw5EGMU6DPCM4SqSPoR3QMrD9Ledqn15_3NLtJ6aacLqTVQLgQFo-sk9HfLFJL3MIGsp6GcI_UHCg.cxNahyRxWQ5ZptVh.2NtHwacKBzVaqxVTfB-ES_rIYlRuiLaJbVhAwn5gjj77yMQUNFAGsDrNpa9Wpa-cr7XxOvja3uLgScxoMBQcB7UXCRfptsLkZCh3AhVOh2jbQ29oseQ2BDG1FGyjzDQi3_c7mkPHmQkk6mc_r3jXflzLlx5EjDHk2vJOcaZrmMEfQG508bF5rHpl1xB0W1qnilAaJWlf2JmIBiwJsqvBW6G-_ciYAf9zFIg.4UzBoQ0cjdhtOLfG8WKYxg
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerResponse'
examples:
Default:
summary: Default
value:
lastName: Narayanan
firstName: Shankara Child
vCustomerID: 1189052d-9540-480e-9cc0-f6c26a2a521e
encMobileNumber: >-
eyJraWQiOiIyRjNDOUZEMyIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.iUteJeMnY1nriwEZ7kISWgdDsVEnDUOmRVF4mbCbdeu-mYweOeosG3f3bYEQwMupC5xumUbcdXyF83jMmHT0flIF78XKI5X2-2vviIOynNO6pN8DVHyeh5YfBFQY2ScRX7S7eIkZOqiwyRpHlVN5fdGwze5lsCeol-0P183Q-d8q7M2I07I2yXj04rK1GkhU3e1GO4AzuAKkVGWbd_-83P2GsCzHb4HTVixcAaLUsA1aZYSqJ5tsxSl-GqtgnOS2HRtCXG2R6C6sZ8za9_42joZPjxyLbCO2WECXAoHa7aJgBmLd1Oe5OkvfLqI1JI5CVlErAwIUrHJVEGJKAQ_Pig.vkOURUhUR1yMzgLQ.2Jynq5CLkXx4XM8tXEJ1fZwsAbJOvRN4b5ULVuzBtGHmNcoaPI_DKLAvv5jOl8Y.nFhU1kN4__Ev7JQUsGmOcA
createdDateTime: 1624928382132
locale: en_US
encEmailAddress: >-
eyJraWQiOiIyRjNDOUZEMyIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.ZeuINFxegefC67vwmIJBRHji0aJoQJxM0dhxvfw9OQupFYbkluK9YJf5QLAx72iTHDCd5h8uwrH3bhatvMGyTSq6NxmXGiTHpgbT8v4NWkss06QIeeUcbvEU9ANqEAep2cKtofPfe7viPVPY4eh_25Rojj6YYrCwJdOOat3oCb8eToZwSPEmVrQdCv24ZQ4edlLONUQ6MQHY0JG3avpQFC4J-XrtZ4kyi5tVzs8MuY4MDrw3qs2dmbwYtjKkjufYfsVs3Q6kDo3G9aKxZzHO8XApaOYrIHO3Wjkuf05z_-ufOG7e3J8KXt3ALDpxxDdWoWbs9kA_Qkjx3ZSOJkB1aA.SmqPvAiDtWQo0Uk2.Liwm2YOy_ngJFfDWnYgP.j3icoP-ABgQOW_VvEVX81A
status: ACTIVE
encAddress: >-
eyJraWQiOiIyRjNDOUZEMyIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.qgadplS4Nv47VG9ms1P1WAP0oM9MgIqEVhHMFUv3RxvgVwR9HuHwK3SWhnRfaWqcoMIy34hn2MQs5LNWJ55n1MulH51OIj79EGNzEY-ROv7RPMoBVMnEXkbJJIQG0i4_ZvmfWxTW14_72YjfL3A6Q_DpTpsaduUdYvtVZiAabWSUdjWBIDEffntkmzmGZ237ihZKUg-0RY3FRJlRr6ZaLfAAaFYOuqh22KdY3OAuk-2U4LpdJ9qbBSeVo3OA5CrVRneiO8rJ0tmJVXr3g7t3LCtvMhl3k5FG2t2Lc24fw8oZItoxa_HLy-_5qJTil-eJku5cxn7w8kqYTqNpMlWQAQ.O1BlwNqkFEsKvMLA.Cy8Q7DaedctY8hmRfrrJ3of2KSdGG2k1d-LJeTxGUJN1Hhji9S9beik0CgI_qgAjRyJWyx8usRNmUKQ0twsIyyu8q8lI55tYO6KQA0Q8cb2uZiK6rkC5GyfVHPu17fFnxU6n2BPq1NH2suuoWbYU9IQfrfDlITYII6C2KdThxX0HJWPrZDcvItGBnJZZyqpPnpNCNkYWgnXQUx09UeLT7B3Y9umF99ROjFGYlPpQmaL0drFdB9FrWWcxFknpEQM.7QXIeK9b00szdu6nmnkWJw
updatedDateTime: 1624928382132
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'502':
description: Bad Gateway
content:
# --- truncated at 32 KB (112 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visa/refs/heads/main/openapi/visa-in-app-provisioning.yml