VOvopay
Digital Wallet Endpoints

apple-pay/link-apple-pay

This endpoint links an Apple Pay payment token to your VoPay account and returns the VoPay token used to charge it. It is called by the iQ11 iframe once the customer has authorized the payment in the Apple Pay sheet, and is authenticated by the IframeKey rather than by account credentials.

post/apple-pay/link-apple-pay

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/apple-pay/link-apple-pay
  • Auth
    none declared

Request body application/x-www-form-urlencoded

IframeKeystring required

The key of the iQ11 iframe the payment was authorized in

PaymentTokenstring required

Apple's PKPayment token as JSON, from the ApplePaySession onpaymentauthorized event. Only the encrypted paymentData member is stored; the token may be sent whole or as paymentData on its own

CardHolderNamestring

Name on the card, from the Apple Pay billing contact

MaskedCardNumberstring

Masked card number, from the Apple Pay payment method display name

CardBrandstring

Card network reported by Apple Pay, for example Visa or MasterCard

Emailstring

Email address from the Apple Pay billing contact

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Tokenstring

The Apple Pay token to charge with apple-pay/charge

Example response

{
  "Success": true,
  "Token": "iq11_a1b2c3d4e5f6"
}

Changes

No recorded changes to this operation across all 1 revision of this API.