# Retrieve a payment method snapshot

Retrieve the details of a specific Payment Method Snapshot object.

Endpoint: GET /object-query/payment-method-snapshots/{key}
Version: 2026-02-20
Security: bearerAuth

## Header parameters:

  - `Idempotency-Key` (string)
    Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. 

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

  - `Accept-Encoding` (string)
    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-Encoding` (string)
    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-Id` (string)
    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-Ids` (string)
    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-Ids` (string)
    Comma separated IDs. If you have Zuora Multi-Org 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-Version` (string)
    The minor API version.

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

## Path parameters:

  - `key` (string, required)
    Object ID or Number.

## Query parameters:

  - `pageSize` (integer)
    The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

  - `cursor` (string)
    A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

  - `sort[]` (array)
    A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

  - `expand[]` (array)
    Allows you to expand responses by including related object information in a single call.
The Payment Method Snapshot object does not support expanding any related objects.

  - `filter[]` (array)
    A case-insensitive filter on the list.

  - `fields[]` (array)
    A case-insensitive query parameter that allows you to specify which fields are returned in the response.
    Example: "id,createddate"

  - `includeNullFields` (boolean)
    Specifies whether to include fields with the null value in the response.

- If set to true, all fields will be returned in the response, including those with the null value.
- If set to false, only fields with non-null values will be returned.

## Response 200 fields (application/json):

  - `id` (string)
    The unique identifier of the payment method snapshot.

  - `createdById` (string)
    The unique identifier of the user who created the payment method snapshot.

  - `createdDate` (string)
    The time that the payment method snapshot gets created in the system, in the
YYYY-MM-DD HH:MM:SS format.

  - `updatedById` (string)
    The unique identifier of the user who last updated the payment method snapshot.

  - `updatedDate` (string)
    The time that the payment method snapshot gets updated in the system, in the
YYYY-MM-DD HH:MM:SS format.

  - `accountId` (string)
    The unique identifier of the account that the payment method snapshot is
associated with.

  - `achAbaCode` (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.

  - `achAccountName` (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.

  - `achAccountNumberMask` (string)
    The masked bank account number associated with the ACH payment method. This field is only required if the type field is set to ACH.

  - `achAccountType` (string)
    The type of bank account associated with the ACH payment method. This field is only required if the type field is set to ACH.

When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, Checking preferably.
    Enum: "BusinessChecking", "Checking", "Saving"

  - `achAddress1` (string)
    First address line for the ACH payment method.

  - `achAddress2` (string)
    Second address line for the ACH payment method.

  - `achBankName` (string)
    The name of the bank where the ACH payment account is held.

When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.

  - `achCity` (string)
    City for the ACH payment method.

It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.

  - `achCountry` (string)
    Country for the ACH payment method. Must be a valid country name or abbreviation.

See View countries or regions for the list of supported country names and abbreviations.

It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.

  - `achPostalCode` (string)
    Zip code or postal code for the ACH payment method.

  - `achState` (string)
    State for the ACH payment method. Must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region.

  - `active` (boolean)
    Indicates whether the payment method type is active. This field is for Zuora internal use and does not impact customer integration or use cases.

  - `isSystem` (boolean)
    Indicates whether the payment method is a system-generated payment method. This field is for Zuora internal use and does not impact customer integration or use cases.

  - `bankBranchCode` (string)
    The branch code of the bank used for Direct Debit.

  - `bankCheckDigit` (string)
    The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods.

  - `bankCity` (string)
    The city of the direct debit bank.

  - `bankCode` (string)
    The sort code or number that identifies the bank. This is also known as the sort code.

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

  - `bankName` (string)
    The name of the direct debit bank.

  - `bankPostalCode` (string)
    The zip code or postal code of the direct debit bank.

  - `bankStreetName` (string)
    The name of the street of the direct debit bank.

  - `bankStreetNumber` (string)
    The number of the direct debit bank.

  - `bankTransferAccountName` (string)
    The name on the direct debit bank account.

  - `bankTransferAccountNumberMask` (string)
    This is a masked displayable version of the bank account number, used for
security purposes. For example: XXXXXXXXX54321.

  - `bankTransferAccountType` (string)
    The type of the customer's bank account. Applicable to direct debit
payment methods.

  - `bankTransferType` (string)
    Specifies the type of direct debit transfer. The value of this field is dependent on the country of the user.

Possible Values: 


* AutomatischIncasso (NL)

* LastschriftDE (Germany)

* LastschriftAT (Austria)

* DemandeDePrelevement (FR)

* DirectDebitUK (UK)

* Domicil (Belgium)

* LastschriftCH (CH)

* RID (Italy)

* OrdenDeDomiciliacion (Spain)
* Autogiro (Sweden)
* Betalingsservice (Denmark)
    Enum: "AutomatischIncasso", "LastschriftDE", "LastschriftAT", "DemandeDePrelevement", "DirectDebitUK", "Domicil", "LastschriftCH", "RID", "OrdenDeDomiciliacion", "Autogiro", "Betalingsservice"

  - `businessIdentificationCode` (string)
    The business identification code for Swiss direct payment methods that use
the Global Collect payment gateway. Only applicable to direct debit
payment methods in Switzerland with Global Collect.

  - `city` (string)
    The city of the customer's address. Applicable to debit payment methods.

  - `country` (string)
    The two-letter country code of the customer's address. Applicable to direct debit payment methods.

  - `creditCardAddress1` (string)
    The first line of the card holder's address, which is often a street
address or business name. Applicable to credit card and direct debit
payment methods.

  - `creditCardAddress2` (string)
    The second line of the card holder's address. Applicable to credit card
and direct debit payment methods.

  - `creditCardCity` (string)
    The city of the card holder's address. Applicable to credit card and
direct debit payment methods.

  - `creditCardCountry` (string)
    The country where the credit card 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.

  - `creditCardExpirationMonth` (integer)
    One or two digits expiration month.

  - `creditCardExpirationYear` (integer)
    Four-digit expiration year.

  - `creditCardHolderName` (string)
    The full name of the credit card holder.

  - `creditCardMaskNumber` (string)
    The masked credit card number, such as *1112.

  - `creditCardPostalCode` (string)
    The postal code for the address of the credit card holder.

  - `creditCardState` (string)
    The state where the credit card holder stays.

  - `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://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).

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

  - `deviceSessionId` (string)
    The session ID of the user when the PaymentMethod was created or updated.

  - `existingMandate` (string)
    Indicates whether the mandate is an existing mandate.
    Enum: "Yes", "No"

  - `email` (string)
    The email address of the payment method holder.

  - `firstName` (string)
    The customer's first name. Only applicable to direct debit payment methods.

  - `iBAN` (string)
    The International Bank Account Number used to create the SEPA payment method. The value is masked.

  - `iPAddress` (string)
    The IP address of the user when the payment method was created or updated.

  - `identityNumber` (string)
    The identity number of the account holder or the cardholder.

  - `companyName` (string)
    The name of the company.

  - `isCompany` (boolean)
    Whether the customer account is a company.

  - `lastFailedSaleTransactionDate` (string)
    The date of the last failed attempt to collect payment with this payment
