Skip to content

Create and return the payment terminal url for a booking

POST
/v1/WebBooking/WebBookings/{id}/PaymentTerminal
curl --request POST \
  --url https://rms.dev.caspeco.net/api/booking/v1/WebBooking/WebBookings/example/PaymentTerminal \
  --header 'Content-Type: application/json' \
  --header 'system: example' \
  --data '{ "contact": { "returning": true, "id": 1, "fname": "example", "lname": "example", "phone": "example", "mobile": "example", "fax": "example", "email": "example", "streetaddress": "example", "zipcode": "example", "city": "example", "newsletter": true, "lastGrab": true, "allowStoringForever": true, "deliveryInfo": "example" }, "customer": { "id": 1, "name": "example", "streetaddress": "example", "zipcode": "example", "city": "example", "orgNr": "example", "phone": "example", "fax": "example", "email": "example", "information": "example", "invoiceStreetaddress": "example", "invoiceZipCode": "example", "invoiceCity": "example", "invoiceCode1": "example", "invoiceCode2": "example", "invoiceCode3": "example", "customerNumber": "example", "accountManager": "example", "webpage": "example", "lastChangedUtc": "2026-04-15T12:00:00Z", "lastChangedBy": "example", "agreementLevel": 1 }, "bookingStatus": 1, "disableAllConfirmationMessages": true, "disableEmailConfirmationMessage": true, "disableSmsConfirmationMessage": true, "message": "example", "invoiceMarking": "example", "wishToBeInvoiced": true, "logMessage": "example", "terminalReturnUrl": "example", "payMethod": 0 }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Booking guid

Header Parameters

Section titled “Header Parameters”
system
required
string

The system name / database to query

Request Bodyrequired

Section titled “Request Bodyrequired”

Includes terminalReturnUrl and mobilePhoneNumber

Media typeapplication/json
object
contact
One of:
object
returning
boolean
id
integer format: int64
fname
string
lname
string
phone
string
mobile
string
fax
string
email
string
streetaddress
string
zipcode
string
city
string
newsletter
boolean
lastGrab
boolean
allowStoringForever
boolean
deliveryInfo
string
customer
One of:
object
id
integer format: int64
name
string
streetaddress
string
zipcode
string
city
string
orgNr
string
phone
string
fax
string
email
string
information
string
invoiceStreetaddress
string
invoiceZipCode
string
invoiceCity
string
invoiceCode1
string
invoiceCode2
string
invoiceCode3
string
customerNumber
string
accountManager
string
webpage
string
lastChangedUtc
string format: date-time
lastChangedBy
string
agreementLevel
integer format: int32
bookingStatus
integer format: int32
disableAllConfirmationMessages
boolean
disableEmailConfirmationMessage
boolean
disableSmsConfirmationMessage
boolean
message
string
nullable
invoiceMarking
string
nullable
wishToBeInvoiced
boolean
logMessage
string
nullable
terminalReturnUrl
required
string
>= 1 characters
payMethod
One of:
integer
Allowed values: 0 1 6 7 999

Responses

Section titled “Responses”

200

Section titled “200”

Url to payment terminal

