The Wallet endpoint provides secure access to saved credit cards and gift cards for a specific account.
| Verb | Endpoint | Description | |
|---|---|---|---|
| GET | /v4/amc-accounts/{accountId}/wallet/views/on-demand | Get a version of the external wallet for use by external billers. |
| Name | Description |
|---|---|
| creditCardCount | The current count of all credit cards. |
| maxCreditCardCount | The maximum number of credit cards that can be stored in the wallet. |
| 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. |
| giftCardSummary.maxCount | The maximum number of gift cards that can be stored in the wallet. |
| 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. |
| disneyCardSummary.maxCount | The maximum number of Disney cards that can be stored in the wallet. |
| _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. |
| 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 |
| Name | Description |
|---|---|
| token | Identifying token for the specific card. |
| 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. |
| verified | A boolean indicating if the card has been verified using a zero dollar authorization |
| verificationNonce | One-time-use reference to card details from the merchant system. |
| 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. |
| Relation | Description | Methods | Templated |
|---|---|---|---|
| self | This credit card. | GET, PUT, DELETE | No |
| Name | Description |
|---|---|
| token | Identifying token for the specific card. |
| balance | The gift card balance. |
| name | The name the account holder gave the gift card. |
| maskedNumber | The gift card number. Values will be masked up to the last four digits. |
| maskedPin | Masked representation of the gift card pin. |
| encryptedNumber | The gift card number in its encrypted form. |
| encryptedPin | The gift card PIN in its encrypted form. |
| 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. |
| balanceInquiryToken | Token for balance inquiry logs. Note: This was formerly named "token" in V3 of the API. |
| 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. |
| Relation | Description | Methods | Templated |
|---|---|---|---|
| self | This gift card. | GET, PUT, DELETE | No |
| Name | Description |
|---|---|
| token | Identifying token for the specific card. |
| 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. |
| Relation | Description | Methods | Templated |
|---|---|---|---|
| self | This Disney card. | GET, PUT, DELETE | No |
| 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 | 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. |
| 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. |
| 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.
|
GET /v4/amc-accounts/123/wallet/views/on-demand
{
"externalWallet": [
{
"id": 111,
"typeID": 10084,
"displayName": "************0001(111)",
"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(222)",
"isPrimary": false,
"BillingAddress": {
"Name": "Visa-0002-2",
"LineOne": "11500 Ash St",
"LineTwo": "Suite 250",
"City": "Leawood",
"State": "KS",
"PostalCode": "66211",
"Country": "USA",
"DefaultBilling": false
}
}
]
}