Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
Payment Sessions

Create payment session

Creates a new Payment Session.

post/v1/payment-sessions

Headers

Merchant-Idstring required

Request body

amountType'MAX' | 'EXACT' | 'VARIABLE'

Defines if the provided 'amount' is a maximum value or an exact value. This field is relevant only for recurring payments.

recurringboolean required

Indicates whether this is a recurring payment which needs the creation of a payment-agreement.

webhooksUrlstring

The URL to which the agreement state changes will be notified

paymentDescriptorstring

The payment descriptor (arbitrary string). May be presented to the consumer.

merchantPaymentChargeReferencestring

The merchant payment charge reference.

merchantPaymentAgreementReferencestring

The merchant payment agreement reference.

paymentAgreementIdstring

ID of an existing payment-agreement with the consumer

startDatestring date-time

The start date of the agreement

endDatestring date-time

The end date of the agreement

autoCaptureboolean

Indicates whether the payment charge should be automatically captured after a successful authorization.

labelsobject

Custom labels associated with the payment charge or agreement.

Example request

{
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "consumer": {
    "name": "John Smith",
    "email": "johnsmith@example.com",
    "phone": "+491521111111",
    "country": "DE",
    "locale": "de-DE",
    "taxIdentification": "0798154336790",
    "merchantConsumerReference": "5c019979-0751-469e-96e0-b67f1d95c577",
    "billingAddress": {
      "street": "123 Main St",
      "city": "Anytown",
      "region": "CA",
      "postalCode": "12345",
      "country": "US"
    },
    "client": {
      "ip": "11.22.22.33",
      "userAgent": "Mozilla/5.0 (X11; CrOS x86_64 8172.45.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.64 Safari/537.36"
    }
  },
  "webhooksUrl": "https://webhooks.example.com",
  "authenticationSettings": [
    {
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ],
  "paymentDescriptor": "Acme - ORDER 1234",
  "merchantPaymentChargeReference": "5c019979-0751-469e-96e0-b67f1d95c577",
  "merchantPaymentAgreementReference": "5c019979-0751-469e-96e0-b67f1d95c577",
  "paymentAgreementId": "agr_FlTZQyHL4DeUYLYtXmOdq",
  "order": {
    "orderItems": [
      {
        "sku": "LS123456789",
        "category": "bicycle",
        "name": "White T-Shirt",
        "quantity": 1,
        "amount": 1000
      }
    ],
    "shippingAddress": {
      "street": "123 Main St",
      "city": "Anytown",
      "region": "CA",
      "postalCode": "12345",
      "country": "US"
    },
    "industryData": [
      {
        "details": {
          "pnr": "SKJ2NS01AS",
          "numberOfPassengers": 1,
          "airlineCode": "016",
          "passengerEmail": "john@gmail.com",
          "passengerPhone": "14082319231",
          "passengerName": "John Doe",
          "carrierCode": "016",
          "tripSegments": [
            {
              "fareBasisCode": "YE3MGB",
              "departureAirportCode": "MAN",
              "destinationAirportCode": "SYD",
              "flightNumber": "BA98",
              "departureDate": "2025-01-01",
              "flightCarrierCode": "016",
              "segmentId": "1"
            }
          ]
        }
      }
    ]
  },
  "initialPaymentCharge": {
    "paymentDescriptor": "PPRO - ORDER 1234",
    "amount": {
      "value": 1000,
      "currency": "EUR"
    },
    "autoCapture": true,
    "merchantPaymentChargeReference": "5c019979-0751-469e-96e0-b67f1d95c577"
  },
  "frequency": {
    "type": "MONTHLY",
    "interval": 3
  },
  "startDate": "2023-03-26T20:24:27+00:00",
  "endDate": "2023-11-27T09:30:00+00:00"
}

Response

OK