Sign in
Payment Method Snapshots

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.

get/v1/object/payment-method-snapshot/{id}

Path parameters

idstring required

Object id

Query parameters

fieldsstring

Object fields to return

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-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-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-Versionstring

The minor API version.

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

Response

OK

AccountIdstring

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

AchAbaCodestring

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

AchAccountNamestring

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

AchAccountNumberMaskstring

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.

AchBankNamestring

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

BankBranchCodestring

The branch code of the bank used for direct debit.

BankCheckDigitstring

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

BankCitystring

The city of the direct debit bank.

BankCodestring

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

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.

BankNamestring

The name of the direct debit bank.

BankPostalCodestring

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

BankStreetNamestring

The name of the street of the direct debit bank.

BankStreetNumberstring

The number of the direct debit bank.

BankTransferAccountNamestring

The name on the direct debit bank account.

BankTransferAccountNumberMaskstring

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

BankTransferAccountTypestring

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)

BusinessIdentificationCodestring

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.

Citystring

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

CompanyNamestring

The name of the company.

Countrystring

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

CreditCardAddress1string

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.

CreditCardAddress2string

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

CreditCardCitystring

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

CreditCardCountrystring

The country of the card holder's address.

CreditCardExpirationMonthinteger

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

CreditCardExpirationYearinteger

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

CreditCardHolderNamestring

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

CreditCardMaskNumberstring

A masked version of the credit or debit card number.

CreditCardPostalCodestring

The billing address's zip code.

CreditCardStatestring

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.

DeviceSessionIdstring

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

Emailstring

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.

FirstNamestring

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

IBANstring

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

IPAddressstring

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

Idstring

Object identifier.

IdentityNumberstring

The unique identity number of the customer account.

IsCompanyboolean

Whether the customer account is a company.

LastFailedSaleTransactionDatestring date-time

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

LastNamestring

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

LastTransactionDateTimestring date-time

The date of the most recent transaction.

LastTransactionStatusstring

The status of the most recent transaction.

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

MandateIDstring

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

MandateReceivedstring

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

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

MaxConsecutivePaymentFailuresinteger

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

Namestring

The name of the payment method.

NumConsecutiveFailuresinteger

The number of consecutive failed payment for the payment method.

PaymentMethodIdstring

Object identifier of the payment method.

PaymentMethodStatus'Active' | 'Closed'

Specifies the status of the payment method.

PaymentRetryWindowinteger

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

PaypalBaidstring

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

PaypalEmailstring

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

PaypalPreapprovalKeystring

PayPal's Adaptive Payments API key.

PaypalType'ExpressCheckout' | 'AdaptivePayments'

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

Phonestring

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

PostalCodestring

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

SecondTokenIdstring

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

Statestring

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

StreetNamestring

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

StreetNumberstring

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

TokenIdstring

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.

TotalNumberOfErrorPaymentsinteger

The number of error payments that used this payment method.

TotalNumberOfProcessedPaymentsinteger

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.

UseDefaultRetryRuleboolean

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

Changes