POST api/VPOS/GetPaymentId

Get Payment Id

Request Information

URI Parameters

None.

Body Parameters

GetPaymentIdRequest
NameDescriptionTypeAdditional information
ClientID

string

None.

Username

string

None.

Password

string

None.

OrderID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientID": "sample string 1",
  "Username": "sample string 2",
  "Password": "sample string 3",
  "OrderID": 4
}

application/xml, text/xml

Sample:
<GetPaymentIdRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ClientID>sample string 1</ClientID>
  <Username>sample string 2</Username>
  <Password>sample string 3</Password>
  <OrderID>4</OrderID>
</GetPaymentIdRequest>

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

Response Information

Resource Description

Payment Id

GetPaymentIdResponse
NameDescriptionTypeAdditional information
PaymentId

string

None.

ResponseMessage

string

None.

ResponseCode

string

None.

Response Formats

application/json, text/json

Sample:
{
  "PaymentId": "sample string 1",
  "ResponseMessage": "sample string 2",
  "ResponseCode": "sample string 3"
}

application/xml, text/xml

Sample:
<GetPaymentIdResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentId>sample string 1</PaymentId>
  <ResponseMessage>sample string 2</ResponseMessage>
  <ResponseCode>sample string 3</ResponseCode>
</GetPaymentIdResponse>