v1

latestOpenAPI 3.0.22026-08-061303782.1 MB

Payment Instruments

Create an Apple Pay Session

Create an apple_pay_session to process Apple Pay transactions on the web.

To create an Apple Pay Session, pass the unique validation_url (provided by Apple) while creating an apple_pay_sessions resource. Finix returns a merchantSession object that you can use to create a payment. For more information, see Apple Pay.

post/apple_pay_sessions

Headers

Finix-Versionstring

Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring

Example:application/json

The data type being sent in the request body must be application/json.

Request body

display_namestring

This will be the merchant name shown to users when making a purchase via Apple Pay.

domainstring

The domain (or website) where the buyer is initiating the payment.

merchant_identitystring

The merchant_identity_id used when registering the business with Apple Pay through our registration API.

validation_urlstring

A unique validation URL that will be provided by the Apple SDK front-end for every payment.

Response

Apple Pay Session

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

session_detailsstring

Details about the apple_pay_session that was created.