v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Digital Wallet Endpoints

apple-pay/set-my-apple-pay

This endpoint allows you to identify a Apple Pay credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Apple Pay credit card as being the VoPay account holder's default Apple Pay credit card. Note, a VoPay account can only have one default Apple Pay credit card.

post/apple-pay/set-my-apple-pay

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

ApplePayTokenstring required

Apple Pay token

IsDefaultboolean required

Is this the VoPay account holder's default Apple Pay credit card

Example response

{
  "Success": true,
  "ApplePayToken": "ACBDF-GAFSHD-AHBS-123456",
  "IsDefault": true
}