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.

FieldDescriptionMandatory?Type
certificateLeaf X.509 certificate in PEM format which is rooted in Apple certificate authority.YesString
nonce‘One-time One-Use’ number generated by Secure Element on device.YesString
nonceSignatureThe signature of Nonce generated on device.YesString

Response Fields

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

FieldDescription
encryptedPassDataAn encrypted JSON file containing the sensitive information needed to add a card to Apple Pay.
activationDataThe request’s activation data.
ephemeralPublicKeyThe ephemeral public key used by elliptic curve cryptography (ECC).