How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Payabli

Payabli paymentLink API

The paymentLink API from Payabli — 11 operation(s) for paymentlink.

Documentation Provider Profile APIs.io OpenAPI GitHub

Payabli paymentLink API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Link. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 11 paths, and defines 58 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.

11 operations 11 paths 58 schemas 1 DELETE3 GET2 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.payabli.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Payabli paymentLink API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as requestToken (APIKeyAuth).

  • BearerAuth — OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
  • APIKeyAuth — Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 1 DELETE, 3 GET, 2 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

paymentLink 11
POST
/PaymentLink/{idInvoice}
Generate payment link from Invoice
AddPayLinkFromInvoice 5 params body → 200400401500503
POST
/PaymentLink/bill/{billId}
Generate payment link from Bill
AddPayLinkFromBill 5 params body → 200400401500503
GET
/PaymentLink/load/{paylinkId}
Get payment link from ID
getPayLinkFromId 2 params → 200400401500503
POST
/PaymentLink/push/{payLinkId}
Send payment link
pushPayLinkFromId 2 params body → 200400401500503
PUT
/PaymentLink/update/{payLinkId}
Update payment link
updatePayLinkFromId 2 params body → 200400401500503
GET
/PaymentLink/refresh/{payLinkId}
Refresh payment link content
refreshPayLinkFromId 3 params → 200400401500503
DELETE
/PaymentLink/{payLinkId}
Delete payment link
deletePayLinkFromId 2 params → 200400401500503
GET
/PaymentLink/send/{payLinkId}
Send payment link email
sendPayLinkFromId 4 params → 200400401500503
POST
/PaymentLink/bill/lotNumber/{lotNumber}
Generate payment link from lot number
AddPayLinkFromBillLotNumber 6 params body → 200
PATCH
/PaymentLink/out/{paylinkId}
Update Pay Out payment link
patchOutPaymentLink 2 params body → 200400401500503
PATCH
/PaymentLink/updateOut/{paylinkId}
Update Pay Out payment link content
updatePayLinkOutFromId 2 params body → 200400401500503

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are PageContent (15 properties), PayabliCredentials (13 properties), GetPayLinkFromIdResponseResponseData (11 properties), PaymentPageRequestBody (11 properties). Each schema is shown below with its type and property counts.

PaymentLinkStatus
string
The status of a payment link.
MethodsListOut
object
Payment methods available for Pay Out payment links. Controls which payout options are offered to the vendor.
3 properties
MethodsList
object
10 properties
SettingElement
object
5 properties
MethodElementSettingsApplePayButtonType
string
The text on Apple Pay button. See [Apple Pay Button Type](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-button-type) for more inform…
ContactElement
object
6 properties
ReceiptContent
object
Object containing receipt body configuration
9 properties
AccountId
string
Custom identifier for payment connector.
PushPayLinkRequest
Request body for the push paylink operation.
MethodElementSettingsApplePayButtonStyle
string
The Apple Pay button style. See [Apple Pay Button Style](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-button-style) for more inform…
PageContent
object
15 properties
AdditionalData
object
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](…
PayLinkUpdateData
object
9 properties
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
PageElement
object
4 properties
PayorFields
object
10 properties
PatchOutPaymentLinkRequest
object
Request body for partially updating a Pay Out payment link.
3 properties
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties 2 required
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
GreaterValueAllowed
boolean
When true, the customer can pay an amount greater than the invoice or bill amount.
PayCategory
object
9 properties
Enabled
boolean
Toggles whether the section or element is enabled.
PageSetting
object
7 properties
FrequencyList
object
7 properties
PaymentPageRequestBody
object
11 properties 1 required
NoteElement
object
5 properties
DisplayProperty
object
3 properties
MethodElementSettingsApplePayLanguage
string
The Apple Pay button locale. See [Apple Pay Button Language](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-language) for more inform…
FileContentFtype
string
The MIME type of the file (if content is provided).
GetPayLinkFromIdResponseResponseData
object
11 properties
MethodElementSettings
object
Settings for wallet payment methods.
1 property
PaymentPageRequestBodyOut
object
Configuration for the Pay Out payment link page. Controls branding, messaging, vendor fields, and which payout methods are offered to the vendor.
10 properties
PayorElement
object
4 properties
GetPayLinkFromIdResponse
object
Minimal response wrapper used by approval-style endpoints that don't carry the standard response envelope.
3 properties 1 required
Entry
string
The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overviewentrypoint-vs-entry).
AmountElement
object
3 properties
Element
object
2 properties
ButtonElementSize
string
Specify the size of the custom payment button.
LabelElement
object
3 properties
IdempotencyKey
string
Optional but recommended. A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. Th…
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
ButtonElement
object
2 properties 1 required
AbsorbDifference
boolean
Whether the paypoint absorbs the difference between the configured service fee and the actual fee charged to the customer.
AllowOverride
boolean
Whether the configured service fee can be overridden at the transaction level.
InvoiceElement
object
4 properties
PagelinkSetting
object
6 properties
MethodElementOut
object
Configuration for payment method selection on Pay Out payment links.
8 properties
PayabliApiResponsePaymentLinks
object
3 properties 2 required
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
HeaderElement
object
3 properties
Order
integer
Order of element or section in container.
AutoElement
object
7 properties
PayabliCredentials
object
13 properties
Finishtype
object
2 properties
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
MethodElementSettingsApplePay
object
3 properties
MethodElement
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payabli-paymentlink-api-openapi.yml Raw ↑

Other APIs Payabli publishes across the network.

Payabli Bill API
AE Profile APIs.io
Payabli Boarding API
AE Profile APIs.io
Payabli chargeBacks API
AE Profile APIs.io
Payabli checkCapture API
AE Profile APIs.io
Payabli Cloud API
AE Profile APIs.io
Payabli Customer API
AE Profile APIs.io
Payabli Export API
AE Profile APIs.io
Payabli Funding API
AE Profile APIs.io
Payabli ghostCard API
AE Profile APIs.io
Payabli hostedPaymentPages API
AE Profile APIs.io
Payabli Import API
AE Profile APIs.io
Payabli Invoice API
AE Profile APIs.io
#Payment Link
← Back to P APIs
API Details
ID
payabli:payabli-paymentlink-api
Base URL
https://api.payabli.com/api
Docs
https://docs.payabli.com/developers/api-reference/api-overview
Provider
Payabli
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=payabli-paymentlink-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/payabli-paymentlink-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Payabli paymentLink API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.