POST api/POLiLinks/PaymentLink

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PaymentRequestType	PaymentRequestType	None.
RecipientName	string	None.
RecipientEmail	string	Data type: EmailAddress
Amount	decimal number	None.
LinkType	LinkType	None.
SendCustomerEmail	boolean	None.
MerchantReference	string	Required
MerchantData	string	None.
SendConfirmationEmail	boolean	None.
CustomerReferenceRequired	boolean	None.
LinkExpiry	date	None.
MerchantReferenceFormat	string	None.
IsMultiplePayment	boolean	None.
DueDate	date	None.
Schedule	string	None.
StatementNarrative	string	None.
UserName	string	None.
SendEmailNow	boolean	None.
PaymentRules	Collection of PaymentRule	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.
MerchantSupportEmail	string	None.
MerchantSupportPhone	string	None.
SupportedMerchantFIListUrl	string	None.
UseMerchantReference	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "PaymentRequestType": 0,
  "RecipientName": "sample string 1",
  "RecipientEmail": "sample string 2",
  "Amount": 3.0,
  "LinkType": 0,
  "SendCustomerEmail": true,
  "MerchantReference": "sample string 5",
  "MerchantData": "sample string 6",
  "SendConfirmationEmail": true,
  "CustomerReferenceRequired": true,
  "LinkExpiry": "2026-04-07T20:10:06.0641401+10:00",
  "MerchantReferenceFormat": "sample string 9",
  "IsMultiplePayment": true,
  "DueDate": "2026-04-07T20:10:06.0641401+10:00",
  "Schedule": "sample string 11",
  "StatementNarrative": "sample string 12",
  "UserName": "sample string 13",
  "SendEmailNow": true,
  "PaymentRules": [
    {
      "Amount": 1.0,
      "Date": "2026-04-07T20:10:06.0641401+10:00"
    },
    {
      "Amount": 1.0,
      "Date": "2026-04-07T20:10:06.0641401+10:00"
    }
  ],
  "AllowDelayedPayment": true,
  "AllowPartialPayment": true,
  "AllowOverPayment": true,
  "MandatoryCustomerReference": true,
  "UsePOLiLinkSuccessfulURL": true,
  "UsePOLiLinkUnsuccessfulURL": true,
  "POLiLinkSuccessfulURL": "sample string 21",
  "POLiLinkUnsuccessfulURL": "sample string 22",
  "CustomerRefMessage": "sample string 23",
  "OperatingCountryID": "ada87c16-1b5e-49c2-9b1e-463cc69906ac",
  "OperatingCountryCode": "sample string 25",
  "ShowReferenceFormat": true,
  "LogoUrl": "sample string 27",
  "MerchantCode": "sample string 28",
  "EntityId": "4106640e-6ece-4c38-b776-cc6e359d56bf",
  "MerchantTransactionLimit": 30.0,
  "MerchantName": "sample string 31",
  "MerchantSupportEmail": "sample string 32",
  "MerchantSupportPhone": "sample string 33",
  "SupportedMerchantFIListUrl": "sample string 34",
  "UseMerchantReference": true
}

application/xml, text/xml

Sample:

<PaymentLinkRequest 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 23</CustomerRefMessage>
  <EntityId>4106640e-6ece-4c38-b776-cc6e359d56bf</EntityId>
  <LogoUrl>sample string 27</LogoUrl>
  <MandatoryCustomerReference>true</MandatoryCustomerReference>
  <MerchantCode>sample string 28</MerchantCode>
  <MerchantName>sample string 31</MerchantName>
  <MerchantReference>sample string 5</MerchantReference>
  <MerchantSupportEmail>sample string 32</MerchantSupportEmail>
  <MerchantSupportPhone>sample string 33</MerchantSupportPhone>
  <MerchantTransactionLimit>30</MerchantTransactionLimit>
  <OperatingCountryCode>sample string 25</OperatingCountryCode>
  <OperatingCountryID>ada87c16-1b5e-49c2-9b1e-463cc69906ac</OperatingCountryID>
  <POLiLinkSuccessfulURL>sample string 21</POLiLinkSuccessfulURL>
  <POLiLinkUnsuccessfulURL>sample string 22</POLiLinkUnsuccessfulURL>
  <ShowReferenceFormat>true</ShowReferenceFormat>
  <SupportedMerchantFIListUrl>sample string 34</SupportedMerchantFIListUrl>
  <UseMerchantReference>true</UseMerchantReference>
  <UsePOLiLinkSuccessfulURL>true</UsePOLiLinkSuccessfulURL>
  <UsePOLiLinkUnsuccessfulURL>true</UsePOLiLinkUnsuccessfulURL>
  <Amount>3</Amount>
  <CustomerReferenceRequired>true</CustomerReferenceRequired>
  <DueDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-07T10:10:06.0641401Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>600</d2p1:OffsetMinutes>
  </DueDate>
  <IsMultiplePayment>true</IsMultiplePayment>
  <LinkExpiry>2026-04-07T20:10:06.0641401+10:00</LinkExpiry>
  <LinkType>Simple</LinkType>
  <MerchantData>sample string 6</MerchantData>
  <MerchantReferenceFormat>sample string 9</MerchantReferenceFormat>
  <PaymentRequestType>Manual</PaymentRequestType>
  <PaymentRules>
    <PaymentRule>
      <Amount>1</Amount>
      <Date>2026-04-07T20:10:06.0641401+10:00</Date>
    </PaymentRule>
    <PaymentRule>
      <Amount>1</Amount>
      <Date>2026-04-07T20:10:06.0641401+10:00</Date>
    </PaymentRule>
  </PaymentRules>
  <RecipientEmail>sample string 2</RecipientEmail>
  <RecipientName>sample string 1</RecipientName>
  <Schedule>sample string 11</Schedule>
  <SendConfirmationEmail>true</SendConfirmationEmail>
  <SendCustomerEmail>true</SendCustomerEmail>
  <SendEmailNow>true</SendEmailNow>
  <StatementNarrative>sample string 12</StatementNarrative>
  <UserName>sample string 13</UserName>
</PaymentLinkRequest>

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

Response Information

Resource Description

PaymentLinkResponse

Name	Type	Additional information
RowId	integer	None.
PaymentURL	string	None.
ResultStatus	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "RowId": 1,
  "PaymentURL": "sample string 2",
  "ResultStatus": 3
}

application/xml, text/xml

Sample:

<PaymentLinkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.POLiLinks">
  <PaymentURL>sample string 2</PaymentURL>
  <ResultStatus>3</ResultStatus>
  <RowId>1</RowId>
</PaymentLinkResponse>