---
title: "Create a payment session"
method: POST
path: "/web-payments/sessions"
tags: ["Payment Methods"]
---

# Create a payment session

`POST /web-payments/sessions`

Use this operation to create a payment session on your server side. 
The response contains a token for the payment session data. 

In addition to the required `accountId` and `currency` fields, you can specify the following fields 
to define the payment flow mode as one of the following:
  - Create and save a payment method:
      - `processPayment`: `false`
      - `storePaymentMethod`: `true`
      - `amount`
  - Process a one-time payment without saving the payment method:
      - `processPayment`: `true`
      - `storePaymentMethod`: `false`
      - `amount` or `invoices` + `amount`
  - Process the first payment and save the payment method for subsequent recurring payments:
      - `processPayment`: `true`
      - `storePaymentMethod`: `true`
      - `amount` or `invoices` + `amount`

For more information, see the following articles:
  - <a href="https://developer.zuora.com/docs/get-started/tutorials/payment-form/" target="_blank">Payment Form Implementation Guide</a>
  - <a href="https://docs.zuora.com/en/zuora-payments/process-payments/implement-payment-flows-through-javascript-sdk-integration" target="_blank">Set up a payment method through JavaScript SDK integration</a>
  - <a href="https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/set-up-payment-gateway-integrations/alipay-payment-gateway/set-up-alipay-payment-methods-with-zuora-javascript-sdk" target="_blank">Set up Alipay payment methods with Zuora JavaScript SDK</a>

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string

## Request body

- POSTCreatePaymentSessionRequest
  - `accountId` string — The ID of the customer account in Zuora that is associated with this payment method. This field is required when `processPayment` is set to `true`. It is optional when `processPayment` is set to `false`.
  - `amount` number, required — If `processPayment` is `true`, it is the amount of the payment. If `invoices` is specified, the value of `amount` must be the current total balances of the specified invoices. If `processPayment` is `false`, it is the authorization amount for the payment method.
  - `authAmount` number — The authorization amount for the payment method. Specify a value greater than 0. **Note:** This field is being deprecated. It is recommended to use the `amount` field.
  - `currency` string, required — The currency of the payment in the format of the three-character ISO currency code.
  - `gatewayOptions` object — The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the overview topic of each gateway integration in <a href="https://docs.zuora.com?resourceId=payments-setup-gateway-integration" target="_blank">Zuora Knowledge Center</a>. Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
  - `paymentGateway` string — The ID of the payment gateway instance configured in Zuora that will process the payment, such as `e884322ab8c711edab030242ac120004`. 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 process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process 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 process the payment.
  - `processPayment` boolean, required — Indicate whether a payment should be processed after creating the payment method. If this field is set to `true`, you must specify either the `amount` field or the `invoices` and `amount` fields. If this field is set to `false`, you must specify the `amount` field.
  - `storePaymentMethod` boolean — `true` indicates that the payment method will be stored in Zuora and will be used in subsequent recurring payments. `false` indicates that the payment method will not be stored in Zuora. End-customers need to be brought back on-session to authenticate the payment.
  - `invoices` object[] — The array of invoices that a payment applies to. All the specified invoices will be fully paid. The value of the `amount` field must be the current total balances of the specified invoices. Here is an example: ``` "invoices": [ { "invoiceNumber": "INV00001274" }, { "invoiceNumber": "INV00001278" } ] ```
    - `invoiceNumber` string — The invoice number, such as `INV0000001`.

## Response `200`

OK

- POSTCreatePaymentSessionResponse
  - `token` string — The token for the payment session data.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)