PayLink

This guide explains how to fetch a url-link that can be embedded for example in your online portal or mobile application to give user a possibility to pay the invoice directly from your application.

Paylink is fetched with invoice number parameter and the link gives direct access to payment process without MyRopo service in between.

Steps:

1. Get a Paylink URL for a single invoice.

2. Embed the URL in your portal or mobile app.

3. The debtor can start the payment process by clicking the link.

Parameters

• billnum (required): invoice number.

• callback_url (required): After the payment, user is redirected to this URL in your application

Get online payment link for a job

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

billnumstringRequired

Invoice number

callback_urlstringRequired

Callback URL to receive payment status updates

servicestringOptional

Payment service to use, e.g. 'tink', 'bank', etc.

languagestringOptional

Language for the payment link, defaults to system language

Responses

200

successful operation

application/json

PaylinkResponse

urlstringOptionalExample: paylink/pay.php?uuid=5f5b4b4b-7b7b-4b4b-7b7b-5f5b4b4b7b7b

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/online/paylink

HTTPcURLJavaScriptPython

GET /rest/online/paylink?billnum=text&callback_url=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "paylink/pay.php?uuid=5f5b4b4b-7b7b-4b4b-7b7b-5f5b4b4b7b7b"
}