Oracle Hospitality Cruise Property Management REST API 23.2.2

Create new payment posting

post

/spms/v2/ships/{shipId}/financials/folios/payment

Request

Supported Media Types

application/json

Path Parameters

shipId(required): number(12345678)

Ship ID

Required to create payment

Root Schema : CreatePaymentRequest

Match All

Show Source

object CreatePayment

Title: CreatePayment

{
    "allOf":[
        {
            "$ref":"#/definitions/CreatePayment"
        }
    ]
}

Nested Schema : CreatePayment

Type: object

Title: CreatePayment

Show Source

invoiceWindowNumbers(required): array invoiceWindowNumbers

1 - Invoice window number 1, 2 - Invoice window number 2, 3 - Invoice window number 3, 4 - Invoice window number 4, P - Package Invoice, Package invoice cannot process with other invoice window numbers
isDisablePostingStatus: boolean

Disabled payer posting status

Example: false
payerId(required): integer

Payer Id

Example: 3118243
paymentNotes: string

Maximum Length: 40

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=|^'":;@`]*$

payment notes

Example: comment 1
subDepartmentCode(required): string

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=|^'":;@`]*$

Sub department code

Example: 1001
totalAmount(required): number

total amount

Example: 100

{
    "title":"CreatePayment",
    "type":"object",
    "properties":{
        "payerId":{
            "type":"integer",
            "description":"Payer Id",
            "example":"3118243"
        },
        "paymentNotes":{
            "type":"string",
            "description":"payment notes",
            "maxLength":"40",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"comment 1"
        },
        "subDepartmentCode":{
            "type":"string",
            "description":"Sub department code",
            "maxLength":"10",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"1001"
        },
        "totalAmount":{
            "type":"number",
            "description":"total amount",
            "example":"100"
        },
        "invoiceWindowNumbers":{
            "type":"array",
            "description":"1 - Invoice window number 1, 2 - Invoice window number 2, 3 - Invoice window number 3, 4 - Invoice window number 4, P - Package Invoice, Package invoice cannot process with other invoice window numbers",
            "items":{
                "type":"string"
            },
            "example":[
                "1"
            ]
        },
        "isDisablePostingStatus":{
            "type":"boolean",
            "description":"Disabled payer posting status",
            "example":false
        }
    },
    "required":[
        "payerId",
        "subDepartmentCode",
        "totalAmount",
        "invoiceWindowNumbers"
    ]
}

Nested Schema : invoiceWindowNumbers

Type: array

1 - Invoice window number 1, 2 - Invoice window number 2, 3 - Invoice window number 3, 4 - Invoice window number 4, P - Package Invoice, Package invoice cannot process with other invoice window numbers

Show Source

Array of: string

{
    "type":"array",
    "description":"1 - Invoice window number 1, 2 - Invoice window number 2, 3 - Invoice window number 3, 4 - Invoice window number 4, P - Package Invoice, Package invoice cannot process with other invoice window numbers",
    "items":{
        "type":"string"
    },
    "example":[
        "1"
    ]
}

Example:

[
    "1"
]

Response

Supported Media Types

application/json

201 Response

Created

Root Schema : CreatePaymentResponse

Match All

Show Source

object CreatePaymentResponse

Title: CreatePaymentResponse

{
    "allOf":[
        {
            "$ref":"#/definitions/PaymentResponse"
        }
    ]
}

Nested Schema : CreatePaymentResponse

Type: object

Title: CreatePaymentResponse

Show Source

buyerId: integer

Buyer Id

Example: 3118243
id: integer

Payment Id

Example: 1
invoiceWindowNumber: string

invoice window number

Example: 1
packagePlanId: integer

Package plan id

Example: 1001
payerId: integer

Payer Id

Example: 3118243
paymentNotes: string

payment notes

Example: Comment 1
subDepartmentCode: string

Sub department code

Example: 1001
totalAmount: number

total amount

Example: 100

{
    "title":"CreatePaymentResponse",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Payment Id",
            "example":"1"
        },
        "totalAmount":{
            "type":"number",
            "description":"total amount",
            "example":"100"
        },
        "invoiceWindowNumber":{
            "type":"string",
            "description":"invoice window number",
            "example":"1"
        },
        "buyerId":{
            "type":"integer",
            "description":"Buyer Id",
            "example":"3118243"
        },
        "payerId":{
            "type":"integer",
            "description":"Payer Id",
            "example":"3118243"
        },
        "subDepartmentCode":{
            "type":"string",
            "description":"Sub department code",
            "example":"1001"
        },
        "paymentNotes":{
            "type":"string",
            "description":"payment notes",
            "example":"Comment 1"
        },
        "packagePlanId":{
            "type":"integer",
            "description":"Package plan id",
            "example":"1001"
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Bad Request",
        "detail":"subDepartmentCode 1 is not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Bad Request",
    "detail":"subDepartmentCode 1 is not found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable.  Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

504 Response

Gateway Timeout

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPaymentErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Gateway Timeout",
        "detail":"Settlement time out"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Gateway Timeout",
    "detail":"Settlement time out"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}