POST Api/Vending/PaymentStatus

Request Information

URI Parameters

None.

Body Parameters

PaymentStatusRequest
NameDescriptionTypeAdditional information
CustomerReference

string

None.

PaymentMethod

PaymentMethod

None.

TopUpOnly

boolean

None.

BackgroundApplicationProcessing

boolean

None.

Username

string

None.

Password

string

None.

DeviceManufacturer

string

None.

DeviceModel

string

None.

DeviceSDKInt

string

None.

DeviceSDKVersion

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerReference": "sample string 1",
  "PaymentMethod": 1,
  "TopUpOnly": true,
  "BackgroundApplicationProcessing": true,
  "Username": "sample string 4",
  "Password": "sample string 5",
  "DeviceManufacturer": "sample string 6",
  "DeviceModel": "sample string 7",
  "DeviceSDKInt": "sample string 8",
  "DeviceSDKVersion": "sample string 9"
}

application/xml, text/xml

Sample:
<PaymentStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <DeviceManufacturer>sample string 6</DeviceManufacturer>
  <DeviceModel>sample string 7</DeviceModel>
  <DeviceSDKInt>sample string 8</DeviceSDKInt>
  <DeviceSDKVersion>sample string 9</DeviceSDKVersion>
  <Password>sample string 5</Password>
  <Username>sample string 4</Username>
  <BackgroundApplicationProcessing>true</BackgroundApplicationProcessing>
  <CustomerReference>sample string 1</CustomerReference>
  <PaymentMethod>CreditCard</PaymentMethod>
  <TopUpOnly>true</TopUpOnly>
</PaymentStatusRequest>

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

Response Information

Resource Description

PaymentStatusResponse
NameDescriptionTypeAdditional information
TransactionStatus

string

None.

Success

boolean

None.

ErrorMessage

string

None.

ServerDateTime

string

None.

ErrorType

Errors

None.

Response Formats

application/json, text/json

Sample:
{
  "TransactionStatus": "sample string 1",
  "Success": true,
  "ErrorMessage": "sample string 3",
  "ServerDateTime": "sample string 4",
  "ErrorType": 0
}

application/xml, text/xml

Sample:
<PaymentStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <ErrorMessage>sample string 3</ErrorMessage>
  <ErrorType>SystemError</ErrorType>
  <ServerDateTime>sample string 4</ServerDateTime>
  <Success>true</Success>
  <TransactionStatus>sample string 1</TransactionStatus>
</PaymentStatusResponse>