Generate Payment Links

Generate customized payment links from invoices and send them directly to customers for payment. With payment links, you can instantly create mobile- and email-friendly payment requests with your accepted payment methods, branding, and invoice details. You can do this without having to build or host your own payment pages!

This guide covers how to create payment links via the API.

​

Payment link workflow

When you create an invoice, you can send it to a customer for payment using a payment link.

The general workflow for creating payment links via the API starts with an invoice.

1. After you create an invoice, use the generate a payment link from an invoice endpoint to create a tailored payment link.
2. Send the link to the customer with a call to the send payment link endpoint.
3. If you need to edit the payment link, use the update payment link endpoint. After you update the payment link, send a request to refresh payment link to update the payment link for the customer.
4. The customer pays the invoice.

​

Build the request

First, choose an endpoint. If you’re testing, use the Sandbox endpoint. for your target environment.

​

Authenticate

Authenticate by sending your API token in the request header with the key requestToken:
--header 'requestToken: API TOKEN'

​

Path parameter

This request has a required path parameter, idInvoice.

​

Query parameter

This request has query parameters.

​

Body parameter

This request requires a body. The body has several required parameters, so refer to the API reference for this endpoint.

​

Example Request

The example creates a payment link for the invoice with the id 329 and emails it to admin@example.com.

curl --request POST \
     --url 'https://api-sandbox.payabli.com/api/PaymentLink/329?mail2=admin%2540example.com&amountFixed=true' \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --header 'requestToken: <API TOKEN>' \
     --data '
{
  "logo": {
    "enabled": false
  },
  "page": {
    "enabled": true,
    "header": "My header",
    "description": "this is a header"
  },
  "paymentMethods": {
    "methods": {
      "visa": true,
      "mastercard": true,
      "applePay": true
      "eCheck": true
    },
    "enabled": true
  },
  "notes": {
    "enabled": true,
    "header": "Notes",
    "placeholder": "Placeholder",
    "value": "This is a pre-populated note"
  },
  "messageBeforePaying": {
    "enabled": true,
    "label": "Message before paying"
  },
  "paymentButton": {
    "enabled": true,
    "label": "MY PAYMENT BUTTON LABEL"
  },
  "review": {
    "enabled": true,
    "header": "Review header"
  },
  "contactUs": {
    "enabled": true,
    "header": "Contact us Header",
    "emailLabel": "Custom Email Content",
    "phoneLabel": "Custom Phone label",
    "paymentIcons": false
  },
  "settings": {
    "redirectAfterApprove": false
  }
}
'

​

Example response

A successful request returns a 200 response with a JSON body. The payLinkId that you need to manage this payment link via the API is returned as “responseData”.

{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": "332-1e1e57af-7fd3-4264-803f-df40c277b704-1301"
}