POST v1/policyPayment/makePayment

Request Information

URI Parameters

None.

Body Parameters

makePaymentRequest
NameDescriptionTypeAdditional information
policyNo

string

None.

amount

decimal number

None.

user_id

integer

None.

channels

Collection of string

None.

reference

string

None.

Request Formats

application/json, text/json

Sample:
{
  "policyNo": "sample string 1",
  "amount": 2.0,
  "user_id": 3,
  "channels": [
    "sample string 1",
    "sample string 2"
  ],
  "reference": "sample string 4"
}

application/xml, text/xml

Sample:
<makePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.makePayment">
  <amount>2</amount>
  <channels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </channels>
  <policyNo>sample string 1</policyNo>
  <reference>sample string 4</reference>
  <user_id>3</user_id>
</makePaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:
{"policyNo":"sample string 1","amount":2.0,"user_id":3,"channels":["sample string 1","sample string 2"],"reference":"sample string 4"}

Response Information

Resource Description

makePaymentResult
NameDescriptionTypeAdditional information
success

boolean

None.

message

string

None.

errorMsg

string

None.

paymentUrl

string

None.

paymentCode

string

None.

reference

string

None.

emailAddress

string

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3",
  "paymentUrl": "sample string 4",
  "paymentCode": "sample string 5",
  "reference": "sample string 6",
  "emailAddress": "sample string 7"
}

application/xml, text/xml

Sample:
<makePaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.makePayment">
  <emailAddress>sample string 7</emailAddress>
  <errorMsg>sample string 3</errorMsg>
  <message>sample string 2</message>
  <paymentCode>sample string 5</paymentCode>
  <paymentUrl>sample string 4</paymentUrl>
  <reference>sample string 6</reference>
  <success>true</success>
</makePaymentResult>

text/html

Sample:
{"success":true,"message":"sample string 2","errorMsg":"sample string 3","paymentUrl":"sample string 4","paymentCode":"sample string 5","reference":"sample string 6","emailAddress":"sample string 7"}