# CRUD: Retrieve a payment method snapshot

This REST API reference describes how to retrieve a Payment Method Snapshot.

A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Payment Method Snapshot continues to retain the data used in each of the past transactions.

### Notes
The following Payment Method fields are not available in Payment Method Snapshots:

* Active
* AchAddress1
* AchAddress2
* CreatedById
* CreatedDate
* UpdatedById
* UpdatedDate

The Payment Method Snapshot field PaymentMethodId is not available in Payment Methods.

Endpoint: GET /v1/object/payment-method-snapshot/{id}
Version: 2026-02-20
Security: bearerAuth

## Header parameters:

  - `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-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-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-Version` (string)
    The minor API version.

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

## Query parameters:

  - `fields` (string)
    Object fields to return

## Path parameters:

  - `id` (string, required)
    Object id

## Response 200 fields (application/json):

  - `AccountId` (string)
    The ID of the customer account associated with this payment method.

  - `AchAbaCode` (string)
    The nine-digit routing number or ABA number used by banks. Applicable to ACH payment methods.

  - `AchAccountName` (string)
    The name of the account holder, which can be either a person or a company. Applicable to ACH payment methods.

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

  - `AchAccountType` (string)
    The type of bank account associated with the ACH payment.
    Enum: "BusinessChecking", "Checking", "Saving"

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

  - `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 payments in Switzerland with Global Collect.

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

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

  - `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 of the card holder's address.

  - `CreditCardExpirationMonth` (integer)
    The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods.

  - `CreditCardExpirationYear` (integer)
    The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods.

  - `CreditCardHolderName` (string)
    The full name of the card holder. Applicable to credit card and direct debit payment methods.

  - `CreditCardMaskNumber` (string)
    A masked version of the credit or debit card number.

  - `CreditCardPostalCode` (string)
    The billing address's zip code.

  - `CreditCardState` (string)
    The billing address's state. Applicable if CreditCardCountry is either Canada or the US.

  - `CreditCardType` (string)
    The type of credit card or debit card.
    Enum: "AmericanExpress", "Discover", "MasterCard", "Visa"

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

  - `Email` (string)
    An email address for the payment method in addition to the bill to contact email address.

  - `ExistingMandate` (string)
    Indicates if the customer has an existing mandate or a new mandate. Only applicable to direct debit payment methods.
    Enum: "Yes", "No"

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

  - `IBAN` (string)
    The International Bank Account Number. Only applicable to direct debit payment methods.

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

  - `Id` (string)
    Object identifier.

  - `IdentityNumber` (string)
    The unique identity number of the customer account.

  - `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 of the most recent transaction.

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

  - `MandateCreationDate` (string)
    The date when the mandate was created, in yyyy-mm-dd format. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods.

  - `MandateID` (string)
    The ID of the mandate. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods.

  - `MandateReceived` (string)
    Indicates if  the mandate was received. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods.

  - `MandateUpdateDate` (string)
    The date when the mandate was last updated, in yyyy-mm-dd format. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods.

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

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

  - `NumConsecutiveFailures` (integer)
    The number of consecutive failed payment for the payment method.

  - `PaymentMethodId` (string)
    Object identifier of the payment method.

  - `PaymentMethodStatus` (string)
    Specifies the status of the payment method.
    Enum: "Active", "Closed"

  - `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)
    The PayPal billing agreement ID, which is a contract between two PayPal accounts.

  - `PaypalEmail` (string)
    The email address associated with the account holder's PayPal account or of the PayPal account of the person paying for the service.

  - `PaypalPreapprovalKey` (string)
    PayPal's Adaptive Payments API key.

  - `PaypalType` (string)
    Specifies the PayPal gateway: PayFlow Pro (Express Checkout) or Adaptive Payments.
    Enum: "ExpressCheckout", "AdaptivePayments"

  - `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. Applicable to CC Reference Transaction payment methods.

  - `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 payment method.
    Enum: "ACH", "ApplePay", "BankTransfer", "Cash", "Check", "CreditCard", "CreditCardReferenceTransaction", "DebitCard", "Other", "PayPal", "WireTransfer"

  - `UseDefaultRetryRule` (boolean)
    Determines whether to use the default retry rules configured in the Zuora Payments settings.

## Response 401 fields (application/json):

  - `message` (string)
    Error message.

If the error message is "Authentication error", ensure that the Authorization request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/docs/guides/authentication/) for more information.

If the error message is "Failed to get user info", retry the request.

## Response 404 fields (application/json):

  - `done` (boolean)

  - `records` (array)

  - `size` (integer)