--- title: "Retrieve the default payment method of an account" method: GET path: "/v1/accounts/{account-key}/payment-methods/default" tags: ["Accounts"] --- # Retrieve the default payment method of an account `GET /v1/accounts/{account-key}/payment-methods/default` Retrieves the default payment method of the specified customer account. **Notes:** ## Path parameters - `account-key` string, required ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Response `200` OK - GETPaymentMethodResponseForAccount — Container for custom fields of a payment method object. - `accountHolderInfo` GETAccountPMAccountHolderInfo — The account holder information. - `accountHolderName` string — The full name of the account holder. - `addressLine1` string — The first line of the address for the account holder. - `addressLine2` string — The second line of the address for the account holder. - `city` string — The city where the account holder stays. - `country` string, nullable — The country where the account holder stays. When creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field. For a complete list of supported country names, see View countries or regions. Internationalization is not supported for the API field value. - `email` string — The email address of the account holder. - `phone` string — The phone number of the account holder. - `state` string — The state where the account holder stays. - `zipCode` string — The zip code for the address of the account holder. - `accountVerificationService` string — Displays the name of the service provider. For example, Plaid. - `accountVerificationStatus` 'Active' | 'Expired' | 'Expiring' | 'Inactive' — Displays the status of the account. **Note:** - `Active` - Access token is active. - `Expired` - Access token has expired and must be linked again. - `Expiring` - Access token will expire in few days(7 days for Plaid) and must be linked again - `Inactive` - The end customer has revoked the account pemission. The end customer can login again and select the same method for the access token to be linked again. - `bankIdentificationNumber` string — The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method. - `createdBy` string — ID of the user who created this payment method. - `createdOn` string, date-time — The date and time when the payment method was created, in `yyyy-mm-dd hh:mm:ss` format. - `cardNumber` string — The masked credit card number. When `cardNumber` is `null`, the following fields will not be returned: - `expirationMonth` - `expirationYear` - `accountHolderInfo` - `creditCardType` string — The type of the credit card or debit card. Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://docs.zuora.com?resourceId=payments-supported-payment-gateways). **Note:** This field is only returned for the Credit Card and Debit Card payment types. - `deviceSessionId` string, nullable — The session ID of the user when the `PaymentMethod` was created or updated. - `existingMandate` 'Yes' | 'No', nullable — Indicates whether the mandate is an existing mandate. - `id` string — The payment method ID. - `ipAddress` string, nullable — The IP address of the user when the payment method was created or updated. - `isDefault` boolean — Indicates whether this payment method is the default payment method for the account. - `lastFailedSaleTransactionDate` string, nullable — The date of the last failed attempt to collect payment with this payment method. - `lastTransaction` string — Indicates the occurrence and status of the last transaction. - `lastTransactionTime` string, date-time — The time when the last transaction of this payment method happened. - `mandateInfo` POSTAccountPMMandateInfo — The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. The following mandate fields are common to all supported payment methods: * `mandateId` * `mandateReason` * `mandateStatus` The following mandate fields are specific to the ACH and Bank Transfer payment methods: * `mandateReceivedStatus` * `existingMandateStatus` * `mandateCreationDate` * `mandateUpdateDate` The following mandate fields are specific to the Credit Card, Apple Pay, and Google Pay payment methods: * `mitTransactionId` * `mitProfileAgreedOn` * `mitConsentAgreementRef` * `mitConsentAgreementSrc` * `mitProfileType` * `mitProfileAction` - `existingMandateStatus` 'Yes' | 'No' — Indicates whether the mandate is an existing mandate. - `mandateCreationDate` string, date — The date on which the mandate was created. - `mandateId` string — The mandate ID. - `mandateReason` string — The reason of the mandate from the gateway side. - `mandateReceivedStatus` 'Yes' | 'No' — Indicates whether the mandate is received from the gateway - `mandateStatus` string — The status of the mandate from the gateway side. - `mandateUpdateDate` string, date — The date on which the mandate was updated. - `mitConsentAgreementRef` string, nullable — Reference for the consent agreement that you have established with the customer. - `mitConsentAgreementSrc` 'External', nullable — Required if you set the `mitProfileAction` field. Specify how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field. - `mitProfileAction` 'Activate' | 'Persist', nullable — Specifies how Zuora creates and activates the stored credential profile. Only applicable if you set the `status` field to `Active`. * `Activate` (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent. Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile. If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`. * `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field. - `mitProfileAgreedOn` string, date, nullable — The date on which the stored credential profile is agreed. The date format is `yyyy-mm-dd`. - `mitProfileType` string, nullable — Indicates the type of the stored credential profile. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field. - `mitTransactionId` string, nullable — Specifies the ID of the transaction. Only applicable if you set the `mitProfileAction` field to `Persist`. - `maxConsecutivePaymentFailures` integer, nullable — The number of allowable consecutive failures Zuora attempts with the payment method before stopping. - `numConsecutiveFailures` integer — The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. - `paymentRetryWindow` integer, nullable — The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours. - `secondTokenId` string — A gateway unique identifier that replaces sensitive payment method data. **Note:** This field is only returned for the Credit Card Reference Transaction payment type. - `status` 'Active' | 'Closed' | 'Scrubbed' — The status of the payment method. - `tokenId` string — A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. **Note:** This field is only returned for the Credit Card Reference Transaction payment type. - `totalNumberOfErrorPayments` integer — The number of error payments that used this payment method. - `totalNumberOfProcessedPayments` integer — The number of successful payments that used this payment method. - `type` 'CreditCard' | 'CreditCardReferenceTransaction' | 'ACH' | 'SEPA' | 'Betalingsservice' | 'Autogiro' | 'Bacs' | 'Becs' | 'Becsnz' | 'PAD' | 'PayPalCP' | 'PayPalEC' | 'PayPalNativeEC' | 'PayPalAdaptive' | 'AdyenApplePay' | 'AdyenGooglePay' | 'GooglePay' — The type of the payment method. - `updatedBy` string — ID of the user who made the last update to this payment method. - `updatedOn` string, date-time — The last date and time when the payment method was updated, in `yyyy-mm-dd hh:mm:ss` format. - `useDefaultRetryRule` boolean — Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings. - `IBAN` string — The International Bank Account Number used to create the SEPA payment method. The value is masked. - `accountNumber` string — The number of the customer's bank account and it is masked. - `bankCode` string — The sort code or number that identifies the bank. This is also known as the sort code. - `bankTransferType` string — The type of the Bank Transfer payment method. For example, `SEPA`. - `branchCode` string — The branch code of the bank used for Direct Debit. - `businessIdentificationCode` string — The BIC code used for SEPA. The value is masked. - `identityNumber` string — The identity number of the account holder or the cardholder. - `bankABACode` string — The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`. - `bankAccountName` string — The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`. - `expirationMonth` integer — One or two digits expiration month (1-12). - `expirationYear` integer — Four-digit expiration year. - `securityCode` string — The CVV or CVV2 security code for the credit card or debit card. Only required if changing expirationMonth, expirationYear, or cardHolderName. To ensure PCI compliance, this value isn''t stored and can''t be queried. - `BAID` string — ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. - `email` string — Email address associated with the PayPal payment method. - `preapprovalKey` string — The PayPal preapproval key. - `googleBIN` string — This field is only available for Google Pay payment methods. - `googleCardNumber` string — This field is only available for Google Pay payment methods. - `googleCardType` string — This field is only available for Google Pay payment methods. For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. - `googleExpiryDate` string — This field is only available for Google Pay payment methods. - `googleGatewayToken` string — This field is only available for Google Pay payment methods. - `appleBIN` string — This field is only available for Apple Pay payment methods. - `appleCardNumber` string — This field is only available for Apple Pay payment methods. - `appleCardType` string — This field is only available for Apple Pay payment methods. For Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. - `appleExpiryDate` string — This field is only available for Apple Pay payment methods. - `appleGatewayToken` string — This field is only available for Apple Pay payment methods. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)