# Visa In-App Provisioning Enable push provisioning to pay wallets from client mobile app ## Version: 1 ### Servers | URL | Description | | --- | ----------- | | https://sandbox.api.visa.com | Sandbox server | --- ## In-App Provisioning for Apple Pay In-App Provisioning for Apple Pay ### [POST] /inapp/provisioning/cardData/applePay **Create Card Data Apple Pay** Card data for provisioning a Visa Token in ApplePay using vCardId or encrypted card as input #### Parameters | Name | Located in | Description | Required | Schema | Style | Explode | | ---- | ---------- | ----------- | -------- | ------ | ----- | ------- | | apikey | query | API key from Visa Developer Platform (VDP) | Yes | string | form | Yes | | Content-Type | header | application/json | Yes | string | simple | No | | x-pay-token | header | API Key-Shared Secret Authentication. Please refer to https://developer.visa.com/pages/working-with-visa-apis/x-pay-token for more details. Resource path to be used while building x-pay-token must be 'provisioning/cardData/applePay'. | Yes | string | simple | No | #### Request Body Create Card Data for ApplePay provisioning using vCardID or Encrypted Card. | Required | Schema | | -------- | ------ | | Yes | **application/json**: { **"nonce"**: string, **"encCard"**: string, **"vCardID"**: string, **"deviceCert"**: string, **"productType"**: string, **"signingKeyID"**: string, **"nonceSignature"**: string, **"tokenServiceProvider"**: string,
**Available values:** "V", "M" }
| #### Responses | Code | Description | Schema | | ---- | ----------- | ------ | | 200 | OK | **application/json**: { **"vCardID"**: string, **"activationData"**: string, **"encryptedPassData"**: string, **"ephemeralPublicKey"**: string, **"paymentAccountReference"**: string }
| | 400 | Bad Request | **application/json**: { **"errorResponse"**: { **"reason"**: string, **"status"**: integer, **"details"**: [ { **"message"**: string, **"location"**: string } ], **"message"**: string } }
| | 401 | Unauthorized | **application/json**: { **"errorResponse"**: { **"reason"**: string, **"status"**: integer, **"message"**: string } }
| | 403 | Forbidden | **application/json**: { **"errorResponse"**: { **"reason"**: string, **"status"**: integer, **"message"**: string } }
| | 422 | 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. | **application/json**: { **"errorResponse"**: { **"reason"**: string, **"status"**: integer, **"message"**: string } }
| | 502 | Bad Gateway | **application/json**: { **"errorResponse"**: { **"reason"**: string, **"status"**: integer, **"message"**: string } }
| | 503 | Service Unavailable | **application/json**: { **"errorResponse"**: { **"reason"**: string, **"status"**: integer, **"message"**: string } }
| | 504 | Gateway Timeout | **application/json**: { **"errorResponse"**: { **"reason"**: string, **"status"**: integer, **"message"**: string } }
| --- ### Schemas #### ValidationErrorResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorResponse | { **"reason"**: string, **"status"**: integer, **"details"**: [ { **"message"**: string, **"location"**: string } ], **"message"**: string } | | No | #### ApplePayProvisioningResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | vCardID | string | Visa-defined unique ID of the card to produce the provisioning card data for. | Yes | | activationData | string | Activation data consisting of encrypted nonce, noncesignature, and authCode in base64 format. | Yes | | encryptedPassData | string | Authentication data consisting of encrypted PAN, expiry and datetime in base64 format. | Yes | | ephemeralPublicKey | string | VISA.ECC.ePK generated while creating MBPAD encryptedInformation. EC point with P-256 curve and uncompressed format. Base64 format. | Yes | | paymentAccountReference | string | Payment Account Reference (PAR) is a unique reference value associated with a specific cardholder PAN. | No | #### ApplePayProvisioningRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | nonce | string | 32 digit random number generated by Apple. | Yes | | encCard | string |

Conditional.

