Skip to main content
A paylink is a shareable payment URL that allows customers to pay without requiring a custom checkout integration. Ideal for invoices, social commerce, and quick payments.
​
id
string
Unique identifier for the paylink.
​
title
string
Short title displayed to customers on the payment page.
​
description
string
Detailed description explaining what the payment is for.
​
mode
string
Environment mode. Either test or live.
​
amount
number
Amount to be paid when the paylink is used.
​
imageBlobIds
string[]
Identifiers for images associated with the paylink, such as product or branding visuals.
​
profileId
string
Business profile that owns this paylink.
{
  "id": "cmjwxuwpl0000v8fwozati4d1",
  "title": "Chidi and Co.",
  "description": "Battery and spare parts",
  "mode": "test",
  "amount": 4000,
  "imageBlobIds": ["AaV6MqcXjdhL64Crb_OqGu9qyHXAaYFxDvKzyvOpgnY"],
  "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
}
POST /paylink/create
Creates a new paylink. Send the request as multipart/form-data to include product images.

​
Request body

​
title
string
required
Short title displayed to customers.
​
description
string
required
Description of the product or service.
​
amount
number
required
Amount to charge.
​
images
file
Optional product image(s) to display on the payment page.
curl -X POST https://api.orafi.app/paylink/create \
  -H "x-api-key: ora_test_your_api_key" \
  -F 'payload={
    "title": "Chidi and Co.",
    "description": "Battery and spare parts",
    "amount": 4000
  }' \
  -F 'images=@product.jpg'
GET /paylink/{id}
Returns the details of an existing paylink.

​
Path parameters

​
id
string
required
The paylink ID to retrieve.
curl -X GET https://api.orafi.app/paylink/cmjwxuwpl0000v8fwozati4d1 \
  -H "x-api-key: ora_test_your_api_key"
GET /paylink
Returns all paylinks belonging to the authenticated business profile. 
curl -X GET https://api.orafi.app/paylink \
  -H "x-api-key: ora_test_your_api_key"
DELETE /paylink/{id}
Permanently deletes a paylink. This action cannot be undone.

​
Path parameters

​
id
string
required
The paylink ID to delete.
curl -X DELETE https://api.orafi.app/paylink/cmjwxuwpl0000v8fwozati4d1 \
  -H "x-api-key: ora_test_your_api_key"