POST api/checkoutOneTimePayment/{cartId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cartId

integer

Required

Body Parameters

SinglePaymentCreditCard
NameDescriptionTypeAdditional information
CardNumber

string

Required

CardHolderName

string

Required

ExpirationMonth

integer

Required

Range: inclusive between 1 and 12

ExpirationYear

integer

Required

CVV

string

Required

RememberCard

boolean

None.

UseAvailableCredit

boolean

None.

IpAddress

string

Required

Request Formats

application/json, text/json

Sample:
{
  "CardNumber": "sample string 1",
  "CardHolderName": "sample string 2",
  "ExpirationMonth": 3,
  "ExpirationYear": 4,
  "CVV": "sample string 5",
  "RememberCard": true,
  "UseAvailableCredit": true,
  "IpAddress": "sample string 7"
}

application/xml, text/xml

Sample:
<SinglePaymentCreditCard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.CMS.API.Models.Handlers">
  <CVV>sample string 5</CVV>
  <CardHolderName>sample string 2</CardHolderName>
  <CardNumber>sample string 1</CardNumber>
  <ExpirationMonth>3</ExpirationMonth>
  <ExpirationYear>4</ExpirationYear>
  <IpAddress>sample string 7</IpAddress>
  <RememberCard>true</RememberCard>
  <UseAvailableCredit>true</UseAvailableCredit>
</SinglePaymentCreditCard>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SinglePaymentCreditCard'.

Response Information

Resource Description

PaymentReport
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PaymentReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.CMS.API.Models.Handlers">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <IsSuccess>true</IsSuccess>
</PaymentReport>