method.

  - `lastName` (string)
    The customer's last name. Only applicable to direct debit payment methods.

  - `lastTransactionDateTime` (string)
    The date and time of the most recent transaction.

  - `lastTransactionStatus` (string)
    The status of the most recent transaction.

  - `mandateCreationDate` (string)
    The date on which the mandate was created.

  - `mandateId` (string)
    The mandate ID.

  - `mandateReason` (string)
    The reason of the mandate from the gateway side.

  - `mandateReceived` (string)
    Indicates whether the mandate is received from the gateway.
    Enum: "Yes", "No"

  - `mandateStatus` (string)
    The status of the mandate from the gateway side.

  - `mandateUpdateDate` (string)
    The date on which the mandate was updated.

  - `maxConsecutivePaymentFailures` (integer)
    The number of allowable consecutive failures Zuora attempts with the payment method before stopping.

  - `paymentMethodId` (string)
    ID of the associated payment method.

  - `name` (string)
    The name of the payment method.

  - `numConsecutiveFailures` (integer)
    The number of consecutive failed payments for this payment method. It is reset to 0 upon successful payment.

  - `paymentMethodStatus` (string)
    The status of the payment method.
    Enum: "Active", "Closed", "Scrubbed"

  - `paymentRetryWindow` (integer)
    The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.

  - `paypalBaid` (string)
    ID of a PayPal billing agreement.
    Example: "I-1TJ3GAGG82Y9"

  - `paypalEmail` (string)
    Email address associated with the PayPal payment method.

  - `paypalPreapprovalKey` (string)
    The PayPal preapproval key.

  - `paypalType` (string)
    The type of the PayPal payment method.

  - `phone` (string)
    The phone number that the account holder registered with the bank. This
field is used for credit card validation when passing to a gateway.

  - `postalCode` (string)
    The zip code of the customer's address. Only applicable to direct debit
payment methods.

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

  - `state` (string)
    The state of the customer's address. Only applicable to direct debit
payment methods.

  - `streetName` (string)
    The street name of the customer's address. Only applicable to direct debit
payment methods.

  - `streetNumber` (string)
    The street number of the customer's address. Only applicable to direct
debit payment methods.

  - `tokenId` (string)
    A gateway unique identifier that replaces sensitive payment method data or
represents a gateway's unique customer profile. Applicable to CC Reference
Transaction payment methods.

  - `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` (string)
    The type of the payment method. For example, CreditCard.

  - `useDefaultRetryRule` (boolean)
    Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.

  - `methodReferenceId` (string)
    The identification reference of the custom payment method.

This field should be mapped to a field name defined in the fields array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.

  - `userReferenceId` (string)
    The identification reference of the user or customer account.

This field should be mapped to a field name defined in the fields array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.

  - `subType` (string)
    The identification reference indicating the subtype of the custom payment method.

This field should be mapped to a field name defined in the fields array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.

  - `methodSpecificData` (string)
    Other method-specific data of the payment method.

## Response 500 fields (application/json):

  - `reasons` (array)
    The container of the error code and message. This field is available only if the success field is false.

  - `reasons.code` (integer)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response

  - `requestId` (string)
    The unique identifier of the request.

## Response 4XX fields (application/json):

  - `reasons` (array)
    The container of the error code and message. This field is available only if the success field is false.

  - `reasons.code` (integer)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response

  - `requestId` (string)
    The unique identifier of the request.