Create a payment session

When implementing Apple Pay integration by using Zuora's JavaScript SDK, use this operation to create a payment session on your server side. The response of this API operation contains a token for the payment session data. Send the token back to your client side to use in the subsequent implementation step. For more information, see Set up Apple Pay through the JavaScript SDK approach.

Request
header Parameters
Idempotency-Key
string <= 255 characters

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

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

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

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

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 do not need to set this header.

Zuora-Org-Ids
string

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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required
accountId
required
string

The ID of the customer account in Zuora that is associated with this payment method.

currency
required
string

The currency of the payment in the format of the three-character ISO currency code.

paymentGateway
required
string

The ID of the payment gateway instance configured in Zuora that will process the payment, such as e884322ab8c711edab030242ac120004.

processPayment
required
boolean

Indicate whether a payment should be processed after creating the payment method.

If this field is set to true, you must specify the amount field.

If this field is set to false, you must specify the authAmount field. The payment method will be verified through the payment gateway instance specified in the paymentGateway field.

amount
number

The amount of the payment.

This field is required if processPayment is true.

authAmount
number

The authorization amount for the payment method. Specify a value greater than 0.

This field is required if processPayment is false.

Responses
200
post/web-payments/sessions
Request samples
application/json
{
  • "accountId": "402880de8779e14f018779e82905000f",
  • "amount": "100",
  • "currency": "USD",
  • "paymentGateway": "e884322ab8c711edab030242ac120004",
  • "processPayment": true
}
Response samples
application/json
{
  • "token": "LTljuuLaDQnHxeVpWaX6zq2xY2FJ6sSE"
}