Stripe users can accept Apple Pay in iOS applications in iOS 9 and above, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the pricing is the same as other card transactions.
openapi: 3.0.0
info:
title: Stripe Apple Pay API
description: >-
Stripe users can accept Apple Pay in iOS applications in iOS 9 and above,
and on the web in Safari starting with iOS 10 or macOS Sierra. There are no
additional fees to process Apple Pay payments, and the pricing is the same
as other card transactions.
contact:
email: dev-platform@stripe.com
name: Stripe Dev Platform Team
url: https://stripe.com
termsOfService: https://stripe.com/us/terms/
version: '2023-10-16'
x-stripeSpecFilename: spec3
security:
- basicAuth: []
- bearerAuth: []
servers:
- url: https://api.stripe.com/
paths:
/v1/apple_pay/domains:
get:
description: <p>List apple pay domains.</p>
operationId: GetApplePayDomains
parameters:
- in: query
name: domain_name
required: false
schema:
maxLength: 5000
type: string
style: form
- description: >-
A cursor for use in pagination. `ending_before` is an object ID that
defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your
subsequent call can include `ending_before=obj_bar` in order to
fetch the previous page of the list.
in: query
name: ending_before
required: false
schema:
maxLength: 5000
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: >-
A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: >-
A cursor for use in pagination. `starting_after` is an object ID
that defines your place in the list. For instance, if you make a
list request and receive 100 objects, ending with `obj_foo`, your
subsequent call can include `starting_after=obj_foo` in order to
fetch the next page of the list.
in: query
name: starting_after
required: false
schema:
maxLength: 5000
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
items:
$ref: '#/components/schemas/apple_pay_domain'
type: array
has_more:
description: >-
True if this list has another page of items after this one
that can be fetched.
type: boolean
object:
description: >-
String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
pattern: ^/v1/apple_pay/domains
type: string
required:
- data
- has_more
- object
- url
title: ApplePayDomainList
type: object
x-expandableFields:
- data
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe List Apple Pay Domains
tags:
- Apple
- Domains
- Lists
- Pay
x-api-evangelist-processing:
ChooseTags: true
post:
description: <p>Create an apple pay domain.</p>
operationId: PostApplePayDomains
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
domain_name:
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
required:
- domain_name
type: object
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/apple_pay_domain'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Create Apple Pay Domain
tags:
- Apple
- Create
- Domain
- Pay
x-api-evangelist-processing:
ChooseTags: true
/v1/apple_pay/domains/{domain}:
delete:
description: <p>Delete an apple pay domain.</p>
operationId: DeleteApplePayDomainsDomain
parameters:
- in: path
name: domain
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/deleted_apple_pay_domain'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Delete Apple Pay Domain
tags:
- Apple
- Delete
- Domain
- Pay
x-api-evangelist-processing:
ChooseTags: true
get:
description: <p>Retrieve an apple pay domain.</p>
operationId: GetApplePayDomainsDomain
parameters:
- in: path
name: domain
required: true
schema:
maxLength: 5000
type: string
style: simple
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/apple_pay_domain'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Retrieve Apple Pay Domain
tags:
- Apple
- Domain
- Pay
- Retrieve
x-api-evangelist-processing:
ChooseTags: true
components:
schemas:
error:
description: An error response from the Stripe API
properties:
error:
$ref: '#/components/schemas/api_errors'
required:
- error
type: object
apple_pay_domain:
description: ''
properties:
created:
description: >-
Time at which the object was created. Measured in seconds since the
Unix epoch.
format: unix-time
type: integer
domain_name:
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: >-
Has the value `true` if the object exists in live mode or the value
`false` if the object exists in test mode.
type: boolean
object:
description: >-
String representing the object's type. Objects of the same type
share the same value.
enum:
- apple_pay_domain
type: string
required:
- created
- domain_name
- id
- livemode
- object
title: ApplePayDomain
type: object
x-expandableFields: []
x-resourceId: apple_pay_domain
deleted_apple_pay_domain:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: >-
String representing the object's type. Objects of the same type
share the same value.
enum:
- apple_pay_domain
type: string
required:
- deleted
- id
- object
title: DeletedApplePayDomain
type: object
x-expandableFields: []
x-resourceId: deleted_apple_pay_domain
securitySchemes:
basicAuth:
description: >-
Basic HTTP authentication. Allowed headers-- Authorization: Basic
<api_key> | Authorization: Basic <base64 hash of `api_key:`>
scheme: basic
type: http
bearerAuth:
bearerFormat: auth-scheme
description: >-
Bearer HTTP authentication. Allowed headers-- Authorization: Bearer
<api_key>
scheme: bearer
type: http
tags:
- name: Apple
- name: Create
- name: Delete
- name: Domain
- name: Domains
- name: Lists
- name: Pay
- name: Retrieve