Skip to content

API Endpoints

The BeInfi API is organized around REST principles. All endpoints accept and return JSON, use standard HTTP methods, and require Bearer token authentication.

Base URL: https://api.beinfi.com/v1

MethodEndpointDescription
POST/payment-linksCreate a new payment link
GET/payment-linksList all payment links
GET/payment-links/:idGet a specific payment link
DELETE/payment-links/:idDeactivate a payment link
GET/paymentsList all payments
GET/payments/:idGet payment details
POST/payments/:id/refundRefund a payment
MethodEndpointDescription
POST/listingsCreate a new listing
GET/listingsList your listings
GET/listings/:idGet listing details
PUT/listings/:idUpdate a listing
DELETE/listings/:idRemove a listing
POST/listings/:id/publishPublish a draft listing
MethodEndpointDescription
GET/bioGet your link-in-bio page
PUT/bioUpdate your link-in-bio page
POST/bio/linksAdd a link to your bio page
PUT/bio/links/:idUpdate a bio link
DELETE/bio/links/:idRemove a bio link
MethodEndpointDescription
POST/ai/generate-descriptionGenerate a product description
POST/ai/generate-captionGenerate a social media caption
POST/ai/build-pageGenerate a page layout
MethodEndpointDescription
GET/meGet current account info
PUT/meUpdate account details
GET/me/api-keysList your API keys
POST/me/api-keysCreate a new API key
DELETE/me/api-keys/:idRevoke an API key
MethodEndpointDescription
GET/webhooksList webhook endpoints
POST/webhooksRegister a new webhook endpoint
PUT/webhooks/:idUpdate a webhook endpoint
DELETE/webhooks/:idRemove a webhook endpoint
GET/webhooks/:id/deliveriesList delivery attempts

List endpoints support cursor-based pagination:

Terminal window
curl "https://api.beinfi.com/v1/payments?limit=20&cursor=pay_abc123" \
-H "Authorization: Bearer YOUR_API_KEY"
ParameterDescription
limitNumber of items per page (default 20, max 100)
cursorID of the last item from the previous page

The response includes a has_more boolean and a next_cursor field when additional pages are available.

All errors follow a consistent format:

{
"error": "not_found",
"message": "The requested resource does not exist.",
"status": 404
}