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
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 numberExample:
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 numberExample:
123456
Response
Supported Media Types
- application/json
201 Response
OK
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 idExample:
100000
-
cardNumber(optional):
string
Obfuscated Card NumberExample:
XXXXXXXXXXXX9900
-
cardType(optional):
string
The credit card typeExample:
VA
-
depositLimit(optional):
number
Card deposit limitExample:
250
-
displayName(optional):
string
Card holder's nameExample:
Guest Name
-
expirationDate(optional):
string
Card expiration in YYMM formatExample:
2912
-
isDebit(optional):
boolean
Indicates whether the card is credit or debit cardExample:
true
-
isOfflineAuthorization(optional):
boolean
Indicates Authorization is online or offlineExample:
true
-
offlineAuthorizationMessage(optional):
string
offline Authorization MessageExample:
Initial Authorization will be handled by OPI Manager.
-
ownerName(optional):
string
Card holder's nameExample:
First Name Last Name
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
404 Response
Not found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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