Verify a payment method

Quickstart API Reference

Request

Sends an authorization request to the corresponding payment gateway to verify the payment method. Supported payment methods are credit cards and Paypal.

Security

bearerAuth

Path

payment_method_idstringrequired

Payment Method Id

Query

fields[]Array of strings

Allows you to specify which fields are returned in the response.

Accepted values

`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`

Example:fields[]=id,created_time

payment_method.fields[]Array of stringsdeprecated

Allows you to specify which fields are returned in the response.

Accepted values

Example:payment_method.fields[]=id,created_time

account.fields[]Array of strings

Allows you to specify which fields are returned in the response.

Accepted values

`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`

Example:account.fields[]=id,created_time

expand[]Array of strings

Allows you to expand responses by including related object information in a single call. See the Expand responses section of the Quickstart API Tutorials for detailed instructions.

filter[]Array of strings

A case-sensitive filter on the list. See the Filter lists section of the Quickstart API Tutorial for detailed instructions.
Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the filter[] parameter on the related objects such as filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63

page_sizeinteger, [ 1 .. 99 ]

The maximum number of results to return in a single page. If the specified page_size is less than 1 or greater than 99, Zuora will return a 400 error.

zuora-track-idstring

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your 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 ("), or quote (').

asyncboolean

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

Default:false

zuora-entity-idsstring

An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header.

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. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encodingstring

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encodingstring

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

Bodyapplication/jsonrequired

currencystring

Three-letter ISO currency code.

security_codestring

Card security code.

payment_gatewaystring

The name of the payment gateway instance. If no value is specified for this field, the default payment gateway of your Zuora tenant will be used.

Example:"8ad093d07ae636bb017ae97518762aa3"

gateway_optionsobject

A hash containing gateway-specific parameters.

Example:

{
  "key": "value"
}

{
  "currency": "USD",
  "security_code": "123",
  "payment_gateway": "Test Gateway",
  "gateway_options": {
    "Comments": "payment method verification"
  }
}

Responses

Default Response

Headers

ratelimit-limitstring

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

ratelimit-remainingnumber

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

ratelimit-resetnumber

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

zuora-request-idstring

Zuora’s internal identifier for this request.

zuora-track-idstring

A user-supplied identifier for this request. If you supply a zuora-track-id as a request header, Zuora returns the zuora-track-id as a response header.

Bodyapplication/json

idstringread-only

Unique identifier for the object.

updated_by_idstringread-only

Unique identifier of the Zuora user who last updated the object

updated_timestring, (date-time)read-only

The date and time when the object was last updated in ISO 8601 UTC format.

created_by_idstringread-only

Unique identifier of the Zuora user who created the object

created_timestring, (date-time)read-only

The date and time when the object was created in ISO 8601 UTC format.

custom_fieldsobject(CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

custom_objectsobjectread-only

The custom objects associated with a Zuora standard object.

typestring

The type of the payment method. An additional hash is included on the payment method with a name matching this value. It contains additional information specific to the payment method type.

Enum:"paypal_express""paypal_express_native""paypal_adaptive""card""cc_ref""ach_debit""sepa_debit""betalings_debit""autogiro_debit""bacs_debit"

custom_typestring

The custom type of the payment method from Universal Payment Connector.

account_idstring

A customer account identifier.

Example:"2c92c0f86a8dd422016a9e7a70116b0d"

accountobject(Account)read-only

The customer account associated with this payment method.

billing_detailsobject(BillingDetails)

Billing information associated with the payment method that may be used or required by specific payment method types.

maximum_payment_attemptsnumber

Maximum number of consecutive failed retry payment attempts using this payment method before retries are stopped.

Example:6

payment_retry_intervalinteger

The retry interval in hours.

Example:3

device_session_idstring

ip_addressstring or null

The IP address from which the Mandate was accepted by the customer.

Example:"192.10.1.123"

bank_identification_numberstring

cardobject(GetCardList)

Credit card information.

paypal_express_nativeobject(PaypalExpressNative)

If it is a paypal_express_native payment method, this hash contains details about the PayPal Express Native payment method.

paypal_expressobject(PaypalExpress)

If it is a paypal_express payment method, this hash contains details about the PayPal Express payment method.

paypal_adaptiveobject(PaypalAdaptive)

If it is a paypal_adaptive payment method, this hash contains details about the PayPal Adaptive payment method.

sepa_debitobject(SepaDebit)

If the type of the payment method is sepa_debit, this hash contains details about the SEPA bank account.

cc_refobject(CcRef)

If the type of the payment method is cc_ref, this hash contains details about the Credit Card Reference Transactions payment method. See Supported payment methods for payment gateways that support this type of payment method.

apple_payobject(ApplePay)

If the type of the payment method is apple_pay, this hash contains details about the Apple Pay payment method. See Supported payment methods for payment gateways that support this type of payment method.

google_payobject(GooglePay)

ach_debitobject(AchDebit)

If the type of the payment method is ach_debit, this hash contains details about the ACH bank account.

betalings_debitobject(BetalingsDebit)

If the type of the payment method is betalings_debit, this hash contains details about the Betalingsservice bank account.

autogiro_debitobject(AutogiroDebit)

If the type of the payment method is autogiro_debit, this hash contains details about the Autogiro bank account.

bacs_debitobject(BacsDebit)

If the type of the payment method is bacs_debit,, this hash contains details about the BACS bank account.

au_becs_debitobject(AuBecsDebit)

If the type of the payment method is au_becs_debit, this hash contains details about the BECS bank account.

nz_becs_debitobject(NzBecsDebit)

If the type of the payment method is nz_becs_debit, this hash contains details about the BECS-NZ bank account.

pad_debitobject(PadDebit)

If the type of the payment method is pad_debit, this hash contains details about the PAD bank account.

statestring

The state of the payment method.

Enum:"active""closed""scrubbed"

auto_generatedboolean

use_default_retry_ruleboolean

existing_mandateboolean

last_failed_sale_transaction_timestring, (date-time)

last_transaction_timestring, (date-time)

last_transaction_statusstring

number_of_consecutive_failuresinteger

total_number_of_processed_paymentsinteger

total_number_of_error_paymentsinteger

Response

{
  "id": "8ad08ccf8437067601843a7af4e64rq3",
  "updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "updated_time": "2022-09-07T08:52:24-07:00",
  "created_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "created_time": "2022-09-07T08:52:24-07:00",
  "custom_fields": {
    "field__c": "custom field value"
  },
  "type": "card",
  "account_id": "2c92c0f86cbe335a016cbece4a434ada",
  "billing_details": {
    "name": "Anabelle Padberg",
    "address": { … }
  },
  "maximum_payment_attempts": 0,
  "payment_retry_interval": 0,
  "bank_identification_number": "411111",
  "card": {
    "brand": "visa",
    "expiry_month": 12,
    "expiry_year": 2025,
    "last_4": "1111"
  },
  "state": "active"
}