Skip to content
API requests
/
/Session management API

OpenAPI definition (v0)

Download OpenAPI description
hpp_api.json
hpp_api.yaml
Languages
Servers
Integration environment

https://payment-integration.ratepay.com/

Production environment

https://payment.ratepay.com/

Session management API

Operations

Creates a new session

Request

Security
Bearer Authentication
Bodyapplication/jsonrequired
order_dataobject(OrderData)required
url_dataobject(UrlData)
curl -i -X POST \
  https://payment-integration.ratepay.com/pps/api/v1/session \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_data": {
      "authorization_expires": "string",
      "buyer": {
        "billing_address": {
          "city": "Berlin",
          "country_code": "DE",
          "street": "Schönhauser Allee",
          "street_addition": "Seitenflügel, 2. HH",
          "street_number": "84",
          "zip_code": "10439"
        },
        "company": {
          "first_name": "string",
          "last_name": "string",
          "name": "string",
          "vat_id": "string"
        },
        "contact": {
          "email": "string",
          "phone": "string"
        },
        "language": "string",
        "person": {
          "date_of_birth": "string",
          "first_name": "string",
          "last_name": "string",
          "title": "string"
        },
        "shop_buyer_id": "string"
      },
      "currency": "string",
      "delivery": {
        "address": {
          "city": "Berlin",
          "country_code": "DE",
          "street": "Schönhauser Allee",
          "street_addition": "Seitenflügel, 2. HH",
          "street_number": "84",
          "zip_code": "10439"
        },
        "company": "string",
        "first_name": "string",
        "full_name": "string",
        "in_store_collect": {
          "city": "string",
          "country_code": "string",
          "location_name": "string",
          "street": "string",
          "street_addition": "string",
          "street_number": "string",
          "zip_code": "string"
        },
        "last_name": "string",
        "pick_up_box": {
          "carrier_name": "string",
          "city": "string",
          "country_code": "string",
          "location_id": "string",
          "recipient_account_id": "string",
          "zip_code": "string"
        },
        "pick_up_shop": {
          "city": "string",
          "country_code": "string",
          "location_name": "string",
          "street": "string",
          "street_addition": "string",
          "street_number": "string",
          "zip_code": "string"
        }
      },
      "partner_operation_id": "string",
      "partner_transaction_id": "string",
      "shop_baskets": [
        {
          "gross_amount": 0,
          "items": [
            {
              "article_number": "string",
              "category": "string",
              "description": "string",
              "gross_total_price": 0,
              "gross_unit_discount": 0,
              "gross_unit_price": 0,
              "name": "string",
              "net_total_price": 0,
              "net_unit_discount": 0,
              "net_unit_price": 0,
              "quantity": 0,
              "tax_rate": 0,
              "unit": "string"
            }
          ],
          "partner_shop_id": "string",
          "shop_merchant_id": "string",
          "shop_transaction_id": "string",
          "special_items": [
            {
              "article_number": "string",
              "category": "string",
              "description": "string",
              "gross_total_price": 0,
              "gross_unit_discount": 0,
              "gross_unit_price": 0,
              "name": "string",
              "net_total_price": 0,
              "net_unit_discount": 0,
              "net_unit_price": 0,
              "quantity": 0,
              "tax_rate": 0,
              "unit": "string"
            }
          ],
          "vats": [
            {
              "net_amount": 0,
              "tax_amount": 0,
              "tax_rate": 0
            }
          ]
        }
      ],
      "shops": [
        {
          "correspondence_settings": {
            "branding_settings": {
              "highlight_color": "string",
              "logo_position": "LEFT",
              "logo_url": "string"
            },
            "slangs": {
              "de": {
                "customer_service_contact": [
                  null
                ],
                "formal_tone": "FORMAL",
                "name_format": "EMTPY",
                "salutation": "string",
                "transaction_type": "ORDER"
              },
              "en": {
                "customer_service_contact": [
                  null
                ],
                "formal_tone": "FORMAL",
                "name_format": "EMTPY",
                "salutation": "string",
                "transaction_type": "ORDER"
              },
              "fr": {
                "customer_service_contact": [
                  null
                ],
                "formal_tone": "FORMAL",
                "name_format": "EMTPY",
                "salutation": "string",
                "transaction_type": "ORDER"
              },
              "nl": {
                "customer_service_contact": [
                  null
                ],
                "formal_tone": "FORMAL",
                "name_format": "EMTPY",
                "salutation": "string",
                "transaction_type": "ORDER"
              }
            }
          },
          "legal": {
            "commercial_register_number": "string",
            "legal_form": "string",
            "name": "string"
          },
          "merchant": {
            "merchant_id": "string",
            "merchant_name": "string"
          },
          "merchant_category_code": "string",
          "name": "string",
          "partner_shop_id": "string"
        }
      ]
    },
    "url_data": {
      "success_url": "string",
      "cancel_url": "string",
      "failure_url": "string",
      "webhook_url": "string"
    }
  }'

Responses

Session created successfully

Bodyapplication/json
session_idstring
landing_pagestringrequired
Response
application/json
{
  "session_id": "string",
  "landing_page": "string"
}

Session Records API

Operations

Webhook format

Operations