Integrating the Direct Debit payment method for RatePay

Edit on GitHub

Workflow Scenarios

Payment Flow

Click Me

Cancellation Flow

Click Me

Partial Cancellation Flow

Click Me

Refund Flow

Click Me

Integrating Direct Debit

Direct Debit Payment—in order to integrate direct debit payment, two simple steps are needed: set RatePAY Direct Debit payment configuration and call the facade functions.

Set RatePay Direct Debit Configuration

The configuration to integrate Direct Debit payments 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.
  • 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.

Performing 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.