RAratepay
Session management API

Creates a new session

Changed on
post/pps/api/v1/session

Request

  • Base URL
    https://payment-integration.ratepay.com
  • URL
    https://payment-integration.ratepay.com/pps/api/v1/session
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Optional ID generated by client to uniquely identify the request. It is highly recommended to use a UUID version 4. Do not reuse an idempotency key for different calls. See Idempotency in HPP for further details.

Request body

Example request

{
  "order_data": {
    "buyer": {
      "billing_address": {
        "city": "Berlin",
        "country_code": "DE",
        "street": "Schönhauser Allee",
        "street_addition": "Seitenflügel, 2. HH",
        "street_number": "84",
        "zip_code": "10439"
      }
    },
    "delivery": {
      "address": {
        "city": "Berlin",
        "country_code": "DE",
        "street": "Schönhauser Allee",
        "street_addition": "Seitenflügel, 2. HH",
        "street_number": "84",
        "zip_code": "10439"
      }
    },
    "payment_method": {
      "payment_option": "OPEN_INVOICE",
      "transfer_type": "BANK_TRANSFER"
    }
  }
}

Response

Session created successfully

session_idstring
landing_pagestring required

Changes

  • 08d328c58846Revision changes
    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • info

      added subschema #1: B2C subschema #2: B2B to the / request property oneOf list

    • info

      added subschema #1: Regular delivery subschema #2: In-Store Collect subschema #3: Pick-Up Box subschema #4: Pick-Up Shop to the / request property oneOf list