Retrieve a payment method snapshot

GET

/object-query/payment-method-snapshots/:key

GET

/object-query/payment-method-snapshots/:key

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.object_queries.query_payment_method_snapshot_by_key(
    key="key",
    fields_array=[
        "id,createddate"
    ],
)

{
  "id": "2c92c0fa732df2a001734c8c68073a21",
  "createdDate": "2020-07-14T01:58:56-07:00",
  "updatedDate": "2020-07-14T01:58:56-07:00",
  "accountId": "2c92c0f87270a5970172747e289a5e66",
  "achAbaCode": "11111111111111111111",
  "achAccountName": "Amy Lawrence",
  "achAccountNumberMask": "************7777",
  "achAccountType": "BusinessChecking",
  "achBankName": "abc",
  "creditCardAddress1": "",
  "creditCardAddress2": "",
  "creditCardCity": "",
  "creditCardCountry": "Brazil",
  "creditCardPostalCode": "",
  "creditCardState": "",
  "email": "",
  "isCompany": false,
  "lastTransactionDateTime": "2020-07-13T01:11:16-07:00",
  "lastTransactionStatus": "Approved",
  "paymentMethodId": "2c92c0f872bc58ec0172c06fe2f07422",
  "numConsecutiveFailures": 0,
  "paymentMethodStatus": "Active",
  "phone": "",
  "totalNumberOfErrorPayments": 0,
  "totalNumberOfProcessedPayments": 5,
  "type": "ACH",
  "useDefaultRetryRule": true
}

Retrieve the details of a specific Payment Method Snapshot object.

Authentication

AuthorizationBearer

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

Path parameters

keystringRequired

Object ID or Number.

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

pageSizeintegerOptional1-99Defaults to 10

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.

cursorstringOptional

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[]list of stringsOptional

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[]list of stringsOptional

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[]list of stringsOptional

A case-insensitive filter on the list.

fields[]list of stringsOptional

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsbooleanOptionalDefaults to false

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

idstringOptional

The unique identifier of the payment method snapshot.

createdByIdstringOptional

The unique identifier of the user who created the payment method snapshot.

createdDatedatetimeOptional

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

updatedByIdstringOptional

The unique identifier of the user who last updated the payment method snapshot.

updatedDatedatetimeOptional

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

accountIdstringOptional

The unique identifier of the account that the payment method snapshot is associated with.

achAbaCodestringOptional

The nine-digit routing number or ABA number used by banks. This field is only required if the type field is set to ACH.

achAccountNamestringOptional

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.

achAccountNumberMaskstringOptional

The masked bank account number associated with the ACH payment method. This field is only required if the type field is set to ACH.

achAccountTypeenumOptional

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.

Allowed values:

achAddress1stringOptional<=255 characters

First address line for the ACH payment method.

achAddress2stringOptional<=255 characters

Second address line for the ACH payment method.

achBankNamestringOptional<=70 characters

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.

achCitystringOptional<=40 characters

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.

achCountrystringOptional

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.

achPostalCodestringOptional<=20 characters

Zip code or postal code for the ACH payment method.

achStatestringOptional

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.

activebooleanOptional

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

isSystembooleanOptional

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.

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 payment methods in Switzerland with Global Collect.

citystringOptional

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

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

creditCardExpirationMonthintegerOptional1-12

One or two digits expiration month.

creditCardExpirationYearintegerOptional

Four-digit expiration year.

creditCardHolderNamestringOptional

The full name of the credit card holder.

creditCardMaskNumberstringOptional

The masked credit card number, such as *********1112.

creditCardPostalCodestringOptional

The postal code for the address of the credit card holder.

creditCardStatestringOptional

The state where the credit card holder stays.

creditCardTypestringOptional

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.

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

deviceSessionIdstringOptional

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

existingMandateenumOptional

Indicates whether the mandate is an existing mandate.

Allowed values:

emailstringOptional

The email address of the payment method holder.

firstNamestringOptional

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

iBANstringOptional

The International Bank Account Number used to create the SEPA payment method. The value is masked.

iPAddressstringOptional

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

identityNumberstringOptional

The identity number of the account holder or the cardholder.

companyNamestringOptional

The name of the company.

isCompanybooleanOptional

Whether the customer account is a company.

lastFailedSaleTransactionDatedateOptional

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

lastTransactionStatusstringOptional

The status of the most recent transaction.

mandateCreationDatedateOptional

The date on which the mandate was created.

mandateIdstringOptional

The mandate ID.

mandateReasonstringOptional

The reason of the mandate from the gateway side.

mandateReceivedenumOptional

Indicates whether the mandate is received from the gateway.

Allowed values:

mandateStatusstringOptional

The status of the mandate from the gateway side.

mandateUpdateDatedateOptional

The date on which the mandate was updated.

maxConsecutivePaymentFailuresintegerOptional

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

paymentMethodIdstringOptional

ID of the associated payment method.

namestringOptional

The name of the payment method.

numConsecutiveFailuresintegerOptional

The number of consecutive failed payments for this payment method. It is reset to 0 upon successful payment.

paymentMethodStatusenumOptional

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

ID of a PayPal billing agreement.

paypalEmailstringOptional

Email address associated with the PayPal payment method.

paypalPreapprovalKeystringOptional

The PayPal preapproval key.

paypalTypestringOptional

The type of the PayPal payment method.

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.

Note: This field is only returned for the Credit Card Reference Transaction payment type.

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.

typestringOptional

The type of the payment method. For example, CreditCard.

useDefaultRetryRulebooleanOptional

Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.

methodReferenceIdstringOptional

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.

userReferenceIdstringOptional

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.

subTypestringOptional

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.

methodSpecificDatastringOptional

Other method-specific data of the payment method.

Errors

4XX

Client Request Error

500

Internal Server Error