POST OrbitalGateway/GetUID

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
uID	string	None.
orbitalSecureId	string	None.
orbitalSecureApiToken	string	None.
orbitalURL	string	None.
callbackURL	string	None.
cssURL	string	None.
action	string	None.
sessionId	string	None.
paymentType	string	None.
formType	string	None.
trans_type	string	None.
collectAddress	string	None.
amount	string	None.
orderId	string	None.
allowedTypes	string	None.

Request Formats

application/json, text/json

Sample:

{
  "uID": "sample string 1",
  "orbitalSecureId": "sample string 2",
  "orbitalSecureApiToken": "sample string 3",
  "orbitalURL": "sample string 4",
  "callbackURL": "sample string 5",
  "cssURL": "sample string 6",
  "action": "sample string 7",
  "sessionId": "sample string 8",
  "paymentType": "sample string 9",
  "formType": "sample string 10",
  "trans_type": "sample string 11",
  "collectAddress": "sample string 12",
  "amount": "sample string 13",
  "orderId": "sample string 14",
  "allowedTypes": "sample string 15"
}

application/xml, text/xml

Sample:

<OrbitalGatewayUID xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
  <action>sample string 7</action>
  <allowedTypes>sample string 15</allowedTypes>
  <amount>sample string 13</amount>
  <callbackURL>sample string 5</callbackURL>
  <collectAddress>sample string 12</collectAddress>
  <cssURL>sample string 6</cssURL>
  <formType>sample string 10</formType>
  <orbitalSecureApiToken>sample string 3</orbitalSecureApiToken>
  <orbitalSecureId>sample string 2</orbitalSecureId>
  <orbitalURL>sample string 4</orbitalURL>
  <orderId>sample string 14</orderId>
  <paymentType>sample string 9</paymentType>
  <sessionId>sample string 8</sessionId>
  <trans_type>sample string 11</trans_type>
  <uID>sample string 1</uID>
</OrbitalGatewayUID>

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

Response Information

Resource Description

OrbitalGateway

Name	Type	Additional information
orbitalSecureId	string	None.
orbitalSecureApiToken	string	None.
code	string	None.
orbitalURL	string	None.
uID	string	None.
message	string	None.
AVSMatch	string	None.
CVVMatch	string	None.
amount	string	None.
appCode	string	None.
approvalCode	string	None.
cardBrandSelected	string	None.
ccNumber	string	None.
ccType	string	None.
customer_email	string	None.
customer_id	string	None.
expMonth	string	None.
expYear	string	None.
hostedSecureID	string	None.
name	string	None.
orderId	string	None.
paymentType	string	None.
profileProcStatus	string	None.
rurl	string	None.
sessionId	string	None.
status	string	None.
txnguid	string	None.
transactionEnd	string	None.
transactionStart	string	None.
zip	string	None.
mPAN	string	None.

Response Formats

application/json, text/json

Sample:

{
  "orbitalSecureId": "sample string 1",
  "orbitalSecureApiToken": "sample string 2",
  "code": "sample string 3",
  "orbitalURL": "sample string 4",
  "uID": "sample string 5",
  "message": "sample string 6",
  "AVSMatch": "sample string 7",
  "CVVMatch": "sample string 8",
  "amount": "sample string 9",
  "appCode": "sample string 10",
  "approvalCode": "sample string 11",
  "cardBrandSelected": "sample string 12",
  "ccNumber": "sample string 13",
  "ccType": "sample string 14",
  "customer_email": "sample string 15",
  "customer_id": "sample string 16",
  "expMonth": "sample string 17",
  "expYear": "sample string 18",
  "hostedSecureID": "sample string 19",
  "name": "sample string 20",
  "orderId": "sample string 21",
  "paymentType": "sample string 22",
  "profileProcStatus": "sample string 23",
  "rurl": "sample string 24",
  "sessionId": "sample string 25",
  "status": "sample string 26",
  "txnguid": "sample string 27",
  "transactionEnd": "sample string 28",
  "transactionStart": "sample string 29",
  "zip": "sample string 30",
  "mPAN": "sample string 31"
}

application/xml, text/xml

Sample:

<OrbitalGateway xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
  <AVSMatch>sample string 7</AVSMatch>
  <CVVMatch>sample string 8</CVVMatch>
  <amount>sample string 9</amount>
  <appCode>sample string 10</appCode>
  <approvalCode>sample string 11</approvalCode>
  <cardBrandSelected>sample string 12</cardBrandSelected>
  <ccNumber>sample string 13</ccNumber>
  <ccType>sample string 14</ccType>
  <code>sample string 3</code>
  <customer_email>sample string 15</customer_email>
  <customer_id>sample string 16</customer_id>
  <expMonth>sample string 17</expMonth>
  <expYear>sample string 18</expYear>
  <hostedSecureID>sample string 19</hostedSecureID>
  <mPAN>sample string 31</mPAN>
  <message>sample string 6</message>
  <name>sample string 20</name>
  <orbitalSecureApiToken>sample string 2</orbitalSecureApiToken>
  <orbitalSecureId>sample string 1</orbitalSecureId>
  <orbitalURL>sample string 4</orbitalURL>
  <orderId>sample string 21</orderId>
  <paymentType>sample string 22</paymentType>
  <profileProcStatus>sample string 23</profileProcStatus>
  <rurl>sample string 24</rurl>
  <sessionId>sample string 25</sessionId>
  <status>sample string 26</status>
  <transactionEnd>sample string 28</transactionEnd>
  <transactionStart>sample string 29</transactionStart>
  <txnguid>sample string 27</txnguid>
  <uID>sample string 5</uID>
  <zip>sample string 30</zip>
</OrbitalGateway>