Either of vCardId or encCard is required.

vCardId will take precedence in case both vCardId and encCard is part of the request body.

Encrypted CardInfo

Example

{   "accountNumber": "4000000000000000",   "nameOnCard": "Digital Issuance",   "cvv2": "123",   "expirationDate": {       "month": "01",       "year": "2021"   },   "billingAddress": {     "name": "Digital Issuance",     "line1": "12301 Research Boulevard",     "line2": "Research Boulevard",     "line3": "Visa USA",     "city": "Austin",     "state": "TX",     "countryCode": "US",     "postalCode": "78759"   } }

CardInfo Schema

FieldTypeDescription
accountNumberstring
required
minLength: 12
maxLength: 18		PAN (Primary Account Number) of the card to be provisioned or enrolled
paymentAccountReferencestring
optional		A Payment Account Reference (PAR) is a unique reference value associated with a specific cardholder PAN
cvv2string
conditional
minLength: 3
maxLength: 3		CVV2 value associated with the PAN on the card
nameOnCardstring
conditional
minLength: 0
maxLength: 256		The full name on the card associated with the issued/enrolled card
expirationDateExpirationDate
required		Card’s expiration date
billingAddressAddress
optional		Billing address associated with the card

ExpirationDate Schema

FieldTypeDescription
monthstring
required
minLength: 2
maxLength: 2		The month that the card is set to expire
yearstring
required
minLength: 4
maxLength: 4		The year that the card is set to expire

Address Schema

FieldTypeDescription
namestring
optional
maxLength: 100		The name of the addressee
line1string
optional
maxLength: 140		First line of the address
line2string
optional
maxLength: 140		Second line of the address
line3string
optional
maxLength: 140		Third line of the address
citystring
optional
maxLength: 100		Name of the city
statestring
conditional		Second part of the “country-subdivision” (State or Province) code in ISO 3166-2 format of the country, eg \\"TX\\"
postalCodestring
optional
minLength: 3
maxLength: 16		The postal code associated with the address, such as zip code
countryCodestring
required		ISO 3166-1 alpha-2 formatted country code associated with the address
| No | | vCardID | string |

Conditional.

Either of vCardId or encCard is required.

Visa-defined unique ID of the card to produce the ApplePay provisioning card data for. vCardId will take precedence in case both vCardId and encCard is part of the request body.

| No | | deviceCert | string | Apple device X.509 certificates received from mobile application. | Yes | | productType | string | Specifies the product type for push provisioning. This value is provided by Apple's team based on the card program. If not specified, it defaults to the Visa/Mastercard default productType value. Visa's default productType is DEFAULT_VISA and Mastercard's default productType is DEFAULT_MASTERCARD. | No | | signingKeyID | string | Token service provider specific signing key identifier | No | | nonceSignature | string | Signature signed by Apple on nonce in SE. | Yes | | tokenServiceProvider | string,
**Available values:** "V", "M" | Indicates which token service provider will process the card data generated for provisioning. The default value is "V".
*Enum:* `"V"`, `"M"` | No | #### Error Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | reason | string | Reason Code for the error condition. Error handling business logic should be driven by this field. | No | | status | integer | 3-digit HTTP Status Code | No | | message | string | Message describing the error condition with additional information wherever applicable. | No | #### ErrorDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | message | string | The specific error for this field. | No | | location | string | The value of this field is using XPATH expression to point to the field, which failed validation. | No | #### ValidationError Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | reason | string | Reason Code for the error condition. Error handling business logic should be driven by this field. | No | | status | integer | 3-digit HTTP Status Code | No | | details | [ { **"message"**: string, **"location"**: string } ] | Array of fields - Data validation errors should use this field to specify which fields failed the validation using location field. | No | | message | string | Message describing the error condition with additional information wherever applicable. | No | #### ErrorResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorResponse | { **"reason"**: string, **"status"**: integer, **"message"**: string } | | No |