Set up and configure an Allpago gateway instance by using the information in this article, including configuration procedure, and descriptions of the configuration fields.
Enable the Allpago payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.
Take the following steps to set up and configure an Allpago gateway instance in Zuora:
- Click your username in the upper right and navigate to Settings > Payments > Setup Payment Gateway.
- On the Configure Gateway Instance tab, select Allpago from the Gateway Type drop-down list.
- Click Create Gateway.
- On the gateway settings page, specify values for the configuration fields. See below for more information on the fields.
- Click Save Gateway Information.
Common configuration fields
You must complete some common fields for every gateway configuration. Zuora recommends that you review the Setting up payment gateways article for more information on these common fields:
- Use Gateway Test Environment
- Cards Accepted
- Default Authorization Amount
- Verify payment method (optional)
- Verify updated payment method (optional)
Additional configuration fields
In addition to the common fields, every gateway has unique requirements and information (such as credentials and certain rules) that you must provide to configure the gateway instance in Zuora. Enter the following fields on the gateway configuration page:
- User ID: The User ID of your merchant account assigned by PPRO. This field is listed only for backward compatibility. Use the Authorization Bear Token instead of the user ID and password.
- Password: The password of your merchant account assigned by PPRO. This field is listed only for backward compatibility. Use the Authorization Bearer Token instead of the user ID and password.
- Auth Token: The Authorization Bearer Token assigned by the PPRO gateway.
PPRO only accepts transactions using the Authorization Bearer token since January 1st, 2020,
- Channel ID: The identifier of the entity for requests. An entity can be a division, merchant, or channel. Channel is the default entity for sending payment transactions.
- Channel ID (Initial): A unique key for the identification of initial payments.
- Channel ID (Recurring): A unique key for the identification of recurring payments.
- Test Mode: Determines whether the transaction will be processed internally or externally.
- External: The transactions are processed externally, which includes the risk management and the test environment of the acquirer.
- Internal: The transactions are processed internally excluding risk management.
- Merchant Website: Your merchant website. For example, www.yourstore.com
- Product Name: Name of the product that is being delivered.
- Customer Number Custom Field (Optional): The custom field API name used for the customer number. You should specify the API name of custom fields on the Account object without the
__csuffix. For example, if the API name of a custom field is
CustomerTaxID__c, you should enter CustomerTaxID in this field.
- Soft Descriptor (Optional): The specified value for this field will be presented on customers’ credit card statements. It corresponds to the
descriptorfield on the gateway side. See PPRO's documentation for more information.