Chilkat Online Tools

autoit / ORACLE Hospitality OPERA Cloud REST API Workflows / Add a Payment to the Folio

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

; The following JSON is sent in the request body.

; {
;   "criteria": {
;     "overrideInsufficientCC": false,
;     "applyCCSurcharge": false,
;     "vATOffset": false,
;     "reservationId": {
;       "idContext": "OPERA",
;       "id": 123,
;       "type": "Reservation"
;     },
;     "paymentMethod": {
;       "paymentMethod": "CA"
;     },
;     "postingReference": "CA Posting - Window 1",
;     "postingAmount": {
;       "amount": 429,
;       "currencyCode": "USD"
;     },
;     "cashierId": 4,
;     "hotelId": "{{HotelId}}",
;     "folioWindowNo": "1",
;     "overrideARCreditLimit": false
;   }
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateBool("criteria.overrideInsufficientCC",False)
$oJson.UpdateBool("criteria.applyCCSurcharge",False)
$oJson.UpdateBool("criteria.vATOffset",False)
$oJson.UpdateString("criteria.reservationId.idContext","OPERA")
$oJson.UpdateInt("criteria.reservationId.id",123)
$oJson.UpdateString("criteria.reservationId.type","Reservation")
$oJson.UpdateString("criteria.paymentMethod.paymentMethod","CA")
$oJson.UpdateString("criteria.postingReference","CA Posting - Window 1")
$oJson.UpdateInt("criteria.postingAmount.amount",429)
$oJson.UpdateString("criteria.postingAmount.currencyCode","USD")
$oJson.UpdateInt("criteria.cashierId",4)
$oJson.UpdateString("criteria.hotelId","{{HotelId}}")
$oJson.UpdateString("criteria.folioWindowNo","1")
$oJson.UpdateBool("criteria.overrideARCreditLimit",False)

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "x-hotelid","{{HotelId}}"
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "x-app-key","{{AppKey}}"

Local $oResp = $oHttp.PostJson3("https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/payments","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "criteria": {
        "overrideInsufficientCC": false,
        "applyCCSurcharge": false,
        "vATOffset": false,
        "reservationId": {
            "idContext": "OPERA",
            "id": {{ReservationId}},
            "type": "Reservation"
        },
        "paymentMethod": {
            "paymentMethod": "CA"
        },
        "postingReference": "CA Posting - Window 1",
        "postingAmount": {
            "amount": 429,
            "currencyCode": "USD"
        },
        "cashierId": 4,
        "hotelId": "{{HotelId}}",
        "folioWindowNo": "1",
        "overrideARCreditLimit": false
    }
}'
https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/payments

Postman Collection Item JSON

{
  "name": "Add a Payment to the Folio",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"criteria\": {\r\n        \"overrideInsufficientCC\": false,\r\n        \"applyCCSurcharge\": false,\r\n        \"vATOffset\": false,\r\n        \"reservationId\": {\r\n            \"idContext\": \"OPERA\",\r\n            \"id\": {{ReservationId}},\r\n            \"type\": \"Reservation\"\r\n        },\r\n        \"paymentMethod\": {\r\n            \"paymentMethod\": \"CA\"\r\n        },\r\n        \"postingReference\": \"CA Posting - Window 1\",\r\n        \"postingAmount\": {\r\n            \"amount\": 429,\r\n            \"currencyCode\": \"USD\"\r\n        },\r\n        \"cashierId\": 4,\r\n        \"hotelId\": \"{{HotelId}}\",\r\n        \"folioWindowNo\": \"1\",\r\n        \"overrideARCreditLimit\": false\r\n    }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/payments",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "csh",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "payments"
      ]
    }
  },
  "response": [
  ]
}