v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Digital Wallet Endpoints

apple-pay

This endpoint retrieves a list of Apple Pay credit cards associated with your VoPay account

get/apple-pay

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ApplePayTokenstring

When provided, this endpoint will only return the Apple Pay credit cards associated with this token

ClientAccountIDstring

When provided, this endpoint will only return Apple Pay credit cards associated with this Client Account ID

ClientControlledboolean

When set to true, this endpoint will only return Apple Pay credit cards linked to your VoPay account. When set to false, it will return a list of your customer's Apple Pay tokens.

Limit integer

Limit the number of records that are returned.

Offset integer

Use this parameter to set the starting point in the dataset.

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

Example response

{
  "Success": true,
  "CreditCards": {
    "0": {
      "CreditCardHolderName": "John Smith",
      "CreditCardNumber": "*****1234",
      "CreditCardExpiryYear": "2023",
      "CreditCardExpiryMonth": "12",
      "CreditCardBrand": "visa",
      "ApplePayToken": "ACBDF-GAFSHD-AHBS-123456",
      "IsDefault": true,
      "ClientAccountID": "ClientAccount1"
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}