Payment URL and URL Expiration

It is possible to set an expiration date and time for the payment link using the pmt_paymenturlexptime parameter, please see details here: Create Payment . This is a useful feature when utilizing the Create Payment request to create a payment link that is then sent to the buyer instead of redirecting the buyer to the link immediately. It is recommended to set an expiration date and time when using the payment link in this way, so that it can not be used after a specific time period.

In addition to the create payment response, the payment-url data can be queried and updated by using HTTP requests with Basic Auth authorization.

Fetch payment-url Data

Request endpoint

HTTP GET https://www.maksuturva.fi/api/public/v1/payments/{pmt_id}/payment-url

pmt_id of the payment to be updated.

Additional headers

none

Request payload

no payload

OK Response ( status code 200 ):

{
  "created" : "2023-01-13T14:19:14.37+02:00",
  "url" : "https:/www.maksuturva.fi/w/Pay.pmt?ST=BS67fae7bedadf1c655dff2da0ab64fcd0e9254d6f00000000000000684863119!",
  "expiration" : "2023-01-30T14:19:11.676+02:00"
}

Update payment-url Expiration

Request endpoint

HTTP PUT https://www.maksuturva.fi/api/public/v1/payments/{pmt_id}/payment-url

pmt_id of the payment to be updated.

Additional headers

Content-Type: application/json

Request payload

{
  "expiration": "2023-02-27T14:43:43.636+02:00"
}

OK Response ( status code 200 ):

{
  "created" : "2023-01-13T14:19:14.37+02:00",
  "url" : "https:/www.maksuturva.fi/w/Pay.pmt?ST=BS67fae7bedadf1c655dff2da0ab64fcd0e9254d6f00000000000000684863119!",
  "expiration" : "2023-02-27T14:43:43.636+02:00"
}

Error Response ( status code 400 ):

Bad Request response can be accompanied with error-payload.