Retrieve Apple Pay Session

Retrieve the details of an Apple Pay payment session.

Each payment that uses Apple Pay has a unique session.

Prerequisite: Activating Apple Pay

Parameters

Request Header Parameters

Request Body Parameters

- display_name
- The canonical name for the client's business, suitable for display. 64 or fewer UTF-8 characters.
  Relevant to Apple Pay.
- initiative_context
- The client's fully qualified domain name, without the final period. For example, acmegeneralproducts.rapyd.net

Response Parameters

- displayName
- The canonical name of the client's business.
- domainName
- The domain name of the client's ecommerce site.
- epochTimestamp
- Time of creation of the Apple Pay session, in Unix time.
- expiresAt
- Time of expiration of the Apple Pay session, in Unix time.
- merchantIdentifier
- Your Apple Pay merchant ID.
- merchantSessionIdentifier
- Your Apple Pay session ID.
- nonce
- A string that uniquely identifies each call to Apple Pay.
- retries
- The number of previous attempts to get an Apple Pay Session object.
- signature
- Digital signature that validates the authenticity and integrity of a digital wallet payment.

/v1/digital_wallets/session/apple_pay

Retrieve Apple Pay Session

curl -X post
https://sandboxapi.rapyd.net/v1/digital_wallets/session/apple_pay
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-d '{
    "display_name": "Acme General Products",
    "initiative_context": "acmegeneralproducts.rapyd.net"
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "1d6372ba-530d-4195-be1e-ef50d91d0f91"
    },
    "data": {
        "epochTimestamp": 1646630045189,
        "expiresAt": 1646633645189,
        "merchantSessionIdentifier": "SSHAF97FDFD687E4E308A5DF0D252842CCF_916523...",
        "nonce": "7c059ca3",
        "merchantIdentifier": "2CA5870D7643C62D793F32133FFB35E85B69D1E23EEB49EBB989976C4A3F3367",
        "domainName": "www.acmegeneralproducts1234.com",
        "displayName": "Acme General Products",
        "signature": "308006092a864886f70d010702a08...",
        "operationalAnalyticsIdentifier": "name:2CA5870D7643C62D793F32133FFB35E85B69D1E23EEB49EBB989976C4A3F3367",
        "retries": 0
    }
}

Note

In the example response, the merchantSessionIdentifier and signature are truncated.

Related Information

Customizing Hosted Pages with Apple Pay
Refer to this Apple Pay article: Requesting an Apple Pay Payment Session.

In this section:

Documentation