Get payment link

curl https://api-sandbox.payabli.com/api/PaymentLink/load/paylinkId \
     -H "requestToken: <apiKey>"

{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": {
    "AdditionalData": {
      "key1": {
        "key": "value"
      },
      "key2": {
        "key": "value"
      },
      "key3": {
        "key": "value"
      }
    },
    "credentials": [
      {}
    ],
    "lastAccess": "2022-06-30T15:01:00Z",
    "pageContent": {
      "amount": {
        "enabled": true
      },
      "autopay": {
        "enabled": true
      },
      "contactUs": {
        "enabled": true
      },
      "entry": "entry",
      "invoices": {
        "enabled": true
      },
      "logo": {
        "enabled": true
      },
      "messageBeforePaying": {
        "enabled": true
      },
      "name": "name",
      "notes": {
        "enabled": true
      },
      "page": {
        "enabled": true
      },
      "paymentButton": {
        "enabled": true
      },
      "paymentMethods": {
        "enabled": true
      },
      "payor": {
        "enabled": true
      },
      "review": {
        "enabled": true
      },
      "subdomain": "mypage-1"
    },
    "pageIdentifier": "null",
    "pageSettings": {
      "color": "color",
      "customCssUrl": "customCssUrl",
      "language": "language",
      "redirectAfterApprove": true,
      "redirectAfterApproveUrl": "redirectAfterApproveUrl"
    },
    "published": 1,
    "receiptContent": {
      "amount": {
        "enabled": true
      },
      "contactUs": {
        "enabled": true
      },
      "details": {
        "enabled": true
      },
      "logo": {
        "enabled": true
      },
      "messageBeforeButton": {
        "enabled": true
      },
      "page": {
        "enabled": true
      },
      "paymentButton": {
        "enabled": true
      },
      "paymentInformation": {
        "enabled": true
      },
      "settings": {
        "enabled": true
      }
    },
    "subdomain": "mypage-1",
    "totalAmount": 1.1,
    "validationCode": "validationCode"
  }
}

Retrieves a payment link by ID.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

paylinkIdstringRequired

ID for payment link

Response

Success

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean or null

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

responseDataobject or null

Authentication

Path parameters

Response

Errors