Media typeapplication/json
string
Example
{
  "application/json": {
    "guid": "900A1595-354F-4F3C-BCA6-797EB90796BF",
    "globalBookingNumber": "X7GW",
    "unitId": 827,
    "start": "2015-06-15T18:00:00",
    "end": "2015-06-15T20:00:00",
    "status": 102,
    "subStatus": 0,
    "statusName": "confirmed",
    "guests": 4,
    "guestsChildren": 2,
    "message": "The children will use normal chairs",
    "createdDate": "2015-05-24T16:34:29",
    "changeDate": "2015-05-24T16:34:29",
    "recoupTime": 15,
    "articles": [
      {
        "articleId": 82735,
        "bookedArticleId": 0,
        "bookedArticleParentId": 0,
        "sectionId": 0,
        "articleGroupId": 726,
        "articleGroupName": "Outside",
        "articleGroupType": 0,
        "unitId": 827,
        "departmentId": "1,2,3",
        "start": "2015-06-15T18:00:00",
        "end": "2015-06-15T20:00:00",
        "name": "Table 10",
        "tableName": "10",
        "tableNumber": "10",
        "tableChairs": 2,
        "message": "",
        "quantity": 0,
        "isTable": true,
        "outPriceIncVat": 0,
        "vat": 0,
        "webFlags": 0,
        "priceModel": 0,
        "outAmountExVat": 0,
        "outAmountInclVat": 0
      },
      {
        "articleId": 82736,
        "bookedArticleId": 0,
        "bookedArticleParentId": 0,
        "sectionId": 0,
        "articleGroupId": 726,
        "articleGroupName": "Outside",
        "articleGroupType": 0,
        "unitId": 827,
        "departmentId": "1,2,3",
        "start": "2015-06-15T18:00:00",
        "end": "2015-06-15T20:00:00",
        "name": "Table 11",
        "tableName": "11",
        "tableNumber": "11",
        "tableChairs": 2,
        "message": "",
        "quantity": 0,
        "isTable": true,
        "outPriceIncVat": 0,
        "vat": 0,
        "webFlags": 0,
        "priceModel": 0,
        "outAmountExVat": 0,
        "outAmountInclVat": 0
      }
    ],
    "nonTableArticles": [
      {
        "articleId": 82735,
        "bookedArticleId": 0,
        "bookedArticleParentId": 0,
        "sectionId": 0,
        "articleGroupId": 726,
        "articleGroupName": "À la carte",
        "articleGroupType": 0,
        "unitId": 827,
        "departmentId": "1,2,3",
        "start": "2015-06-15T18:00:00",
        "end": "2015-06-15T20:00:00",
        "name": "Pasta Carbonara",
        "tableChairs": 0,
        "message": "Contains milk",
        "quantity": 4,
        "isTable": false,
        "outPriceIncVat": 0,
        "vat": 0,
        "webFlags": 0,
        "priceModel": 0,
        "outAmountExVat": 0,
        "outAmountInclVat": 0
      }
    ],
    "chargeType": 0,
    "chargeId": "7263523",
    "chargeShouldPayAmount": 120,
    "chargeShouldPayVat": 0.2,
    "chargeStatus": 0,
    "chargeShouldPayAmountVat": 100,
    "chargeAuthorizedAmount": 120,
    "chargePayedAmount": 120,
    "chargeRefundedAmount": 0,
    "contact": {
      "returning": false,
      "id": 0,
      "fname": "John",
      "lname": "Doe",
      "phone": "",
      "mobile": "+46731234567",
      "fax": "",
      "email": "john.doe@mail.com",
      "streetaddress": "Main Street 1",
      "zipcode": "12345",
      "city": "Uppsala",
      "newsletter": false,
      "lastGrab": false,
      "allowStoringForever": true,
      "deliveryInfo": ""
    },
    "customer": {
      "id": 0,
      "name": "John Doe Heavy Industries",
      "streetaddress": "Main Street 1",
      "zipcode": "12345",
      "city": "Uppsala",
      "orgNr": "556994-9927",
      "phone": "+46731234567",
      "fax": "",
      "email": "john.doe@mail.com",
      "information": "Always wants to pay double",
      "invoiceStreetaddress": "Main Street 1",
      "invoiceZipCode": "56789",
      "invoiceCity": "Uppsala",
      "invoiceCode1": "",
      "invoiceCode2": "",
      "invoiceCode3": "",
      "customerNumber": "",
      "accountManager": "",
      "webpage": "",
      "lastChangedUtc": "1753-01-01T00:00:00",
      "lastChangedBy": "",
      "agreementLevel": 0
    },
    "payMethod": {
      "id": 2,
      "name": "Invoice",
      "hidden": false,
      "changeStatus": 0
    },
    "arrangementName": "Bachelor Party for Steve",
    "markings": [
      {
        "text": "VIP",
        "prefix": "V",
        "hidden": false
      }
    ],
    "bookingFlags": 0,
    "paymentEvents": []
  }
}