Send Initial Auth request to SPMS OPI WebAPI
post
/spms/v2/ships/{shipId}/creditCardTransactions/initialAuthorization
This api will generate a new Initial Auth token
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : Initial Auth Parameter
Type:
object
Title:
Initial Auth Parameter
This is the parameter required to request for Initial Auth
Show Source
-
accountId(optional):
string
This initial auth is requested for this account id
-
amount(optional):
string
This amount requested for this initial auth
-
cardId(optional):
string
This initial auth is requested for this card id
Response
Supported Media Types
- application/json
200 Response
Get validation result based on the parameter shipId and profileId
Root Schema : Authorization Request Response
Type:
object
Title:
Authorization Request Response
This is the request format required to be sent to OPI to get Initial Auth
Show Source
Nested Schema : CpAuthor
Type:
Show Source
object
-
AuthNum(optional):
string
Authorization NumberExample:
123456
-
CardId(optional):
string
Card IdExample:
123123123
-
CardType(optional):
string
Card TypeExample:
VI
-
CreditcardNum(optional):
string
Encrypted Credit Card NumberExample:
XXXXXXXXXXXX1364
-
ExpyDate(optional):
string
A request type for OPIExample:
2912
-
GuestNum(optional):
string
Guest Id from SPMSExample:
12345678
-
MerchantId(optional):
string
Merchant IdExample:
-
-
PathId(optional):
string
Id for the Initial AuthExample:
12345678
-
RequestType(optional):
string
A request type for OPIExample:
4
-
SequenceNum(optional):
string
Card Id from SPMSExample:
12345678
-
TotalAmount(optional):
string
Total Amount to be requested for this credit cardExample:
123.00
-
WSNum(optional):
string
Terminal IdExample:
-
400 Response
Unknown request found
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
401 Response
You are not authorized to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
You are forbidden to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
Record not found
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
405 Response
This method is not available
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
415 Response
This media supplied is not supported
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occured while processing this request
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
502 Response
Bad Gateway
503 Response
Service not available