Apple Pay Mobile Wallet Provisioning

Suggest Edits

Endpoint: https://rest.virtualincentives.com/v6/{format}/recipients/{id}/card/digitalwallet/applepay/web/provisioning

Method: POST

📘
This endpoint requires approval prior to access. Please contact your Virtual Incentives Client Success Manager to discuss your use case.

Definitions

Field	Type	Description
id	integer	The unique id for this recipient.
jws	object	Object containing JSON Web Signature (JWS) data. Allowable Values: Existing JWS object
jws.header	object	Contains header data for the JWS object. Allowable Values: Existing kid string
jws.header.kid	string	Unique identifier of the JSON Web Signature (JWS) public key of the key pair used to generate the signature. Allowable Values: Any value
jws.protected	string	Contains header parameters that are integrity-protected by the JSON Web Signature (JWS). Allowable Values: Any value
jws.payload	string	JSON Web Signature (JWS) message payload. Allowable Values: Any value
jws.signature	string	The JSON Web Signature (JWS). Allowable Values: Any value
state	string	Unique state associated with the digital wallet token. The platform returns a universally unique identifier (UUID) in this field. Allowable Values: 255 characters

Examples

Response XML

<recipient>
  <id>12345678</id>
  <jws>
    <header>
      <kid>e9d47f5a-6683-4f2b-b726-2ccb06ce4550</kid>
    </header> 
    <protected>eyJjdHkiOiJhcHBsaWNhdGlvbi9jcmVkZW50aWFsO2NoYXJzZXQ9dXRmLTgiLCJ0eXAiOiJKT1NFK0pTT04iLCJhbGciOiJFUzI1NiJ9</protected>    
    <payload>eyJzdWIiOiJwcm92aXNpb25pbmdUYXJnZXQiLCJhdWQiOiJBcHBsZSIsImxpZCI6ImVuLVVTIiwiaXNzIjoiT1JHLTQzYjRmZjdkLTUwNTItNDRjNC1hZjkyLTc3NjBjMjhjMzdjMyIsImN0aSI6IjIxNmVjODgwLWY5NzEtNDM5Zi04MDQwLThjN2EzNDljY2JkMCIsImV4cCI6IjE3MTY5OTgyOTc4NjYiLCJpYXQiOiIxNzE2OTk0Njk3ODY2IiwianRpIjoiNTcxMjRjNWItM2E0Ny00N2M2LWIwMjgtZTFjYmZhMGJmMGFmIn0</payload>
    <signature>Rv4t1FZ4V9l4ognMGY1PpORP4ezHYaTainZ_1rZGiFr-c47tzKpREQI49CJpesH2zbN-areCIs0lled1n83j1A</signature>
  </jws>
  <state>c35017d0-38eb-4b68-8cbc-a26cb5c2d6b8</state>
</recipient>

Response JSON

{
  "recipient": {
    "id": "12345678",
    "jws": {
      "header": {
        "kid": "e9d47f5a-6683-4f2b-b726-2ccb06ce4550"
      },
      "protected": "eyJjdHkiOiJhcHBsaWNhdGlvbi9jcmVkZW50aWFsO2NoYXJzZXQ9dXRmLTgiLCJ0eXAiOiJKT1NFK0pTT04iLCJhbGciOiJFUzI1NiJ9",
      "payload": "eyJzdWIiOiJwcm92aXNpb25pbmdUYXJnZXQiLCJhdWQiOiJBcHBsZSIsImxpZCI6ImVuLVVTIiwiaXNzIjoiT1JHLTQzYjRmZjdkLTUwNTItNDRjNC1hZjkyLTc3NjBjMjhjMzdjMyIsImN0aSI6IjIxNmVjODgwLWY5NzEtNDM5Zi04MDQwLThjN2EzNDljY2JkMCIsImV4cCI6IjE3MTY5OTkzNzcwNDMiLCJpYXQiOiIxNzE2OTk1Nzc3MDQzIiwianRpIjoiNGQ5MGE5NjQtMTc3Yy00MzYzLWFjZmQtYzJkNGJhZjg5NDNjIn0",
      "signature": "H_CI-HClKW5WeUyGThH79K-3r4fWEM_YFlW_Q5yc5-Iv-vn0BLD9WcmOmF3r3DY3upbgXcSeiLj8uvEGy3XBnQ"
    },
    "state": "71a975a3-c85d-44de-8e08-55765afcab40"
  }
}

Updated 15 days ago