RatePAY - Installment

The shop must implement the Calculation Request operation to calculate an example installment plan and show it to the customer. Some input parameters for the calculation are passed from the shop (e.g. the shopping basket total), others are stored in the merchant’s RatePAY profile held by the Gateway (e.g. the allowed interest rate range). The merchant’s profile parameters can be retrieved by the Configuration Request operation.

Workflow Scenarios

Payment Flow

Payment Flow

Cancellation Flow

Partial Cancellation Flow

Refund Flow

Integrating RatePAY Installment Payment

In order to integrate installment payment, two simple steps are needed: set RatePAY installment payment configuration and call the facade functions.

Set RatePAY Installment Configuration

The installment requests use two additional types of requests called Configuration and Calculation Requests.

Three groups of configuration are defined:

  • transaction configuration for handling the basic requests (init-payment, payment-request, etc)
  • installment configuration for handling configuration
  • calculation for handling calculation requests.

The configuration to integrate Installment payment method using RatePAY is:

  • PROFILE_ID: merchant’s login (required).
  • SECURITY_CODE: merchant’s password (required).
  • SHOP_ID: shop identifier (required).
  • SYSTEM_ID: system identifier (required).
  • CLIENT_VERSION: client system version.
  • CLIENT_NAME: client name.
  • RATEPAY_REQUEST_VERSION: request version.
  • RATEPAY_REQUEST_XMLNS_URN: request XMLNS urn.
  • MODE: the mode of the transaction, either test or live (required).
  • API_TEST_URL: test mode API url.
  • API_LIVE_URL: live mode API url.
  • DEBIT_PAY_TYPES: debit pay types, can be DIRECT-DEBIT or BANK-TRANSFER.
  • INSTALLMENT_CALCULATION_TYPES: installment calculator types, can be by time or by date.

You can copy over configs to your config from the RatePAY module’s config.dist.php file.

Perform Requests

In order to perform the needed requests, you can easily use the implemented state machine commands and conditions. The RatePAY State Machine Commands and Conditions section gives a summary of them. You can also use the facade methods directly which, however, are invoked by the state machine.