--- created: 2023-09-01T00:00 updated: 2024-04-25T14:23 author: ibelsa API team title: ibelsaPay --- # ibelsaPay ## Paylink for third parties Through the **ibelsaAPI**, it is possible to direct the guest to a payment route to make a payment. This endpoint can only be used in conjunction with a system key assigned to the partner. This key is transmitted in the header as **x-ibelsa-system-key.** ### Endpoint **POST:** /api/pay/link/generate/{payment_provider} **System Key** (to complete the endpoint) is provided to you by **ibelsa**. **payment_provider** depends on the payment provider used and is also provided by **ibelsa**. ### Payload **All fields are mandatory.** - **folio_uuid** The unique UUID of the folio (not invoice). - **amount** The amount of the payment. This must not exceed the outstanding amount of the folio. - **ibelsa_success_url** This URL is called by ibelsa when the payment has been successful. The URL leads to the partner. - **ibelsa_fail_url** (OPTIONAL) This URL is called by ibelsa when the payment has failed. The URL leads to the partner. - **pp_success_url** The full URL that will be called by the payment provider after successful payment. The URL leads to the partner. - **pp_fail_url** The full URL that will be called by the payment provider in case of an error. The URL leads to the partner. - **pp_back_url** The full URLcan be used as a link to your own page after successful payment. ### The call is followed by the following actions. - A payment link from **the payment provider** is requested and registered in ibelsa. - The payment request returns a URL as a response. Calling up this URL leads to a redirect to the payment route of **the payment provider.** - In addition, the response also contains the payment URL as a QR code in the form of a base64-encoded PNG image. This way, the link can also be scanned on a mobile device and the payment path can be gone through there. - On the confirmation page of **the payment provider** there is a link that is linked to your pp_back_url. - At the end of the payment process, **the payment provider** will call up your pp_success_url if the payment was successful. - If the payment fails, the pp_failure_url is retrieved. - In addition, **the payment provider** informs **ibelsa** about the status of the payment. If the payment was successful the *ibelsa_success_url* is called and, the payment is created in the Folio. If the payments failed, the *ibelsa_fail_url* is called. <br/><br/> ## Terminal payment for third parties Through the **ibelsaAPI**, it is possible to initiate a terminal payment. This endpoint can only be used in conjunction with a system key assigned to the partner. This key is transmitted in the header as **x-ibelsa-system-key.** ### Endpoint **POST:** [/api/pay/terminal/payment/{payment_provider}](/api/doc#post--api-pay-terminal-payment-{payment_provider}) **System Key** (to complete the endpoint) is provided to you by **ibelsa**. **payment_provider** depends on the payment provider used and is also provided by **ibelsa**. ### Payload **All fields are mandatory.** - **payment_provider** Is part of the URL of this endpoint. Will be communicated by ibelsa to the partner - **terminal** Data array describing the terminal as it is returned by [/api/doc#get--api-pay-terminal-list-{payment_provider}](/api/doc#get--api-pay-terminal-list-{payment_provider}). Depending on the payment provider - **folio_uuid** The unique UUID of the folio (not invoice). - **amount** The amount of the payment. This must not exceed the outstanding amount of the folio. The decimal separator must be a dot. - **ibelsa_success_url** This URL is called by ibelsa when the payment has been successful. The URL leads to the partner. - **ibelsa_fail_url** This URL is called by ibelsa when the payment has failed. The URL leads to the partner.

Author: Created: Updated:

This page was generated from a Markdown file.

Would you like to view the content in your favourite Markdown reader? Raw Markdown