Discover comprehensive code samples demonstrating integration with Payment Form. Understand how to swiftly implement hosted payment forms on your website.
Download Sample CodeDon't code? Use Zuora Payment Link.
Server | Server.java
Configure a Zuora client instance with your client ID and client secret. If you don't have them, contact your administrator.Client | checkout.js
Initialize an instance of the Zuora object with your publishable key copied from the previous step.
mvn package
java -cp target/sample-jar-with-dependencies.jar com.zuora.sample.Server
On the page, enter 4111 1111 1111 1111
in the card number field, fill in the remaining card information, and then click the Pay button.
You will be redirected to a return page. The string displayed after "Your order:" is the ID of the created payment. You can find the successful payments in Zuora through the UI, API, Data Source Export, and Data Query.
Congratulations! You now have a basic integration working.
Client | checkout.html
Customize the order summary section on the checkout page for your needs.
Client | return.html
Customize the layout of the return page for your needs.
Client | checkout.js
Use the callback function to handle the payment processing result.
To integrate the payment form with your website, complete a few more steps.
Server | pom.xml
Add the highlighted dependency to your POM build and import the library. Replace the version with the latest Zuora API library version. See Zuora Java SDK on Maven Central for the version information.To use the sample code, you must use Maven for the build.Server | Server.java
If there are multiple entities within your tenant, incorporate the following code line into the highlighted code block to support the multi-entity feature:
zuoraClient.setEntityId("REPLACE_WITH_ENTITY_ID");
Here is an example:
port(8888);
staticFiles.externalLocation(Paths.get("public").toAbsolutePath().toString());
zuoraClient.setEntityId("8a80825556ff28a4015709096c5d6f5d");
zuoraClient.initialize();
zuoraClient.setDebugging(true);
Server | Server.java
In your server, add an endpoint to create a payment session. A one-time token will be returned.You can specify parameters to define the payment flow mode as one of the following:
Client | checkout.html
Create a container and place it where you want the payment form to be rendered.
Client | checkout.js
Initialize an instance of the Zuora object with your publishable key.
Client | checkout.js
Generate a payment session when the end-customers click the Pay button.
Unless otherwise specified, the pre-defined default payment form is used. To use a specific payment form, copy its payment form number from the Zuora UI and incorporate the following code line into the highlighted code block:
profile: "REPLACE_WITH_PAYMENT_FORM_NUMBER",
Here is an example for specifying a payment form and other configuration parameters:
profile: "PF-00000006",
locale: "en",
region: "US",
currency: "USD",
amount: "1599.00",
package com.zuora.sample; import static spark.Spark.port; import static spark.Spark.post; import static spark.Spark.staticFiles; import com.zuora.ZuoraClient; import com.zuora.api.ObjectQueriesApi; import com.zuora.model.*; import com.google.gson.Gson; import java.math.BigDecimal; import java.nio.file.Paths; import java.util.Map; public class Server { private static Gson gson = new Gson(); /** * Please configure your OAuth client id here. */ private static final String CLIENT_ID = "a113*****************************6e5e"; /** * Please configure your OAuth client secret here. */ private static final String CLIENT_SECRET = "=kSm9jIc****************************wvwJ"; private final static ZuoraClient zuoraClient = new ZuoraClient(CLIENT_ID, CLIENT_SECRET, ZuoraClient.ZuoraEnv.SBX); public static void main(String[] args) { port(8888); staticFiles.externalLocation(Paths.get("public").toAbsolutePath().toString()); zuoraClient.initialize(); zuoraClient.setDebugging(true); post("create-payment-session", (request, response) -> { response.type("application/json"); Map map = gson.fromJson(request.body(), Map.class); String firstName = (String) map.get("firstName"); String lastName = (String) map.get("lastName"); String currency = (String) map.get("currency"); String amount = (String) map.get("amount"); final CreateAccountContact contact = new CreateAccountContact().firstName(firstName) .lastName(lastName) .country("US") .state("CA"); final CreateAccountRequest createAccountRequest = new CreateAccountRequest() .name(String.join(" ", firstName, lastName)) .billToContact(contact) .billCycleDay(1) .soldToSameAsBillTo(true) // alternatively, use .soldToContact(contact) .autoPay(false) .currency(currency); final CreateAccountResponse createAccountResponse = zuoraClient.accountsApi().createAccountApi(createAccountRequest).execute(); final CreatePaymentSessionRequest createPaymentSessionRequest = new CreatePaymentSessionRequest() .currency(currency) .amount(new BigDecimal(amount)) .processPayment(true) .accountId(createAccountResponse.getAccountId()); final CreatePaymentSessionResponse createPaymentSessionResponse = zuoraClient.paymentMethodsApi().createPaymentSessionApi(createPaymentSessionRequest).execute(); return gson.toJson(createPaymentSessionResponse.getToken()); }); } }