---
title: "apple-pay"
method: GET
path: "/apple-pay"
tags: ["Digital Wallet Endpoints"]
---

# apple-pay

`GET /apple-pay`

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

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ApplePayToken` string
- `ClientAccountID` string
- `ClientControlled` boolean
- `Limit ` integer
- `Offset ` integer

## Response `200`

- object
  - `Success` boolean, required — true if the request was successful, false if it failed
  - `ErrorMessage` string, required — Contains a description of the error if the request failed
  - `CreditCards` object, required — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of the Apple Pay credit cards belonging to the account or client account
    - `0` object
      - `CreditCardHolderName` string, required — Credit card holder's name.
      - `CreditCardNumber` string, required — Masked credit card number.
      - `CreditCardExpiryYear` string, required — Expiry year of the credit card
      - `CreditCardExpiryMonth` string, required — Expiry month of the credit card
      - `CreditCardBrand` string, required — Credit card brand
      - `ApplePayToken` string, required — Apple Pay token.
      - `IsDefault` boolean, required — Is this the VoPay account holder's default credit card
      - `ClientAccountID` string, required — ClientAccountID attached to the credit card.
  - `Pagination` object — Pagination metadata
    - `TotalRecords` string, required — Total number of credit card records in that search range.
    - `Offset` string, required — Use this parameter to set the starting point in the dataset.
    - `Limit` string, required — Limit the number of records that are returned.

---

[API](https://skmtc.net/vopay/apis/accounts.md) · [All operations](https://skmtc.net/vopay/apis/accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vopay/accounts/versions/7033bd231ec7/schema)