Wallet

V3

The Wallet endpoint provides secure access to saved credit cards and gift cards for a specific account.


Endpoints

Verb Endpoint Description
GET /v3/amc-accounts/{accountId}/wallet/views/on-demand Get a version of the external wallet for use by external billers.

Wallet Properties

Name Description
giftCardSummary.preferredTender The account holder preferred method of payment.
giftCardSummary.balance The current balance of all gift cards.
giftCardSummary.count The current count of all gift cards.
loyaltySummary.autoSpend A boolean representing if the account holder wishes to always post loyalty payment if available.
loyaltySummary.balance The current balance of all loyalty rewards available for use.
loyaltySummary.number The account holders unique loyalty account number.
disneyCardSummary.preferredTender The account holder preferred method of payment.
disneyCardSummary.balance The current balance of all Disney cards.
disneyCardSummary.count The current count of all Disney cards.
_embedded.CreditCards A list of CreditCard Representations returned.
_embedded.GiftCards A list of GiftCard Representations returned.
_embedded.DisneyCards A list of DisneyCard Representations returned.
_embedded.ExternalCards A list of ExternalCard Representations returned.

Wallet Links

Relation Description Verbs Templated
self This Wallet. GET No
loyalty The account holders loyalty. GET No
creditcards The account holders credit cards. GET No
giftcards The account holders gift cards. GET No
disneycards The account holders Disney cards. GET No

Credit Card


Credit Card Properties

Name Description
cardType The type of credit card.
name The name the account holder gave the credit card.
default A boolean indicating if this is the account holder's preferred credit card.
expirationDate The credit card's expiration date.
lastFour The credit card's last 4 digits.
merchantCustomer The customer id from the merchant system.
merchantToken The token identifier for the credit card from the merchant system.
address1 The main address field for the credit card billing information.
address2 The secondary address field for the credit card billing information.
city The city field for the credit card billing information.
state The state field for the credit card billing information.
postalCode The postalCode code field for the credit card billing information.
cardHolderFirstName The card holder first name if different than the account holder for the credit card billing information.
cardHolderLastName The card holder last name if different than the account holder for the credit card billing information.
cardHolderEmail The card holder email address if different than the account holder for the credit card billing information.


Credit Card Links

Relation Description Methods Templated
self This credit card. GET, PUT, DELETE No

Gift Card


Gift Card Properties

Name Description
balance The gift card balance.
name The name the account holder gave the the gift card.
number The gift card number.
pin The gift card pin.
qrCode The gift card qr code.
imageUrl The Url for the location of the image on the gift card
merchantToken The token identifier for the gift card from the merchant system.
status Indicator to show whether or not the gift card is usable.
address1 The main address field for the gift card billing information.
address2 The secondary address field for the gift card billing information.
city The city field for the gift card billing information.
state The state field for the gift card billing information.
postalCode The postalCode code field for the gift card billing information.


Gift Card Links

Relation Description Methods Templated
self This gift card. GET, PUT, DELETE No

Disney Card


Disney Card Properties

Name Description
balance The Disney card balance.
name The name the account holder gave the the Disney card.
lastFour The Disney card number last 4 digits.
merchantToken The token identifier for the Disney card from the merchant system.
status Indicator to show whether or not the Disney card is usable.
address1 The main address field for the disney card billing information.
address2 The secondary address field for the disney card billing information.
city The city field for the disney card billing information.
state The state field for the disney card billing information.
postalCode The postalCode code field for the disney card billing information.


Disney Card Links

Relation Description Methods Templated
self This Disney card. GET, PUT, DELETE No

External Card


External Card Properties

Name Description
id The external card id (account stored tender type id).
typeID Represents the tender type of the external card.
displayName The display name seen by external users.
isPrimary Whether or not the external card is primary.
billingAddress The billing address for the external card.
  • name
  • lineOne
  • lineTwo
  • city
  • state
  • postalCode
  • country
  • defaultBilling

External Bill Sale


External Bill Sale Properties

Name Description
referenceId Transaction reference identifier.
subscriberExternalReference External reference of the subscriber (amc account id).
saleAmount Amount of sale transaction charged to this external bill payment method.
_embedded.External Bill A External Bill Representation returned.

External Bill Credit


External Bill Credit Properties

Name Description
referenceId Transaction reference identifier.
subscriberExternalReference External reference of the subscriber (amc account id).
saleAmount Amount of credit transaction charged to this external bill payment method.
_embedded.External Bill A External Bill Representation returned.

External Bill


External Bill Properties

Name Description
accountNumber The external card id (account stored tender type id).
externalBillType Represents the tender type of the external biller.
referenceId Transaction reference identifier.
billingAddress The billing address for the external biller.
  • name
  • lineOne
  • lineTwo
  • city
  • state
  • postalCode
  • country
  • defaultBilling


Examples

Get a version of the external wallet for use by external billers
GET  /v3/amc-accounts/123/wallet/views/on-demand

Response

{
  "externalWallet": [
    {
      "id": 111,
      "typeID": 10084,
      "displayName": "************0001",
      "isPrimary": true,
      "BillingAddress": {
        "Name": "Visa-0001-1",
        "LineOne": "11500 Ash St",
        "LineTwo": "Suite 250",
        "City": "Leawood",
        "State": "KS",
        "PostalCode": "66211",
        "Country": "USA",
        "DefaultBilling": true
      }
    },
    {
      "id": 222,
      "typeID": 10087,
      "displayName": "************0002",
      "isPrimary": false,
      "BillingAddress": {
        "Name": "Visa-0002-2",
        "LineOne": "11500 Ash St",
        "LineTwo": "Suite 250",
        "City": "Leawood",
        "State": "KS",
        "PostalCode": "66211",
        "Country": "USA",
        "DefaultBilling": false
      }
    }
  ]
}