Create payment methods on Planet

Step 1. Prepare for the integration

• Real-Time Reconciliation must be enabled. See Real-Time Reconciliation on Planet for more information.
• In the integration, you can specify either the authorization amount or invoices when setting up your client code. To support these use cases, complete the following configuration:
  • To support processing authorization amounts, the following features must be enabled:
    • Validate Client-Side HPM Parameters
      Follow the instructions in Validating client-side HPM parameters to enable it.
    • Either Credit Balance or Invoice Settlement
  • To support processing invoices, the following requirements must be met:
    • Validating Client-Side HPM Parameters must be enabled.
    • The invoices must be posted before the invoices are paid through the one-time payment.
• To understand the implementation procedure of Payment Pages 2.0 in Zuora, review Payment Pages 2.0 implementation overview.

Step 2. Set up a Payment Page 2.0

1. Set up a Payment Page 2.0 by following the instructions in Configure Credit Card Type Payment Pages 2.0. Make sure Enable 3D Secure 2.0 is selected in the Security Information section.
2. Optionally, preview the Payment Page.
3. Optionally, translate and localize the Payment Page.
4. Optionally, update the CSS for the Payment Page.

Step 3. Request a signature for the hosted page from Zuora

Follow the instructions in Request a signature for the Payment Page from Zuora. Because the Client-side HPM Parameter Validation feature is enabled, Zuora will validate the additional fields in the request by comparing them with the values specified in the digital signature.

Here are two request examples for the Generate RSA signature REST API operation.

{
   "uri":"https://sandbox.na.zuora.com/apps/PublicHostedPageLite.do",
   "method":"POST",
   "pageId":"test000045b3bf9d0145b3c6812b0000",
   "paymentGateway":"Planet",
   "authroizationAmount":"100",
   "currency":"USD",
   "accountId":"test808145b3bf9d0145b3c6812b0000"
}

{
   "uri":"https://sandbox.na.zuora.com/apps/PublicHostedPageLite.do",
   "method":"POST",
   "pageId":"test000045b3bf9d0145b3c6812b0008",
   "paymentGateway":"Planet",
   "accountId":"test808145b3bf9d0145b3c6812b0000"
}

Step 4. Set up your client code

Follow the instructions in Integrate Payment Pages 2.0. When rendering the Payment Page, 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.

Here is an example for authorization amount processing:

var params = {
    doPayment:"true",
    storePaymentMethod:"true",
    field_accountId:"testc0f87596f2f301759c29443622fa",
    authorizationAmount:"99",
    field_currency:"USD"
};

Here is an example for invoice processing:

var params = {
    doPayment:"true",
    storePaymentMethod:"true",
    field_accountId:"testc0f87596f2f301759c29443622fa",
    documents:"[{\"type\": \"invoice\", \"ref\": \"INV0000001\"}, {\"type\": \"invoice\", \"ref\": \"INV0000002\"}]"
};

Step 5. Implement callback response

See Advanced Integration of Payment Pages 2.0 for more information.

Prerequisite

Contact Planet Datatrans to enable the support for plain cards.

Create payment methods

You can create Credit Card payment methods by using the REST API operations for creating payment methods, such as Create a payment method. In your request, pass in the following required fields.

Here is an example of the API request for creating a tokenized Credit Card payment method:

{
    "accountKey": "8ad08e669299aa0a01929f0ac6af4748",
    "cardHolderInfo": {
        "addressLine1": "123 test street",
        "addressLine2": "",
        "cardHolderName": "Amy Lawrence",
        "city": "Fremont",
        "country": "USA",
        "email": "amy@testaddress.com",
        "phone": "4155551234",
        "state": "California",
        "zipCode": "94020"
    },
    "cardNumber": "4111111111111111",
    "cardMaskNumber": "************1234",
    "expirationMonth": "06",
    "expirationYear": "2025",
    "cardType": "Visa",
    "type": "CreditCard",
    "tokenize": true,
    "tokens": {
        "gatewayType": "Planet",
        "tokenId": "4111111111590001318379"
    }
}

For other optional fields, see Create a payment method.

For tokenized payment methods, you must validate them in Zuora so that payments made with these payment methods are successful. To validate tokenized payment methods, enable the following settings on the gateway instance configuration page:

• Verify new payment method
• Verify updated payment method