POST v1/ProfilePersons/{id}/OrderHistory/{orderId}/MakePayment/CreditCard

Make payment of the unpaid orders using a credit card.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required
orderId

integer

Required

Body Parameters

makepaymentCreditCardInput
NameDescriptionTypeAdditional information
cvv

string

None.
cardNumber

string

Required
expirationMonth

integer

Required
expirationYear

integer

Required
saveForFutureUse

boolean

None.
paymentAmount

decimal number

Required

Request Formats

application/json, text/json

Sample: 
{
  "cvv": "sample string 1",
  "cardNumber": "sample string 2",
  "expirationMonth": 3,
  "expirationYear": 4,
  "saveForFutureUse": true,
  "paymentAmount": 5.0
}

text/html

Sample: 
{"cvv":"sample string 1","cardNumber":"sample string 2","expirationMonth":3,"expirationYear":4,"saveForFutureUse":true,"paymentAmount":5.0}

application/xml, text/xml

Sample: 
<v1_ProfilePersons_ProfilePersonEndpointController.makepaymentCreditCardInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ProfilePersons_ProfilePersonEndpoint">
  <cardNumber>sample string 2</cardNumber>
  <cvv>sample string 1</cvv>
  <expirationMonth>3</expirationMonth>
  <expirationYear>4</expirationYear>
  <paymentAmount>5</paymentAmount>
  <saveForFutureUse>true</saveForFutureUse>
</v1_ProfilePersons_ProfilePersonEndpointController.makepaymentCreditCardInput>

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 'makepaymentCreditCardInput'.

Response Information

Resource Description

makepaymentCreditCardOutput
NameDescriptionTypeAdditional information
id

integer

None.
orderDate

date

None.
orderStatus

string

None.
orderType

string

None.
paymentType

string

None.
totalSavings

decimal number

None.
subTotal

decimal number

None.
shipping

decimal number

None.
handling

decimal number

None.
tax

decimal number

None.
grandTotalBeforeDiscount

decimal number

None.
currencyTypeID

integer

None.
currencySymbol

string

None.
trackingNumber

string

None.
shipDate

date

None.
shipmentMethod

string

None.
shipToName

string

None.
shipToAddressID

integer

None.
shipToLine1

string

None.
shipToLine2

string

None.
shipToCity

string

None.
shipToState

string

None.
shipToZipCode

string

None.
shipToCountry

string

None.
billToName

string

None.
billToLine1

string

None.
billToLine2

string

None.
billToCity

string

None.
billToState

string

None.
billToZipCode

string

None.
billToCountry

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "id": 1,
  "orderDate": "2025-10-11T15:02:40.5873167+00:00",
  "orderStatus": "sample string 3",
  "orderType": "sample string 4",
  "paymentType": "sample string 5",
  "totalSavings": 6.0,
  "subTotal": 7.0,
  "shipping": 8.0,
  "handling": 9.0,
  "tax": 10.0,
  "grandTotalBeforeDiscount": 11.0,
  "currencyTypeID": 12,
  "currencySymbol": "sample string 13",
  "trackingNumber": "sample string 14",
  "shipDate": "2025-10-11T15:02:40.5873167+00:00",
  "shipmentMethod": "sample string 16",
  "shipToName": "sample string 17",
  "shipToAddressID": 18,
  "shipToLine1": "sample string 19",
  "shipToLine2": "sample string 20",
  "shipToCity": "sample string 21",
  "shipToState": "sample string 22",
  "shipToZipCode": "sample string 23",
  "shipToCountry": "sample string 24",
  "billToName": "sample string 25",
  "billToLine1": "sample string 26",
  "billToLine2": "sample string 27",
  "billToCity": "sample string 28",
  "billToState": "sample string 29",
  "billToZipCode": "sample string 30",
  "billToCountry": "sample string 31"
}

text/html

Sample: 
{"id":1,"orderDate":"2025-10-11T15:02:40.5873167+00:00","orderStatus":"sample string 3","orderType":"sample string 4","paymentType":"sample string 5","totalSavings":6.0,"subTotal":7.0,"shipping":8.0,"handling":9.0,"tax":10.0,"grandTotalBeforeDiscount":11.0,"currencyTypeID":12,"currencySymbol":"sample string 13","trackingNumber":"sample string 14","shipDate":"2025-10-11T15:02:40.5873167+00:00","shipmentMethod":"sample string 16","shipToName":"sample string 17","shipToAddressID":18,"shipToLine1":"sample string 19","shipToLine2":"sample string 20","shipToCity":"sample string 21","shipToState":"sample string 22","shipToZipCode":"sample string 23","shipToCountry":"sample string 24","billToName":"sample string 25","billToLine1":"sample string 26","billToLine2":"sample string 27","billToCity":"sample string 28","billToState":"sample string 29","billToZipCode":"sample string 30","billToCountry":"sample string 31"}

application/xml, text/xml

Sample: 
<v1_ProfilePersons_ProfilePersonEndpointController.makepaymentCreditCardOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ProfilePersons_ProfilePersonEndpoint">
  <billToCity>sample string 28</billToCity>
  <billToCountry>sample string 31</billToCountry>
  <billToLine1>sample string 26</billToLine1>
  <billToLine2>sample string 27</billToLine2>
  <billToName>sample string 25</billToName>
  <billToState>sample string 29</billToState>
  <billToZipCode>sample string 30</billToZipCode>
  <currencySymbol>sample string 13</currencySymbol>
  <currencyTypeID>12</currencyTypeID>
  <grandTotalBeforeDiscount>11</grandTotalBeforeDiscount>
  <handling>9</handling>
  <id>1</id>
  <orderDate>2025-10-11T15:02:40.5873167+00:00</orderDate>
  <orderStatus>sample string 3</orderStatus>
  <orderType>sample string 4</orderType>
  <paymentType>sample string 5</paymentType>
  <shipDate>2025-10-11T15:02:40.5873167+00:00</shipDate>
  <shipToAddressID>18</shipToAddressID>
  <shipToCity>sample string 21</shipToCity>
  <shipToCountry>sample string 24</shipToCountry>
  <shipToLine1>sample string 19</shipToLine1>
  <shipToLine2>sample string 20</shipToLine2>
  <shipToName>sample string 17</shipToName>
  <shipToState>sample string 22</shipToState>
  <shipToZipCode>sample string 23</shipToZipCode>
  <shipmentMethod>sample string 16</shipmentMethod>
  <shipping>8</shipping>
  <subTotal>7</subTotal>
  <tax>10</tax>
  <totalSavings>6</totalSavings>
  <trackingNumber>sample string 14</trackingNumber>
</v1_ProfilePersons_ProfilePersonEndpointController.makepaymentCreditCardOutput>