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

Request

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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ApplePayTokenstring required

Apple Pay token

ClientAccountIDstring

Client Account ID

SetAsDefaultboolean

Identify credit card as default Apple Pay credit card

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
}

Changes

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