Sign in
Payment Authorization

Create authorization

Enables you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. Subsequently, use Create a payment or Create an order to capture the authorized funds, or use Cancel authorization to cancel the authorization.

For gateway integrations that support this operation, see <a href="https://docs.zuora.com?resourceId=payments-delayed-capture" target="_blank">Delayed Capture</a>.

post/v1/payment-methods/{payment-method-id}/authorize

Path parameters

payment-method-idstring required

The unique ID of the payment method where the authorization is created.

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.

Request body

accountIdstring

The ID of the customer account. Either accountId or accountNumber is required.

accountNumberstring

The number of the customer account. Either accountNumber or accountId is required.

amountnumber required

The amount of the transaction.

gatewayOrderIdstring required

The order ID for the specific gateway.

The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.

mitTransactionSource'C_Unscheduled' | 'M_Recurring' | 'M_Unscheduled' | 'M_MOTO'

Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework.

  • C_Unscheduled: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
  • M_Recurring: Merchant-initiated transaction (MIT) that occurs at regular intervals.
  • M_Unscheduled: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
  • M_MOTO: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See Overview of Stripe payment gateway integration for more information.
paymentGatewayIdstring

The ID of the payment gateway instance.

If <a href="https://docs.zuora.com?resourceId=payments-gateway-routing" target="_blank">Payment Gateway Routing</a> is enabled:

  • If this field is not specified, gateway routing rules will be invoked.
  • If this field is specified, the specified gateway will be used to authorize the payment.

If Payment Gateway Routing is disabled:

  • If this field is not specified, the default payment gateway will be used to authorize the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant.
  • If this field is specified, the specified gateway will be used to authorize the payment.
softDescriptorstring

A text, rendered on a cardholder’s statement, describing a particular product or service purchased by the cardholder.

softDescriptorPhonestring

The phone number that relates to the soft descriptor, usually the phone number of customer service.

Example request

{
  "accountId": "402881e861bd8a7e0161c6a453750026",
  "amount": 1.99,
  "gatewayOrderId": "A001"
}

Response

OK

gatewayOrderIdstring

The order ID for the specific gateway.

The specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.

processIdstring

The ID of the running process when the exception occurs. This field is available only if the success field is false.

requestIdstring

The ID of the request. This field is available only if the success field is false

resultCodestring

The result code of the request.

0 indicates that the request succeeded, and the following values indicate that the request failed:

  • 1: The request is declined.
  • 7: The field format is not correct.
  • 10: Client connection has timed out.
  • 11: Host connection has timed out.
  • 12: Processor connection has timed out.
  • 13: Gateway server is busy.
  • 20: The card type is not supported.
  • 21: The merchant account information is invalid.
  • 22: A generic error occurred on the processor.
  • 40: The card type has not been set up yet.
  • 41: The limit for a single transaction is exceeded.
  • 42: Address checking failed.
  • 43: Card security code checking failed.
  • 44: Failed due to the gateway security setting.
  • 45: Fraud protection is declined.
  • 46: Address checking or card security code checking failed (for Authorize.net gateway only).
  • 47: The maximum amount is exceeded (for Authorize.net gateway only).
  • 48: The IP address is blocked by the gateway (for Authorize.net gateway only).
  • 49: Card security code checking failed (for Authorize.net gateway only).
  • 60: User authentication failed.
  • 61: The currency code is invalid.
  • 62: The transaction ID is invalid.
  • 63: The credit card number is invalid.
  • 64: The card expiration date is invalid.
  • 65: The transaction is duplicated.
  • 66: Credit transaction error.
  • 67: Void transaction error.
  • 90: A valid amount is required.
  • 91: The BA code is invalid.
  • 92: The account number is invalid.
  • 93: The ACH transaction is not accepted by the merchant.
  • 94: An error occurred for the ACH transaction.
  • 95: The version parameter is invalid.
  • 96: The transaction type is invalid.
  • 97: The transaction method is invalid.
  • 98: The bank account type is invalid.
  • 99: The authorization code is invalid.
  • 200: General transaction error.
  • 500: The transaction is queued for submission.
  • 999: Unknown error.
  • -1: An error occurred in gateway communication.
  • -2: Idempotency is not supported.
  • -3: Inquiry call is not supported.
resultMessagestring

The corresponding request ID.

successboolean

Indicates whether the call succeeded.

transactionIdstring

The ID of the transaction.

Example response

{
  "gatewayOrderId": "A001",
  "resultCode": 0,
  "resultMessage": "Request ID: 5231719060426316203012",
  "success": true,
  "transactionId": "5231719060426316203012"
}

Changes