Request Apple Payload - Field Descriptions

The following page details each of the fields sent in the request and received in the response when using the Request Apple Payload endpoint.

Request Fields

The following table describes fields that can be included in the body of the request when requesting an Apple payload.

Field	Description	Mandatory?	Type
certificate	Leaf X.509 certificate in PEM format which is rooted in Apple certificate authority.	Yes	String
nonce	‘One-time One-Use’ number generated by Secure Element on device.	Yes	String
nonceSignature	The signature of Nonce generated on device.	Yes	String

A successful response for the Request Apple Payload endpoint will return a 200 response.

Field	Description
encryptedPassData	An encrypted JSON file containing the sensitive information needed to add a card to Apple Pay.
activationData	The request’s activation data.
ephemeralPublicKey	The ephemeral public key used by elliptic curve cryptography (ECC).