Chilkat Online Tools

SQL Server / ORACLE Hospitality OPERA Cloud REST API Workflows / Update the reservations payment method

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    -- The following JSON is sent in the request body.

    -- {
    --   "reservations": {
    --     "reservationPaymentMethods": [
    --       {
    --         "paymentCard": {
    --           "cardType": "Va",
    --           "cardNumber": "4111111111111111",
    --           "expirationDate": "2025-12-31",
    --           "cardHolderName": "Test card name",
    --           "cardOrToken": "CardNumber"
    --         },
    --         "authorizationRule": {
    --           "code": "5",
    --           "amount": {
    --             "amount": "123.45",
    --             "currencyCode": "USD"
    --           }
    --         },
    --         "paymentMethod": "VA",
    --         "description": "Visa",
    --         "folioView": "1"
    --       }
    --     ]
    --   }
    -- }

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].paymentCard.cardType', 'Va'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].paymentCard.cardNumber', '4111111111111111'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].paymentCard.expirationDate', '2025-12-31'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].paymentCard.cardHolderName', 'Test card name'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].paymentCard.cardOrToken', 'CardNumber'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].authorizationRule.code', '5'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].authorizationRule.amount.amount', '123.45'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].authorizationRule.amount.currencyCode', 'USD'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].paymentMethod', 'VA'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].description', 'Visa'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservationPaymentMethods[0].folioView', '1'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-hotelid', '{{HotelId}}'
    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-app-key', '{{AppKey}}'

    DECLARE @sbRequestBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody


END
GO

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "reservations": {
        "reservationPaymentMethods": [
            {
                "paymentCard": {
                    "cardType": "Va",
                    "cardNumber": "4111111111111111",
                    "expirationDate": "2025-12-31",
                    "cardHolderName": "Test card name",
                    "cardOrToken": "CardNumber"
                },
                "authorizationRule": {
                    "code": "5",
                    "amount": {
                        "amount": "123.45",
                        "currencyCode": "USD"
                    }
                },
                "paymentMethod": "VA",
                "description": "Visa",
                "folioView": "1"
            }
        ]
    }
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}

Postman Collection Item JSON

{
  "name": "Update the reservations payment method",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-hotelid",
        "value": "{{HotelId}}",
        "type": "text"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"reservations\": {\r\n        \"reservationPaymentMethods\": [\r\n            {\r\n                \"paymentCard\": {\r\n                    \"cardType\": \"Va\",\r\n                    \"cardNumber\": \"4111111111111111\",\r\n                    \"expirationDate\": \"2025-12-31\",\r\n                    \"cardHolderName\": \"Test card name\",\r\n                    \"cardOrToken\": \"CardNumber\"\r\n                },\r\n                \"authorizationRule\": {\r\n                    \"code\": \"5\",\r\n                    \"amount\": {\r\n                        \"amount\": \"123.45\",\r\n                        \"currencyCode\": \"USD\"\r\n                    }\r\n                },\r\n                \"paymentMethod\": \"VA\",\r\n                \"description\": \"Visa\",\r\n                \"folioView\": \"1\"\r\n            }\r\n        ]\r\n    }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rsv",
        "v1",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}"
      ]
    },
    "description": "To update an existing reservation in OPERA by adding or removing Payment Methods"
  },
  "response": [
  ]
}