POST api/MakePay

Do Payment

Request Information

URI Parameters

None.

Body Parameters

PaymentRequestViewModel
NameDescriptionTypeAdditional information
CardConnectToken

string

None.

NameOnCard

string

None.

Email

string

None.

CardNo

string

None.

ExpireYear

integer

None.

ExpireMonth

integer

None.

CVV

string

None.

PaymentAmount

decimal number

None.

WorkOrderNo

string

None.

WorkInvoiceNo

string

None.

Address1

string

None.

Address2

string

None.

ZipCode

string

None.

CountryID

integer

None.

StateID

integer

None.

CityID

integer

None.

CustomerID

integer

None.

APIKey

string

None.

Currency

string

None.

UserID

integer

None.

InvoiceID

integer

None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "cardConnectToken": "sample string 1",
  "nameOnCard": "sample string 2",
  "email": "sample string 3",
  "cardNo": "sample string 4",
  "expireYear": 5,
  "expireMonth": 6,
  "cvv": "sample string 7",
  "paymentAmount": 8.0,
  "workOrderNo": "sample string 9",
  "workInvoiceNo": "sample string 10",
  "address1": "sample string 11",
  "address2": "sample string 12",
  "zipCode": "sample string 13",
  "countryID": 14,
  "stateID": 15,
  "cityID": 16,
  "customerID": 17,
  "apiKey": "sample string 18",
  "currency": "sample string 19",
  "userID": 1,
  "invoiceID": 1
}

application/xml, text/xml

Sample:
<PaymentRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <APIKey>sample string 18</APIKey>
  <Address1>sample string 11</Address1>
  <Address2>sample string 12</Address2>
  <CVV>sample string 7</CVV>
  <CardConnectToken>sample string 1</CardConnectToken>
  <CardNo>sample string 4</CardNo>
  <CityID>16</CityID>
  <CountryID>14</CountryID>
  <Currency>sample string 19</Currency>
  <CustomerID>17</CustomerID>
  <Email>sample string 3</Email>
  <ExpireMonth>6</ExpireMonth>
  <ExpireYear>5</ExpireYear>
  <InvoiceID>1</InvoiceID>
  <NameOnCard>sample string 2</NameOnCard>
  <PaymentAmount>8</PaymentAmount>
  <StateID>15</StateID>
  <UserID>1</UserID>
  <WorkInvoiceNo>sample string 10</WorkInvoiceNo>
  <WorkOrderNo>sample string 9</WorkOrderNo>
  <ZipCode>sample string 13</ZipCode>
</PaymentRequestViewModel>

multipart/form-data

Sample:
<PaymentRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><APIKey>sample string 18</APIKey><Address1>sample string 11</Address1><Address2>sample string 12</Address2><CVV>sample string 7</CVV><CardConnectToken>sample string 1</CardConnectToken><CardNo>sample string 4</CardNo><CityID>16</CityID><CountryID>14</CountryID><Currency>sample string 19</Currency><CustomerID>17</CustomerID><Email>sample string 3</Email><ExpireMonth>6</ExpireMonth><ExpireYear>5</ExpireYear><InvoiceID>1</InvoiceID><NameOnCard>sample string 2</NameOnCard><PaymentAmount>8</PaymentAmount><StateID>15</StateID><UserID>1</UserID><WorkInvoiceNo>sample string 10</WorkInvoiceNo><WorkOrderNo>sample string 9</WorkOrderNo><ZipCode>sample string 13</ZipCode></PaymentRequestViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentResponseModel
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Message

string

None.

PaymentRefNumber

string

None.

cardconnectProfileId

string

None.

acctid

string

None.

token

string

None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "isSuccess": true,
  "message": "sample string 2",
  "paymentRefNumber": "sample string 3",
  "cardconnectProfileId": "sample string 4",
  "acctid": "sample string 5",
  "token": "sample string 6"
}

application/xml, text/xml

Sample:
<PaymentResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <PaymentRefNumber>sample string 3</PaymentRefNumber>
  <acctid>sample string 5</acctid>
  <cardconnectProfileId>sample string 4</cardconnectProfileId>
  <token>sample string 6</token>
</PaymentResponseModel>

multipart/form-data

Sample:
<PaymentResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><IsSuccess>true</IsSuccess><Message>sample string 2</Message><PaymentRefNumber>sample string 3</PaymentRefNumber><acctid>sample string 5</acctid><cardconnectProfileId>sample string 4</cardconnectProfileId><token>sample string 6</token></PaymentResponseModel>