The paymentRequest function requires a data object containing the following fields:

• method: The payment method (e.g., INSTALLMENT, INVOICE, ELV).

• device_token: A token representing the customer's device, used for tracking or verification purposes.

• operation: The type of payment operation (PAYMENT_INIT, PAYMENT_REQUEST, PAYMENT_CONFIRM).

• profileID: The profile identifier for the transaction, specific to the payment provider. Ask your ratepay support for API keys

• securityCode: A security code for transaction authentication. Ask your ratepay support for API keys

• transactionId (Optional): A unique identifier for the transaction, required for PAYMENT_REQUEST and PAYMENT_CONFIRM operations.

• orderData: An object containing details about the order, customer, and payment. The structure and required fields within orderData depend on the operation and payment method. Key fields include:

  • firstname, lastname, gender, dob (date of birth), ip_address, email, phone, address, zip, city, country, country_code for customer information.

  • product: An array of products, each with id, quantity, price, and name.

  • totalAmount, discountAmount, shippingAmount for order totals.

  • For ELV method, owner and iban are required within orderData.

The response will be in JSON format. It can either contain the result of the payment request or an error message.

• Success Response: JSON object with transaction details or confirmation.

• Error Response: JSON object with an error message. For example, {'error': 'Failed to initialize payment.'} for initialization failures.

Example Request

{
  "method": "ELV | INVOICE",
  "device_token": "device123token",
  "operation": "PAYMENT_REQUEST",
  "orderData": {
    "firstname": "John",
    "lastname": "Doe",
    "gender": "M",
    "dob": "1990-01-01",
    "ip_address": "123.123.123.123",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "address": "123 Main St",
    "zip": "12345",
    "city": "Anytown",
    "country": "DE",
    "country_code": "DE",
    "product": [
      {
        "id": "1",
        "quantity": "2",
        "price": "100",
        "name": "Product 1"
      }
    ],
    "totalAmount": "200",
    "discountAmount": "10",
    "shippingAmount": "5"
  }
}

use Stegback\Ratepay\Services\RatepayApi;
{
        $ratepay = new RatepayApi;
        $response = $ratepay->paymentRequest($data); // array for checkout which is showing in example.
        return $response;
}

ELV (Elektronisches Lastschriftverfahren - Direct Debit):

For the ELV payment method, the following additional parameters are required:

• owner: Owner of the bank account.

• iban: IBAN (International Bank Account Number) of the customer.