Skip to main content

Create payment methods on Paystack

Zuora

Create payment methods on Paystack

This payment gateway integration can be requested through the Specialized Payment Connections service at an additional cost.

To create Credit Card payment methods on Paystack, use the hosted payment page approach:

You can implement a hosted payment page through the Payment Pages 2.0 solution to support the following payment flows:

  • Create and save a card payment method
  • Process a one-time payment without saving the payment method
  • Process the first payment and save the payment method for subsequent recurring payments

 After the payment method is successfully created, the gateway returns two additional tokens that are also stored for the payment method in Zuora. These tokens will be used to process recurring transactions.

Zuora UI field Paystack field
Token ID Authorization Code
Second Token ID Email ID

In the Electronic Payment Methods section of the customer account page, you can retrieve the Second Token ID.

Complete the following tasks to implement a Payment Page 2.0 to support one-time payment flows:

  1. Prepare for the integration.
  2. Set up a Payment Page 2.0.
  3. Request a signature for the Payment Page from Zuora.
  4. Set up your client code to integrate the Payment Page into your web page.
  5. Implement the callback response.

You can find detailed instructions in the following sections.

Step 1. Prepare for the integration

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":"Paystack",
   "authorizationAmount":"100",
   "currency":"ZAR",
   "accountId":"test808145b3bf9d0145b3c6812b0000"
}
{
   "uri":"https://sandbox.na.zuora.com/apps/PublicHostedPageLite.do",
   "method":"POST",
   "pageId":"test000045b3bf9d0145b3c6812b0008",
   "paymentGateway":"Paystack",
   "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.

Parameter Type Description

doPayment

boolean

Default: false

true indicates that the Payment Page will create a payment method and process the one-time payment transaction.

   If it is false or not specified, the Payment Page will only create a payment method. 

To implement a one-time payment flow, doPayment must be true.

storePaymentMethod

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 the session to authenticate the payment.

field_accountId

string

Zuora customer account ID. The payment method will be created for this specified account.

Example: 8a90e5e48f2eade6018f2ed19133003a

authorizationAmount

number

Required for authorization amount processing

The amount of the one-time payment that will be sent to the gateway.

For more information about this parameter, see Client parameters for Payment Pages 2.0.

field_currency

string

Required for authorization amount processing

The currency of the one-time payment amount.

For more information about this parameter, see Client parameters for Payment Pages 2.0.

documents array

Required for invoice processing

An array of invoices to be paid in this transaction, containing the following fields:

  • type - The value must be invoice.
  • ref - The value must be the invoice number, such as INV0000001.

Here is an example for authorization amount processing:

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

Step 5. Implement callback response

For more information, see Advanced Integration of Payment Pages 2.0