POST api/POLiLinks/SendEmail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RecipientName	string	None.
RecipientEmail	string	None.
PaymentURL	string	None.
Amount	string	None.
DiscountMessages	Collection of string	None.
LinkType	LinkType	None.
Body	StringBuilder	None.
AllowDelayedPayment	boolean	None.
AllowPartialPayment	boolean	None.
AllowOverPayment	boolean	None.
MandatoryCustomerReference	boolean	None.
UsePOLiLinkSuccessfulURL	boolean	None.
UsePOLiLinkUnsuccessfulURL	boolean	None.
POLiLinkSuccessfulURL	string	None.
POLiLinkUnsuccessfulURL	string	None.
CustomerRefMessage	string	None.
OperatingCountryID	globally unique identifier	None.
OperatingCountryCode	string	None.
ShowReferenceFormat	boolean	None.
LogoUrl	string	None.
MerchantCode	string	None.
EntityId	globally unique identifier	None.
MerchantTransactionLimit	decimal number	None.
MerchantName	string	None.
MerchantReference	string	None.
MerchantSupportEmail	string	None.
MerchantSupportPhone	string	None.
SupportedMerchantFIListUrl	string	None.
UseMerchantReference	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "RecipientName": "sample string 1",
  "RecipientEmail": "sample string 2",
  "PaymentURL": "sample string 3",
  "Amount": "sample string 4",
  "DiscountMessages": [
    "sample string 1",
    "sample string 2"
  ],
  "LinkType": 0,
  "Body": null,
  "AllowDelayedPayment": true,
  "AllowPartialPayment": true,
  "AllowOverPayment": true,
  "MandatoryCustomerReference": true,
  "UsePOLiLinkSuccessfulURL": true,
  "UsePOLiLinkUnsuccessfulURL": true,
  "POLiLinkSuccessfulURL": "sample string 11",
  "POLiLinkUnsuccessfulURL": "sample string 12",
  "CustomerRefMessage": "sample string 13",
  "OperatingCountryID": "ad17078a-d9f1-4d40-a0d4-b796e605223c",
  "OperatingCountryCode": "sample string 15",
  "ShowReferenceFormat": true,
  "LogoUrl": "sample string 17",
  "MerchantCode": "sample string 18",
  "EntityId": "339adc46-d1b5-4d82-aa73-d5362a6a3dda",
  "MerchantTransactionLimit": 20.0,
  "MerchantName": "sample string 21",
  "MerchantReference": "sample string 22",
  "MerchantSupportEmail": "sample string 23",
  "MerchantSupportPhone": "sample string 24",
  "SupportedMerchantFIListUrl": "sample string 25",
  "UseMerchantReference": true
}

application/xml, text/xml

Sample:

<EmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.POLiLinks">
  <AllowDelayedPayment>true</AllowDelayedPayment>
  <AllowOverPayment>true</AllowOverPayment>
  <AllowPartialPayment>true</AllowPartialPayment>
  <CustomerRefMessage>sample string 13</CustomerRefMessage>
  <EntityId>339adc46-d1b5-4d82-aa73-d5362a6a3dda</EntityId>
  <LogoUrl>sample string 17</LogoUrl>
  <MandatoryCustomerReference>true</MandatoryCustomerReference>
  <MerchantCode>sample string 18</MerchantCode>
  <MerchantName>sample string 21</MerchantName>
  <MerchantReference>sample string 22</MerchantReference>
  <MerchantSupportEmail>sample string 23</MerchantSupportEmail>
  <MerchantSupportPhone>sample string 24</MerchantSupportPhone>
  <MerchantTransactionLimit>20</MerchantTransactionLimit>
  <OperatingCountryCode>sample string 15</OperatingCountryCode>
  <OperatingCountryID>ad17078a-d9f1-4d40-a0d4-b796e605223c</OperatingCountryID>
  <POLiLinkSuccessfulURL>sample string 11</POLiLinkSuccessfulURL>
  <POLiLinkUnsuccessfulURL>sample string 12</POLiLinkUnsuccessfulURL>
  <ShowReferenceFormat>true</ShowReferenceFormat>
  <SupportedMerchantFIListUrl>sample string 25</SupportedMerchantFIListUrl>
  <UseMerchantReference>true</UseMerchantReference>
  <UsePOLiLinkSuccessfulURL>true</UsePOLiLinkSuccessfulURL>
  <UsePOLiLinkUnsuccessfulURL>true</UsePOLiLinkUnsuccessfulURL>
  <Amount>sample string 4</Amount>
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Text" i:nil="true" />
  <DiscountMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DiscountMessages>
  <LinkType>Simple</LinkType>
  <PaymentURL>sample string 3</PaymentURL>
  <RecipientEmail>sample string 2</RecipientEmail>
  <RecipientName>sample string 1</RecipientName>
</EmailRequest>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.