CRUD: Retrieve a payment method snapshot

GET

/v1/object/payment-method-snapshot/:id

GET

/v1/object/payment-method-snapshot/:id

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.payment_method_snapshots.object_get_payment_method_snapshot(
    id="id",
)

{
  "AccountId": "2c93808457d787030157e0314c0945d4",
  "BankIdentificationNumber": "411111",
  "CompanyName": "",
  "CreditCardAddress1": "312 2nd Ave W",
  "CreditCardCity": "Seattle",
  "CreditCardCountry": "United States",
  "CreditCardExpirationMonth": 12,
  "CreditCardExpirationYear": 2020,
  "CreditCardHolderName": "Somebody",
  "CreditCardMaskNumber": "************1111",
  "CreditCardPostalCode": "98119",
  "CreditCardState": "Washington",
  "CreditCardType": "Visa",
  "Id": "2c93808457d787030157e0314f2245d8",
  "IdentityNumber": "",
  "IsCompany": false,
  "NumConsecutiveFailures": 0,
  "PaymentMethodId": "2c93808457d787030157e0314e8145d7",
  "PaymentMethodStatus": "Active",
  "TotalNumberOfErrorPayments": 0,
  "TotalNumberOfProcessedPayments": 0,
  "Type": "CreditCard",
  "UseDefaultRetryRule": true
}

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.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

idstringRequired

Object id

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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.

Query parameters

fieldsstringOptional

Object fields to return

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

AccountIdstringOptional

The ID of the customer account associated with this payment method.

AchAbaCodestringOptional

The nine-digit routing number or ABA number used by banks. Applicable to ACH payment methods.

AchAccountNamestringOptional

The name of the account holder, which can be either a person or a company. Applicable to ACH payment methods.

AchAccountNumberMaskstringOptional

This is a masked displayable version of the ACH account number, used for security purposes. For example: XXXXXXXXX54321.

AchAccountTypeenumOptional

The type of bank account associated with the ACH payment.

Allowed values:

AchBankNamestringOptional

The name of the bank where the ACH payment account is held.

BankBranchCodestringOptional

The branch code of the bank used for direct debit.

BankCheckDigitstringOptional

The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods.

BankCitystringOptional

The city of the direct debit bank.

BankCodestringOptional

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

BankIdentificationNumberstringOptional

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.

BankNamestringOptional

The name of the direct debit bank.

BankPostalCodestringOptional

The zip code or postal code of the direct debit bank.

BankStreetNamestringOptional

The name of the street of the direct debit bank.

BankStreetNumberstringOptional

The number of the direct debit bank.

BankTransferAccountNamestringOptional

The name on the direct debit bank account.

BankTransferAccountNumberMaskstringOptional

This is a masked displayable version of the bank account number, used for security purposes. For example: XXXXXXXXX54321.

BankTransferAccountTypestringOptional

The type of the customer's bank account. Applicable to direct debit payment methods.

BankTransferTypeenumOptional

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)

BusinessIdentificationCodestringOptional

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.

CitystringOptional

The city of the customer's address. Applicable to debit payment methods.

CompanyNamestringOptional

The name of the company.

CountrystringOptional

The two-letter country code of the customer’s address. Applicable to direct debit payment methods.

CreditCardAddress1stringOptional

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.

CreditCardAddress2stringOptional

The second line of the card holder's address. Applicable to credit card and direct debit payment methods.

CreditCardCitystringOptional

The city of the card holder's address. Applicable to credit card and direct debit payment methods.

CreditCardCountrystringOptional

The country of the card holder's address.

CreditCardExpirationMonthintegerOptional

The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods.

CreditCardExpirationYearintegerOptional

The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods.

CreditCardHolderNamestringOptional

The full name of the card holder. Applicable to credit card and direct debit payment methods.

CreditCardMaskNumberstringOptional

A masked version of the credit or debit card number.

CreditCardPostalCodestringOptional

The billing address's zip code.

CreditCardStatestringOptional

The billing address’s state. Applicable if CreditCardCountry is either Canada or the US.

CreditCardTypeenumOptional

The type of credit card or debit card.

Allowed values:

DeviceSessionIdstringOptional

The session ID of the user when the PaymentMethod was created or updated.

EmailstringOptional

An email address for the payment method in addition to the bill to contact email address.

ExistingMandateenumOptional

Indicates if the customer has an existing mandate or a new mandate. Only applicable to direct debit payment methods.

Allowed values:

FirstNamestringOptional

The customer's first name. Only applicable to direct debit payment methods.

IBANstringOptional

The International Bank Account Number. Only applicable to direct debit payment methods.

IPAddressstringOptional

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

IdstringOptional

Object identifier.

IdentityNumberstringOptional

The unique identity number of the customer account.

IsCompanybooleanOptional

Whether the customer account is a company.

LastFailedSaleTransactionDatedatetimeOptional

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

LastNamestringOptional

The customer's last name. Only applicable to direct debit payment methods.

LastTransactionDateTimedatetimeOptional

The date of the most recent transaction.

LastTransactionStatusstringOptional

The status of the most recent transaction.

MandateCreationDatedateOptional

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.

MandateIDstringOptional

The ID of the mandate. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods.

MandateReceivedstringOptional

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

MandateUpdateDatedateOptional

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.

MaxConsecutivePaymentFailuresintegerOptional

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

NamestringOptional

The name of the payment method.

NumConsecutiveFailuresintegerOptional

The number of consecutive failed payment for the payment method.

PaymentMethodIdstringOptional

Object identifier of the payment method.

PaymentMethodStatusenumOptional

Specifies the status of the payment method.

Allowed values:

PaymentRetryWindowintegerOptional

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

PaypalBaidstringOptional

The PayPal billing agreement ID, which is a contract between two PayPal accounts.

PaypalEmailstringOptional

The email address associated with the account holder's PayPal account or of the PayPal account of the person paying for the service.

PaypalPreapprovalKeystringOptional

PayPal's Adaptive Payments API key.

PaypalTypeenumOptional

Specifies the PayPal gateway: PayFlow Pro (Express Checkout) or Adaptive Payments.

Allowed values:

PhonestringOptional

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

PostalCodestringOptional

The zip code of the customer's address. Only applicable to direct debit payment methods.

SecondTokenIdstringOptional

A gateway unique identifier that replaces sensitive payment method data. Applicable to CC Reference Transaction payment methods.

StatestringOptional

The state of the customer's address. Only applicable to direct debit payment methods.

StreetNamestringOptional

The street name of the customer's address. Only applicable to direct debit payment methods.

StreetNumberstringOptional

The street number of the customer's address. Only applicable to direct debit payment methods.

TokenIdstringOptional

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.

TotalNumberOfErrorPaymentsintegerOptional

The number of error payments that used this payment method.

TotalNumberOfProcessedPaymentsintegerOptional

The number of successful payments that used this payment method.

TypeenumOptional

The type of payment method.

UseDefaultRetryRulebooleanOptional

Determines whether to use the default retry rules configured in the Zuora Payments settings.

Errors

401

Unauthorized Error

404

Not Found Error