Jump to

• Request
• Response

Registers credit card with OPI services

post

/spms/v2/ships/{shipId}/creditCards

This is to register credit card with OPI services

Request

Supported Media Types

• application/json

Path Parameters

• shipId: integer
  Ship identifier number

Body ()

Required fields to register a credit card

Root Schema : CreditCardRegistration

Type: object

Title: CreditCardRegistration

request parameters for registering a credit card

Show Source

• deviceId(optional): string
  Credit Card Terminal number

  Example: 12345
• isCheckInMode(optional): boolean
  Indicates whether this is in check in mode (Only true is supported at the moment)

  Example: true
• profileId(optional): number
  Profile identifier number

  Example: 123456

{
    "title":"CreditCardRegistration",
    "description":"request parameters for registering a credit card",
    "type":"object",
    "properties":{
        "profileId":{
            "type":"number",
            "description":"Profile identifier number",
            "example":123456
        },
        "isCheckInMode":{
            "type":"boolean",
            "description":"Indicates whether this is in check in mode (Only true is supported at the moment)",
            "example":true
        },
        "deviceId":{
            "type":"string",
            "description":"Credit Card Terminal number",
            "example":"12345"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

OK

Body ()

Root Schema : Credit card registration

Type: object

Title: Credit card registration

The response for credit card after successfully registered

Show Source

• cardID(optional): number
  Credit Card record id

  Example: 100000
• cardNumber(optional): string
  Obfuscated Card Number

  Example: XXXXXXXXXXXX9900
• cardType(optional): string
  The credit card type

  Example: VA
• depositLimit(optional): number
  Card deposit limit

  Example: 250
• displayName(optional): string
  Card holder's name

  Example: Guest Name
• expirationDate(optional): string
  Card expiration in YYMM format

  Example: 2912
• isDebit(optional): boolean
  Indicates whether the card is credit or debit card

  Example: true
• isOfflineAuthorization(optional): boolean
  Indicates Authorization is online or offline

  Example: true
• offlineAuthorizationMessage(optional): string
  offline Authorization Message

  Example: Initial Authorization will be handled by OPI Manager.
• ownerName(optional): string
  Card holder's name

  Example: First Name Last Name

{
    "title":"Credit card registration",
    "description":"The response for credit card after successfully registered",
    "type":"object",
    "properties":{
        "cardID":{
            "type":"number",
            "description":"Credit Card record id",
            "example":100000
        },
        "ownerName":{
            "type":"string",
            "description":"Card holder's name",
            "example":"First Name Last Name"
        },
        "displayName":{
            "type":"string",
            "description":"Card holder's name",
            "example":"Guest Name"
        },
        "cardNumber":{
            "type":"string",
            "description":"Obfuscated Card Number",
            "example":"XXXXXXXXXXXX9900"
        },
        "expirationDate":{
            "type":"string",
            "description":"Card expiration in YYMM format",
            "example":"2912"
        },
        "depositLimit":{
            "type":"number",
            "description":"Card deposit limit",
            "example":250
        },
        "cardType":{
            "type":"string",
            "description":"The credit card type",
            "example":"VA"
        },
        "isDebit":{
            "type":"boolean",
            "description":"Indicates whether the card is credit or debit card",
            "example":true
        },
        "isOfflineAuthorization":{
            "type":"boolean",
            "description":"Indicates Authorization is online or offline",
            "example":true
        },
        "offlineAuthorizationMessage":{
            "type":"string",
            "description":"offline Authorization Message",
            "example":"Initial Authorization will be handled by OPI Manager."
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/RegisterCreditCardErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Bad Request",
        "detail":[
            {
                "errorPath":"Guest",
                "message":"The guest cannot be found."
            }
        ]
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Bad Request",
    "detail":[
        {
            "errorPath":"Guest",
            "message":"The guest cannot be found."
        }
    ]
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "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(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/RegisterCreditCardErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): string

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

404 Response

Not found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/RegisterCreditCardErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship 123 was not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship 123 was not found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/RegisterCreditCardErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/RegisterCreditCardErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Not Acceptable",
        "detail":"Get credit card failed"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Not Acceptable",
    "detail":"Get credit card failed"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

{
    "type":"https://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(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/RegisterCreditCardErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/RegisterCreditCardErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): string

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

Back to Top