Sign in
Accounts

Retrieve the default payment method of an account

Retrieves the default payment method of the specified customer account.

Notes: <ul><li>This operation also supports retrieving the custom payment method created through the Open Payment Method service. </li></ul> <ul><li>This operation only works with an electronic payment method and does not work with non-electronic payment methods.</li></ul>

get/v1/accounts/{account-key}/payment-methods/default

Path parameters

account-keystring required

Account number or account ID.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

accountVerificationServicestring

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.
bankIdentificationNumberstring

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.

createdBystring

ID of the user who created this payment method.

createdOnstring date-time

The date and time when the payment method was created, in yyyy-mm-dd hh:mm:ss format.

cardNumberstring

The masked credit card number.

When cardNumber is null, the following fields will not be returned:

  • expirationMonth
  • expirationYear
  • accountHolderInfo
creditCardTypestring

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.

Note: This field is only returned for the Credit Card and Debit Card payment types.

deviceSessionIdstring 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.

idstring

The payment method ID.

ipAddressstring nullable

The IP address of the user when the payment method was created or updated.

isDefaultboolean

Indicates whether this payment method is the default payment method for the account.

lastFailedSaleTransactionDatestring nullable

The date of the last failed attempt to collect payment with this payment method.

lastTransactionstring

Indicates the occurrence and status of the last transaction.

lastTransactionTimestring date-time

The time when the last transaction of this payment method happened.

maxConsecutivePaymentFailuresinteger nullable

The number of allowable consecutive failures Zuora attempts with the payment method before stopping.

numConsecutiveFailuresinteger

The number of consecutive failed payments for this payment method. It is reset to 0 upon successful payment.

paymentRetryWindowinteger nullable

The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.

secondTokenIdstring

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.

tokenIdstring

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.

totalNumberOfErrorPaymentsinteger

The number of error payments that used this payment method.

totalNumberOfProcessedPaymentsinteger

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.

updatedBystring

ID of the user who made the last update to this payment method.

updatedOnstring date-time

The last date and time when the payment method was updated, in yyyy-mm-dd hh:mm:ss format.

useDefaultRetryRuleboolean

Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.

IBANstring

The International Bank Account Number used to create the SEPA payment method. The value is masked.

accountNumberstring

The number of the customer's bank account and it is masked.

bankCodestring

The sort code or number that identifies the bank. This is also known as the sort code.

bankTransferTypestring

The type of the Bank Transfer payment method. For example, SEPA.

branchCodestring

The branch code of the bank used for Direct Debit.

businessIdentificationCodestring

The BIC code used for SEPA. The value is masked.

identityNumberstring

The identity number of the account holder or the cardholder.

bankABACodestring

The nine-digit routing number or ABA number used by banks. This field is only required if the type field is set to ACH.

bankAccountNamestring

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.

expirationMonthinteger

One or two digits expiration month (1-12).

expirationYearinteger

Four-digit expiration year.

securityCodestring

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.

BAIDstring

ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.

emailstring

Email address associated with the PayPal payment method.

preapprovalKeystring

The PayPal preapproval key.

googleBINstring

This field is only available for Google Pay payment methods.

googleCardNumberstring

This field is only available for Google Pay payment methods.

googleCardTypestring

This field is only available for Google Pay payment methods.

For Google Pay payment methods on Adyen, the first 100 characters of paymentMethodVariant returned from Adyen are stored in this field.

googleExpiryDatestring

This field is only available for Google Pay payment methods.

googleGatewayTokenstring

This field is only available for Google Pay payment methods.

appleBINstring

This field is only available for Apple Pay payment methods.

appleCardNumberstring

This field is only available for Apple Pay payment methods.

appleCardTypestring

This field is only available for Apple Pay payment methods.

For Apple Pay payment methods on Adyen, the first 100 characters of paymentMethodVariant returned from Adyen are stored in this field.

appleExpiryDatestring

This field is only available for Apple Pay payment methods.

appleGatewayTokenstring

This field is only available for Apple Pay payment methods.

Changes