> For the complete documentation index, see [llms.txt](https://dev.ropo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.ropo.com/guides/general-add-ons/paylink.md).

# 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/paylink

> Get online payment link for a job

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"paylink","description":"Paylink for online payments"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"PaylinkResponse":{"title":"PaylinkResponse","description":"PaylinkResponse","properties":{"url":{"type":"string"}},"type":"object"},"HttpApiProblem":{"title":"HttpApiProblem","description":"HttpApiProblem","properties":{"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem","type":["integer","null"]},"type":{"description":"A URI reference that identifies the problem type","type":["string","null"]},"title":{"description":"A short, human-readable summary of the problem type","type":["string","null"]},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem","type":["string","null"]}},"type":"object"}}},"paths":{"/online/paylink":{"get":{"tags":["paylink"],"summary":"Get online payment link for a job","operationId":"getOnlinePayLinkAction","parameters":[{"name":"billnum","in":"query","description":"Invoice number","required":true,"schema":{"type":"string"}},{"name":"callback_url","in":"query","description":"Callback URL to receive payment status updates","required":true,"schema":{"type":"string"}},{"name":"service","in":"query","description":"Payment service to use, e.g. 'tink', 'bank', etc.","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language for the payment link, defaults to system language","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaylinkResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://dev.ropo.com/guides/general-add-ons/paylink.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.