Set up your client code
Configure required client parameters to render Payment Pages 2.0 and process one-time and recurring payments with Adyen Kakaopay.
Follow the instructions in Integrate Payment Pages 2.0 . When rendering the Payment Page form, specify the following required parameters in the Z.render or Z.renderWithErrorHandler function. For other optional parameters, see Client Parameters for Payment Pages 2.0 .
|
Required Parameter |
Description |
|---|---|
|
doPayment |
Type: boolean Default: false true indicates that the Payment Page will create a payment method as well as process the one-time payment transaction. If it is false or not specified, the Payment Page will only create a payment method. To implement payment processing flows, set doPayment to true . To implement payment method validation and setup flows, set doPayment to false . |
|
storePaymentMethod |
Type: boolean Default: true true indicates that the payment method will be stored in Zuora and used in subsequent recurring payments. false indicates that the payment method will not be stored in Zuora. End customers need to be brought back to session to authenticate the payment. |
|
param_gwOptions_MomoPayMandateEnabled |
Type: boolean Default: false To create a mandate and store the payment method in Zuora for processing subsequent recurring payments, in addition to the If you specify |
|
field_accountId |
Type: string Example: 8a90e5e48f2eade6018f2ed19133003a Zuora customer account ID. This account must be set up with the VND currency. The payment method will be created for this specified account. |
|
authorizationAmount |
Required for authorization amount processing For payment processing flow, it is the amount of the one-time payment that will be sent to the gateway. For payment method validation flow, specify 0 for this field. For more information about this parameter, see Client parameters for Payment Pages 2.0 . |
|
field_currency |
Required for authorization amount processing The currency of the one-time payment amount. Only VND is supported by Adyen MoMo. For more information about this parameter, see Client parameters for Payment Pages 2.0 . |
|
documents |
Required for invoice processing An array of invoices to be paid in this transaction, containing the following fields:
|
If you want to use a non-zero value in a payment method verification request, pass the param_gwOptions_additionalAmount Gateway Options field. It is mapped to Adyen's additionalAmount.value field and sent to Adyen. See Adyen's documentation for more information.
shopperEmail
If you want to include the shopper's email address in the request to the gateway, submit a ticket at Zuora Global Support to enable this feature. You can then use the param_gwOptions_shopperEmail Gateway Options field to pass in the shopper's email address. If param_gwOptions_shopperEmail is not provided, the shopperEmail field in the payment request is populated with the email information of the account specified through field_ accountId , according to the following priority order, from highest to lowest:
-
BillTo work email
-
BillTo personal email
-
SoldTo work email
-
SoldTo personal email
In recurring payments and ad-hoc payments triggered from the Zuora UI or API operations, the shopperEmail field in the payment request is also populated in the preceding priority order.
shopperReference
The shopperReference field in the request to the gateway is populated with a UUID by default. If you want to use the Gateway Options field to override it, submit a ticket at Zuora Global Support . You can then use the param_gwOptions_shopperReference Gateway Options field to pass in a value. If param_gwOptions_shopperReference is not provided, shopperReference is populated in the following priority order, from highest to lowest:
-
Zuora account number associated with the account ID specified through
field_accountId -
UUID
In recurring payments and ad-hoc payments triggered from the Zuora UI or API operations, the shopperReference field in the payment request is populated with the account number of the account specified in field_accountId .
Example
Here is an example of the parameters for the payment flow for processing the first one-time and subsequent recurring payments:
var params = {
doPayment:"true",
storePaymentMethod:"true",
param_gwOptions_MomoPayMandateEnabled:"true",
field_accountId:"testc0f87596f2f301759c29443622fa",
documents:"[{"type":"invoice","ref":"INV00026338"}, {"type":"invoice","ref":"INV00026339"}]"
};