Create a payment authorization

Request

Verifies a payment method and block the amount of fund that will be used for payment.

Security

bearerAuth

Path

payment_method_idstringrequired

Payment Method Id

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

account_idstring

A customer account identifier. Either account_id or account_number is required.

Example:"2c92c0f86a8dd422016a9e7a70116b0d"

account_numberstring

A Human-readable customer account identifier. Either account_id or account_number is required.

Example:"RC-00000011"

amountnumberrequired

Amount to be authorized.

gateway_idstring

Identifier of the payment gateway that Zuora will use to authorize the payments that are made with this payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: The default payment gateway of the customer account that owns the payment method, if the payment method is associated with a customer account or the default payment gateway of your Zuora tenant.

Example:"8ad093d07ae636bb017ae97518762aa3"

gateway_optionsobject

A hash containing gateway-specific parameters.

Example:

{
  "key": "value"
}

gateway_order_idstringrequired

A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems. When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gateway_order_id that you used when authorizing the funds by using the Create authorization operation, together with the authorization_id field.

statement_descriptorstring

A payment gateway-specific field used by Orbital, Vantiv and Verifi.

statement_descriptor_phonestring

A payment gateway-specific field used by Orbital, Vantiv and Verifi.

mandateobject(AuthorizationMandate)

{
  "amount": 200,
  "gateway_order_id": "2c92c0f86a8dd422016a941ee0d82c7f",
  "account_id": "8ad08ccf8437067601843a7af4e75ac8"
}

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

auth_transaction_idstring

Identifier of the authorization transaction from the payment gateway.

gateway_order_idstring

A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems. When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gateway_order_id that you used when authorizing the funds by using the Create authorization operation, together with the authorization_id field.

statestring

The status of the payment authorization.

Enum:"approved""queued_for_submission"

Response

{
  "auth_transaction_id": "string",
  "gateway_order_id": "string",
  "state": "approved"
}