Jump to

• Request
• Response

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

• shipId: string

Body ()

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

{
    "title":"Initial Auth Parameter",
    "description":"This is the parameter required to request for Initial Auth",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"This initial auth is requested for this account id"
        },
        "amount":{
            "type":"string",
            "description":"This amount requested for this initial auth"
        },
        "cardId":{
            "type":"string",
            "description":"This initial auth is requested for this card id"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Get validation result based on the parameter shipId and profileId

Body ()

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

• isOnline(optional): boolean
  Example: true
• opiXmlRequest(optional): object CpAuthor

{
    "title":"Authorization Request Response",
    "description":"This is the request format required to be sent to OPI to get Initial Auth",
    "properties":{
        "isOnline":{
            "type":"boolean",
            "example":true
        },
        "opiXmlRequest":{
            "type":"object",
            "$ref":"#/definitions/CpAuthor"
        }
    }
}

Nested Schema : CpAuthor

Type: object

Show Source

• AuthNum(optional): string
  Authorization Number

  Example: 123456
• CardId(optional): string
  Card Id

  Example: 123123123
• CardType(optional): string
  Card Type

  Example: VI
• CreditcardNum(optional): string
  Encrypted Credit Card Number

  Example: XXXXXXXXXXXX1364
• ExpyDate(optional): string
  A request type for OPI

  Example: 2912
• GuestNum(optional): string
  Guest Id from SPMS

  Example: 12345678
• MerchantId(optional): string
  Merchant Id

  Example: -
• PathId(optional): string
  Id for the Initial Auth

  Example: 12345678
• RequestType(optional): string
  A request type for OPI

  Example: 4
• SequenceNum(optional): string
  Card Id from SPMS

  Example: 12345678
• TotalAmount(optional): string
  Total Amount to be requested for this credit card

  Example: 123.00
• WSNum(optional): string
  Terminal Id

  Example: -

{
    "properties":{
        "PathId":{
            "type":"string",
            "description":"Id for the Initial Auth",
            "example":"12345678"
        },
        "GuestNum":{
            "type":"string",
            "description":"Guest Id from SPMS",
            "example":"12345678"
        },
        "SequenceNum":{
            "type":"string",
            "description":"Card Id from SPMS",
            "example":"12345678"
        },
        "TotalAmount":{
            "type":"string",
            "description":"Total Amount to be requested for this credit card",
            "example":"123.00"
        },
        "RequestType":{
            "type":"string",
            "description":"A request type for OPI",
            "example":"4"
        },
        "WSNum":{
            "type":"string",
            "description":"Terminal Id",
            "example":"-"
        },
        "MerchantId":{
            "type":"string",
            "description":"Merchant Id",
            "example":"-"
        },
        "CreditcardNum":{
            "type":"string",
            "description":"Encrypted Credit Card Number",
            "example":"XXXXXXXXXXXX1364"
        },
        "ExpyDate":{
            "type":"string",
            "description":"A request type for OPI",
            "example":"2912"
        },
        "CardId":{
            "type":"string",
            "description":"Card Id",
            "example":"123123123"
        },
        "AuthNum":{
            "type":"string",
            "description":"Authorization Number",
            "example":"123456"
        },
        "CardType":{
            "type":"string",
            "description":"Card Type",
            "example":"VI"
        }
    }
}

400 Response

Unknown request found

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

401 Response

You are not authorized to use this API

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

Record not found

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

This method is not available

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

This media supplied is not supported

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occured while processing this request

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top