Sign in
Object Queries

Retrieve a payment method

Retrieve the details of a specific Payment Method object.

get/object-query/payment-methods/{key}

Path parameters

keystring required

Object ID or Number.

Query parameters

pageSizeinteger

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.

cursorstring

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[]string[]

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[]string[]

Allows you to expand responses by including related object information in a single call.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

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

includeNullFieldsboolean

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.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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

The minor API version.

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

Response

OK

idstring

The unique identifier of the payment method.

createdByIdstring

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

createdDatestring date-time

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

updatedByIdstring

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

updatedDatestring date-time

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

accountIdstring

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

achAbaCodestring

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

achAccountNamestring

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.

achAccountNumberMaskstring

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

achAccountType'BusinessChecking' | 'Checking' | 'Saving'

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.

achAddress1string

First address line for the ACH payment method.

achAddress2string

Second address line for the ACH payment method.

achBankNamestring

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.

achCitystring

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.

achCountrystring

Country for the ACH payment method. Must be a valid country name or abbreviation.

See <a href="https://docs.zuora.com?resourceId=view-countries-or-regions" target="_blank">View countries or regions</a> 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.

achPostalCodestring

Zip code or postal code for the ACH payment method.

achStatestring

State for the ACH payment method. Must be a valid subregion (state or province) name or code. For more information, see <a href="https://docs.zuora.com?resourceId=view-sub-regions-of-specific-country-or-region" target="_blank">View subregions of a specific country or region</a>.

activeboolean

Specifies whether the payment method was loaded by the system or created by the customer.

  • true - System-loaded payment method
  • false - Customer-created payment method Use paymentMethodStatus to determine whether you can use a payment method for payments.
isSystemboolean

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.

accountVerificationServicestring

Displays the name of the service provider. For example, Plaid.

accountVerificationStatus'Active' | 'Expired' | 'Expiring' | 'Inactive'

Displays the status of the account. Note:

  • Active - Access token is active.
  • Expired - Access token has expired and must be linked again.
  • Expiring - Access token will expire in few days(7 days for Plaid) and must be linked again
  • Inactive - The end customer has revoked the account pemission. The end customer can login again and select the same method for the access token to be linked again.
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 payment methods in Switzerland with Global Collect.

citystring

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

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 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 <a href="https://docs.zuora.com?resourceId=view-countries-or-regions" target="_blank">View countries or regions</a>. Internationalization is not supported for the API field value.

creditCardExpirationMonthinteger

One or two digits expiration month.

creditCardExpirationYearinteger

Four-digit expiration year.

creditCardHolderNamestring

The full name of the credit card holder.

creditCardMaskNumberstring

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

creditCardPostalCodestring

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

creditCardStatestring

The state where the credit card holder stays.

creditCardTypestring

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.

deviceSessionIdstring

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

existingMandate'Yes' | 'No'

Indicates whether the mandate is an existing mandate.

emailstring

The email address of the payment method holder.

firstNamestring

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

iBANstring

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

iPAddressstring

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

identityNumberstring

The identity number of the account holder or the cardholder.

companyNamestring

The name of the company.

isCompanyboolean

Whether the customer account is a company.

lastFailedSaleTransactionDatestring date

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

lastTransactionStatusstring

The status of the most recent transaction.

mandateCreationDatestring date

The date on which the mandate was created.

mandateIdstring

The mandate ID.

mandateReasonstring

The reason of the mandate from the gateway side.

mandateReceived'Yes' | 'No'

Indicates whether the mandate is received from the gateway.

mandateStatusstring

The status of the mandate from the gateway side.

mandateUpdateDatestring date

The date on which the mandate was updated.

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 payments for this payment method. It is reset to 0 upon successful payment.

paymentMethodStatus'Active' | 'Closed' | 'Scrubbed'

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

ID of a PayPal billing agreement.

paypalEmailstring

Email address associated with the PayPal payment method.

paypalPreapprovalKeystring

The PayPal preapproval key.

paypalTypestring

The type of the PayPal payment method.

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.

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

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.

typestring

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

useDefaultRetryRuleboolean

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

methodReferenceIdstring

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.

userReferenceIdstring

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.

subTypestring

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.

methodSpecificDatastring

Other method-specific data of the payment method.

cardBrandstring

The card brand, such as Visa and MasterCard.

cardClass'ChargeCard' | 'Credit' | 'Debit' | 'DeferredDebit' | 'Prepaid'

The type of the card.

cardIssuingBankstring

The issuer bank of the card, such as JPMORGAN CHASE BANK N.A..

cardIssuingCountrystring

The issuing country code of the card, such as US.

cardProductType'Commercial_or_Corporate_Card' | 'Consumer_Card'

The product type of the card.

Example response

{
  "paypalBaid": "I-1TJ3GAGG82Y9"
}

Changes