Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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"
    ;       }
    ;     ]
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"x-hotelid","{{HotelId}}")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"x-app-key","{{AppKey}}")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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": [
  ]
}