GET
/
PaymentLink
/
load
/
{paylinkId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/PaymentLink/load/{paylinkId} \
  --header 'requestToken: <api-key>'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseData": {
    "subdomain": "mypage-1",
    "lastAccess": "2022-06-30 15:01:00",
    "totalAmount": 123,
    "pageContent": {
      "name": "<string>",
      "entry": "<string>",
      "subdomain": "mypage-1",
      "logo": {
        "enabled": true,
        "order": 1
      },
      "page": {
        "enabled": true,
        "order": 1,
        "header": "<string>",
        "description": "<string>"
      },
      "invoices": {
        "enabled": true,
        "order": 1,
        "invoiceLink": {
          "enabled": true,
          "order": 1,
          "label": "<string>"
        },
        "viewInvoiceDetails": {
          "enabled": true,
          "order": 1,
          "label": "<string>"
        }
      },
      "payor": {
        "enabled": true,
        "order": 1,
        "header": "<string>",
        "fields": [
          {
            "name": "<string>",
            "label": "<string>",
            "validation": "<string>",
            "value": "<string>",
            "required": true,
            "display": true,
            "fixed": true,
            "identifier": true,
            "order": 1,
            "width": 4
          }
        ]
      },
      "paymentMethods": {
        "enabled": true,
        "order": 1,
        "header": "<string>",
        "allMethodsChecked": true,
        "methods": {
          "visa": true,
          "mastercard": true,
          "discover": false,
          "amex": true,
          "eCheck": false,
          "applePay": true
        },
        "settings": {
          "applePay": {
            "buttonStyle": "black",
            "buttonType": "pay",
            "language": "en-US"
          }
        }
      },
      "notes": {
        "enabled": true,
        "order": 1,
        "header": "<string>",
        "placeholder": "<string>",
        "value": "<string>"
      },
      "messageBeforePaying": {
        "enabled": true,
        "order": 1,
        "label": "<string>"
      },
      "paymentButton": {
        "enabled": true,
        "order": 1,
        "label": "<string>"
      },
      "review": {
        "enabled": true,
        "order": 1,
        "header": "<string>"
      },
      "contactUs": {
        "enabled": true,
        "order": 1,
        "header": "<string>",
        "emailLabel": "<string>",
        "phoneLabel": "<string>",
        "paymentIcons": true
      },
      "autopay": {
        "enabled": true,
        "order": 1,
        "header": "<string>",
        "finish": {
          "untilCancelled": true,
          "calendar": true
        },
        "frequency": {
          "one-time": true,
          "weekly": true,
          "every2Weeks": true,
          "every6Months": true,
          "monthly": true,
          "every3Months": true,
          "annually": true
        },
        "startDate": "1, 5-10",
        "frequencySelected": "<string>"
      },
      "amount": {
        "enabled": true,
        "order": 1,
        "categories": [
          {
            "name": "<string>",
            "type": "<string>",
            "label": "<string>",
            "value": "<string>",
            "description": "<string>",
            "order": 1,
            "quantity": 123,
            "showDescription": true,
            "optionalPay": true
          }
        ]
      }
    },
    "receiptContent": {
      "logo": {
        "enabled": true,
        "order": 1
      },
      "page": {
        "enabled": true,
        "order": 1,
        "header": "<string>",
        "description": "<string>"
      },
      "amount": {
        "enabled": true,
        "order": 1
      },
      "details": {
        "enabled": true,
        "order": 1
      },
      "paymentInformation": {
        "enabled": true,
        "order": 1
      },
      "messageBeforeButton": {
        "enabled": true,
        "order": 1,
        "label": "<string>"
      },
      "paymentButton": {
        "enabled": true,
        "order": 1,
        "label": "<string>"
      },
      "contactUs": {
        "enabled": true,
        "order": 1
      },
      "settings": {
        "enabled": true,
        "order": 1,
        "sendAuto": true,
        "sendManual": false,
        "fields": [
          {
            "name": "<string>",
            "display": true,
            "Fixed": true
          }
        ]
      }
    },
    "pageSettings": {
      "color": "<string>",
      "customCssUrl": "<string>",
      "language": "<string>",
      "redirectAfterApproveUrl": "<string>",
      "redirectAfterApprove": true,
      "pageLogo": {
        "ftype": "pdf",
        "filename": "my-doc.pdf",
        "furl": "https://mysite.com/my-doc.pdf",
        "fContent": "TXkgdGVzdCBmaWxlHJ==..."
      },
      "paymentButton": {
        "label": "<string>",
        "size": "sm"
      }
    },
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "published": 0,
    "credentials": [
      {
        "service": "<string>",
        "mode": 123,
        "minticket": 123,
        "maxticket": 123,
        "cfeeFix": 123,
        "cfeeFloat": 123,
        "cfeeMin": 123,
        "cfeeMax": 123,
        "accountId": "<string>",
        "referenceId": 123
      }
    ],
    "pageIdentifier": "null",
    "validationCode": "<string>"
  }
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

ID for payment link

Response

200
application/json
Success
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseData
object

If isSuccess = true, responseData contains the payment link page content. If isSuccess = false, responseData contains a string with the reason for the error.

Was this page helpful?