POST api/v{version}/Cart/CheckOut
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
CheckOutModel| Name | Description | Type | Additional information |
|---|---|---|---|
| WalletId | integer |
Required |
|
| FirstName | string |
Required |
|
| LastName | string |
Required |
|
| Address1 | string |
Required |
|
| Address2 | string |
None. |
|
| CardType | string |
None. |
|
| City | string |
Required |
|
| SelectedState | string |
Required |
|
| Zip | string |
Required |
|
| CreditCardNumber | string |
Required |
|
| CardCode | string |
Required |
|
| ExpirationMonth | string |
Required |
|
| ExpirationYear | string |
Required |
|
| SaveToWallet | boolean |
None. |
|
| AgreeToTerms | boolean |
Required |
|
| ABANumber | string |
None. |
|
| AccountNumber | string |
None. |
|
| AcountType | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"WalletId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Address1": "sample string 3",
"Address2": "sample string 4",
"CardType": "sample string 5",
"City": "sample string 6",
"SelectedState": "sample string 7",
"Zip": "sample string 8",
"CreditCardNumber": "sample string 9",
"CardCode": "sample string 10",
"ExpirationMonth": "sample string 11",
"ExpirationYear": "sample string 12",
"SaveToWallet": true,
"AgreeToTerms": true,
"ABANumber": "sample string 15",
"AccountNumber": "sample string 16",
"AcountType": 17
}
application/xml, text/xml
Sample:
<CheckOutModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models"> <ABANumber>sample string 15</ABANumber> <AccountNumber>sample string 16</AccountNumber> <AcountType>17</AcountType> <Address1>sample string 3</Address1> <Address2>sample string 4</Address2> <AgreeToTerms>true</AgreeToTerms> <CardCode>sample string 10</CardCode> <CardType>sample string 5</CardType> <City>sample string 6</City> <CreditCardNumber>sample string 9</CreditCardNumber> <ExpirationMonth>sample string 11</ExpirationMonth> <ExpirationYear>sample string 12</ExpirationYear> <FirstName>sample string 1</FirstName> <LastName>sample string 2</LastName> <SaveToWallet>true</SaveToWallet> <SelectedState>sample string 7</SelectedState> <WalletId>1</WalletId> <Zip>sample string 8</Zip> </CheckOutModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PaymentResponseResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | string |
None. |
|
| AmountPaid | string |
None. |
|
| AmountpaidSF | string |
None. |
|
| ConvenienceFee | string |
None. |
|
| ApprovalCode | string |
None. |
|
| StatusCode | string |
None. |
|
| TransactionId | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Result": "sample string 1",
"AmountPaid": "sample string 2",
"AmountpaidSF": "sample string 3",
"ConvenienceFee": "sample string 4",
"ApprovalCode": "sample string 5",
"StatusCode": "sample string 6",
"TransactionId": "sample string 7"
}
application/xml, text/xml
Sample:
<PaymentResponseResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models"> <AmountPaid>sample string 2</AmountPaid> <AmountpaidSF>sample string 3</AmountpaidSF> <ApprovalCode>sample string 5</ApprovalCode> <ConvenienceFee>sample string 4</ConvenienceFee> <Result>sample string 1</Result> <StatusCode>sample string 6</StatusCode> <TransactionId>sample string 7</TransactionId> </PaymentResponseResult>