POST api/DueToPayPayment/PaymentRequestViaPhoneBill

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OperatorID	integer	Required
GroupDetails	Collection of GroupDetails	Required
IsFullAmount	boolean	Required
IsRecurringPayment	boolean	Required
IsPartialAmount	boolean	Required
Amount	decimal number	None.
PlatForm	string	Required
ScheduledDate	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OperatorID": 1,
  "GroupDetails": [
    {
      "GroupID": 1,
      "Number": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "GroupID": 1,
      "Number": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "IsFullAmount": true,
  "IsRecurringPayment": true,
  "IsPartialAmount": true,
  "Amount": 5.0,
  "PlatForm": "sample string 6",
  "ScheduledDate": "sample string 7"
}

application/xml, text/xml

Sample:

<DueToPayModel.PaymentRequestViaPhoneBill xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <Amount>5</Amount>
  <GroupDetails>
    <DueToPayModel.GroupDetails>
      <GroupID>1</GroupID>
      <Number xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Number>
    </DueToPayModel.GroupDetails>
    <DueToPayModel.GroupDetails>
      <GroupID>1</GroupID>
      <Number xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Number>
    </DueToPayModel.GroupDetails>
  </GroupDetails>
  <IsFullAmount>true</IsFullAmount>
  <IsPartialAmount>true</IsPartialAmount>
  <IsRecurringPayment>true</IsRecurringPayment>
  <OperatorID>1</OperatorID>
  <PlatForm>sample string 6</PlatForm>
  <ScheduledDate>sample string 7</ScheduledDate>
</DueToPayModel.PaymentRequestViaPhoneBill>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentRequestViaPhoneBillResponse

Name	Type	Additional information
AccessToken	string	None.
Details	Collection of string	None.
VerificationID	string	None.
RequestID	Collection of string	None.
RemainingAmount	decimal number	None.
BankingCharge	decimal number	None.
ServiceCharge	decimal number	None.
IsShared	boolean	None.
success	boolean	None.
code	string	None.
message	string	None.
errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "AccessToken": "sample string 1",
  "Details": [
    "sample string 1",
    "sample string 2"
  ],
  "VerificationID": "sample string 2",
  "RequestID": [
    "sample string 1",
    "sample string 2"
  ],
  "RemainingAmount": 3.0,
  "BankingCharge": 4.0,
  "ServiceCharge": 5.0,
  "IsShared": true,
  "success": true,
  "code": "sample string 8",
  "message": "sample string 9",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<DueToPayModel.PaymentRequestViaPhoneBillResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <code>sample string 8</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message>sample string 9</message>
  <success>true</success>
  <AccessToken>sample string 1</AccessToken>
  <BankingCharge>4</BankingCharge>
  <Details xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Details>
  <IsShared>true</IsShared>
  <RemainingAmount>3</RemainingAmount>
  <RequestID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RequestID>
  <ServiceCharge>5</ServiceCharge>
  <VerificationID>sample string 2</VerificationID>
</DueToPayModel.PaymentRequestViaPhoneBillResponse>