POST Api/Payment/PaymentStatusBillPayment

Request Information

URI Parameters

None.

Body Parameters

PaymentStatusBillPaymentRequest
NameDescriptionTypeAdditional information
BillPaymentID

globally unique identifier

None.

CustomerReference

string

None.

PaymentType

PaymentTypes

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:
{
  "BillPaymentID": "a284fe29-ffa7-43c7-b0c9-349467b00e5e",
  "CustomerReference": "sample string 2",
  "PaymentType": 1,
  "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:
<PaymentStatusBillPaymentRequest 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>
  <BillPaymentID>a284fe29-ffa7-43c7-b0c9-349467b00e5e</BillPaymentID>
  <CustomerReference>sample string 2</CustomerReference>
  <PaymentType>CreditCard</PaymentType>
</PaymentStatusBillPaymentRequest>

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

Response Information

Resource Description

PaymentStatusBillPaymentResponse
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:
<PaymentStatusBillPaymentResponse 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>
</PaymentStatusBillPaymentResponse>