Biller Service
Biller Service
Request Biller URL
Request a payment link to be created and returned back in the API response.Request Biller URL
Embedded Files
POST /v1/request-biller-url
Request
Request
You must include the API key provided by PSI in the x-api-key request header.
Biller_Seq
NumberMax Size: 11 Biller_Seq
Identifier of the biller the customer selected.
Language
StringMax Size: 2 Language
en or fr
Returns the Biller Service URL to the English or French website
CustomerEmail (optional)
StringMax Size: 50 CustomerEmail (optional)
Email address to populate when the customer arrives on the Biller Service Hosted Page. Users can edit the value when they arrive.
CustomerName (optional)
StringMax Size: 50 CustomerName (optional)
Account holder name to populate when the customer arrives on the Biller Service Hosted Page. Users can edit the value when they arrive.
CustomerClientRef (optional)
StringMax Size: 30 CustomerClientRef (optional)
Client Reference (commonly account number or business number) to populate when the customer arrives on the Biller Service Hosted Page. Users can edit the value when they arrive.
Note: Sensitive Client References like Social Insurance Numbers (SINs) will not be populated.
PaymentAmount (optional)
NumberMax Size: (8,2) PaymentAmount (optional)
Payment Amount in CAD to populate when the customer arrives on the Biller Service Hosted Page. Users can edit the value when they arrive.
Example
Example
{
"Biller_Seq": 99999,
"Language": "en",
"CustomerEmail": "luke@skywalker.com",
"CustomerName": "Luke Skywalker",
"CustomerClientRef": "832729171"
"PaymentAmount": 150.75
}
Response
Response
HostedPageURL
URLHostedPageURL
Biller Service Hosted Page URL for the selected biller.
Page updated
Report abuse