POST api/VPOS/GetPaymentDetails

Get Order Status

Request Information

URI Parameters

None.

Body Parameters

OrderStatusRequest model

PaymentDetailsRequest
NameDescriptionTypeAdditional information
PaymentID

string

None.

Username

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PaymentID": "sample string 1",
  "Username": "sample string 2",
  "Password": "sample string 3"
}

application/xml, text/xml

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

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

Response Information

Resource Description

OrderStatusResponse model

PaymentDetailsResponse
NameDescriptionTypeAdditional information
Amount

decimal number

None.

ApprovedAmount

decimal number

None.

ApprovalCode

string

None.

CardNumber

string

None.

ClientName

string

None.

ClientEmail

string

None.

Currency

string

None.

DateTime

string

None.

DepositedAmount

decimal number

None.

Description

string

None.

MDOrderID

string

None.

MerchantId

string

None.

TerminalId

string

None.

OrderID

string

None.

PaymentState

string

None.

PaymentType

PaymentsEnum

None.

PrimaryRC

string

None.

ResponseCode

string

None.

ExpDate

string

None.

ProcessingIP

string

None.

OrderStatus

string

None.

CardHolderID

string

None.

BindingID

string

None.

RefundedAmount

decimal number

None.

Opaque

string

None.

TrxnDescription

string

None.

rrn

string

None.

ActionCode

string

None.

ExchangeRate

decimal number

None.

BankInfo

BankInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "Amount": 1.0,
  "ApprovedAmount": 2.0,
  "ApprovalCode": "sample string 3",
  "CardNumber": "sample string 4",
  "ClientName": "sample string 5",
  "ClientEmail": "sample string 6",
  "Currency": "sample string 7",
  "DateTime": "sample string 8",
  "DepositedAmount": 9.0,
  "Description": "sample string 10",
  "MDOrderID": "sample string 11",
  "MerchantId": "sample string 12",
  "TerminalId": "sample string 13",
  "OrderID": "sample string 14",
  "PaymentState": "sample string 15",
  "PaymentType": 0,
  "PrimaryRC": "sample string 16",
  "ResponseCode": "sample string 17",
  "ExpDate": "sample string 18",
  "ProcessingIP": "sample string 19",
  "OrderStatus": "sample string 20",
  "CardHolderID": "sample string 21",
  "BindingID": "sample string 22",
  "RefundedAmount": 23.0,
  "Opaque": "sample string 24",
  "TrxnDescription": "sample string 25",
  "rrn": "sample string 26",
  "ActionCode": "sample string 27",
  "ExchangeRate": 28.0,
  "BankInfo": {
    "BankName": "sample string 1",
    "BankCountryCode": "sample string 2",
    "BankCountryName": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<PaymentDetailsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <ApprovedAmount>2</ApprovedAmount>
  <ApprovalCode>sample string 3</ApprovalCode>
  <CardNumber>sample string 4</CardNumber>
  <ClientName>sample string 5</ClientName>
  <ClientEmail>sample string 6</ClientEmail>
  <Currency>sample string 7</Currency>
  <DateTime>sample string 8</DateTime>
  <DepositedAmount>9</DepositedAmount>
  <Description>sample string 10</Description>
  <MDOrderID>sample string 11</MDOrderID>
  <MerchantId>sample string 12</MerchantId>
  <TerminalId>sample string 13</TerminalId>
  <OrderID>sample string 14</OrderID>
  <PaymentState>sample string 15</PaymentState>
  <PaymentType>None</PaymentType>
  <PrimaryRC>sample string 16</PrimaryRC>
  <ResponseCode>sample string 17</ResponseCode>
  <ExpDate>sample string 18</ExpDate>
  <ProcessingIP>sample string 19</ProcessingIP>
  <OrderStatus>sample string 20</OrderStatus>
  <CardHolderID>sample string 21</CardHolderID>
  <BindingID>sample string 22</BindingID>
  <RefundedAmount>23</RefundedAmount>
  <Opaque>sample string 24</Opaque>
  <TrxnDescription>sample string 25</TrxnDescription>
  <rrn>sample string 26</rrn>
  <ActionCode>sample string 27</ActionCode>
  <ExchangeRate>28</ExchangeRate>
  <BankInfo>
    <BankName>sample string 1</BankName>
    <BankCountryCode>sample string 2</BankCountryCode>
    <BankCountryName>sample string 3</BankCountryName>
  </BankInfo>
</PaymentDetailsResponse>