Initialize Apple Pay payment

post

https://example.com/api/v1/paymentmethods/apple-pay/v1/transactions/initialize

Initialize an Apple Pay transaction. It returns a "details" object that contains the necessary data to render the
Apple Pay button.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Initialize Apple Pay Transaction

URL where the Consumer is redirected to after completing the transaction at its issuing bank or at the chosen payment method.

With this implementation you are responsible to fetch the payment status and incorporated into your site.

reference

string

required

length between 1 and 255

The clients identifier. This value will be sent in the webhook payload alongside the ID you receive as part of the response of a transaction.

description

string

required

length ≤ 255

Description of the underlying value or reason of the payment.
Ultimately appears on the payment confirmation (statement and confirmation screen).

amount

integer

required

1 to 99999999

Denomination in the smallest currency subunit, as for example euro cents.

currency

string

length between 3 and 3

Defaults to EUR

ISO 4217 currency code.

expiresAt

date-time

length ≥ 20

ISO 8601 date and time. If left empty, the value defaults to 10 mins.

language

string

required

length between 2 and 2

Preferred language for the user interface as ISO 639-1 code. Commonly supported languages are Dutch (nl) and English (en).

consumer

object

webhooks

array of objects

Array of webhooks that enables receiving a web request once a given event occurs. We won't do preventive rate-limiting in order to have the highest throughput possible. However, we will honor 429 (Too-many-requests) responses per callback. We use the Retry-After header to retry after a certain period. If the header was not set we use our default exponential delay implementation.

webhooks

Responses

Callback

201Apple Pay transaction details

4XXThe user input was incorrect or something illegal was attempted (eg. using a service without having that service configured for the user, or not being authorized)

5XXInternal server error. This can be caused by an unresponsive backend