--- title: "CRUD: Retrieve a payment method snapshot" method: GET path: "/v1/object/payment-method-snapshot/{id}" tags: ["Payment Method Snapshots"] --- # CRUD: Retrieve a payment method snapshot `GET /v1/object/payment-method-snapshot/{id}` 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. ## Path parameters - `id` string, required ## Query parameters - `fields` string ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Track-Id` string - `Zuora-Version` string ## Response `200` OK - ProxyGetPaymentMethodSnapshot - `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` 'BusinessChecking' | 'Checking' | 'Saving' — The type of bank account associated with the ACH payment. - `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` 'AutomatischIncasso' | 'LastschriftDE' | 'LastschriftAT' | 'DemandeDePrelevement' | 'DirectDebitUK' | 'Domicil' | 'LastschriftCH' | 'RID' | 'OrdenDeDomiciliacion' | 'Autogiro' | 'Betalingsservice' — 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) - `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` 'AmericanExpress' | 'Discover' | 'MasterCard' | 'Visa' — The type of credit card or debit card. - `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` 'Yes' | 'No' — Indicates if the customer has an existing mandate or a new mandate. Only applicable to direct debit payment methods. - `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, date-time — 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, date-time — The date of the most recent transaction. - `LastTransactionStatus` string — The status of the most recent transaction. - `MandateCreationDate` string, date — 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, date — 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` 'Active' | 'Closed' — Specifies the status of the payment method. - `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` 'ExpressCheckout' | 'AdaptivePayments' — Specifies the PayPal gateway: PayFlow Pro (Express Checkout) or Adaptive Payments. - `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` 'ACH' | 'ApplePay' | 'BankTransfer' | 'Cash' | 'Check' | 'CreditCard' | 'CreditCardReferenceTransaction' | 'DebitCard' | 'Other' | 'PayPal' | 'WireTransfer' — The type of payment method. - `UseDefaultRetryRule` boolean — Determines whether to use the default retry rules configured in the Zuora Payments settings. ## Other responses - `401` — Unauthorized - `404` --- [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)