Skip to content

ApplePay Create session

ApplePay Create session

POST- applepay-session(1)

AUTHORIZATIONS (2)

  1. Sandbox server (uses test data)
    https://api.sandbox.payerly.tech/v1/payments/applepay-session
    Production server (uses live data)
    https://api.payerly.tech/v1payments/applepay-session

  2. BearerAuth

REQUEST BODY SCHEMA: application/json
Parameter Type Description
url required string The URL received from ApplePay JS is intended for validating the merchant payment session
orderId string The ID of the order
Request samples 
  {
      "url": "<https://apple-pay-gateway.apple.com>",
      "orderId": "o-6aXXXX61-XXXX-XXXX-XXXX-375XXXXe4f29"

  }
RESPONSE HEADERS:
Parameter Type Description
Date string(date-time) The Date header indicates the server time.
RESPONSE SCHEMA: application/json
200 
      {
          "epochTimestamp": 1723578013225,
          "expiresAt": 1723581613225,
          "merchantSessionIdentifier": "SSH45...927C24",
          "nonce": "c16a4b97",
          "merchantIdentifier": "9D19B5...9961F6B",
          "domainName": "platformintegrator.example.net",
          "displayName": "TestPaymentPlatform",
          "signature": "308006092a864d........00",
          "operationalAnalyticsIdentifier": "TestPaymentPlatform:9D19....961F6B",
          "retries": 0,
          "pspId": "9D19....1F6B"
      }
400 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
401 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
402 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
403 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
404 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
405 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
429 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }
default 
  {
    "error": {
      "code": 65535,
      "description": "string",
      "traceId": "string",
      "details": [
        {
          "value": "string",
          "description": "string",
          "fields": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ]
        }
      ]      
    }
  }