Paylinks

{
  "id": "cmjwxuwpl0000v8fwozati4d1",
  "title": "Chidi and Co.",
  "description": "Battery and spare parts",
  "mode": "test",
  "amount": 4000,
  "imageBlobIds": ["AaV6MqcXjdhL64Crb_OqGu9qyHXAaYFxDvKzyvOpgnY"],
  "images": [],
  "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
}

The paylink object

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.

string

Unique identifier for the paylink.

string

Short title displayed to customers on the payment page.

string

Detailed description explaining what the payment is for.

string

Environment mode. Either test or live.

number

Amount to be paid when the paylink is used.

string[]

Identifiers for images associated with the paylink, such as product or branding visuals.

PaylinkImage[]

Image metadata returned alongside the paylink in API responses.

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"],
  "images": [],
  "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
}

Create a paylink

POST /paylink/create

Creates a new paylink. Send the request as multipart/form-data to include product images.

Request body

string

required

Short title displayed to customers.

string

required

Description of the product or service.

number

required

Amount to charge.

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'

const formData = new FormData();
formData.append("payload", JSON.stringify({
  title: "Chidi and Co.",
  description: "Battery and spare parts",
  amount: 4000
}));
formData.append("images", fileBlob, "product.jpg");

const response = await fetch("https://api.orafi.app/paylink/create", {
method: "POST",
headers: { "x-api-key": "ora_test_your_api_key" },
body: formData
});

import requests

response = requests.post(
    "https://api.orafi.app/paylink/create",
    headers={"x-api-key": "ora_test_your_api_key"},
    files={"images": open("product.jpg", "rb")},
    data={
        "payload": '{"title":"Chidi and Co.","description":"Battery and spare parts","amount":4000}'
    }
)

{
  "success": true,
  "message": "Paylink successfully created",
  "data": {
    "id": "cmjwxuwpl0000v8fwozati4d1",
    "title": "Chidi and Co.",
    "description": "Battery and spare parts",
    "mode": "test",
    "amount": 4000,
    "imageBlobIds": ["AaV6MqcXjdhL64Crb_OqGu9qyHXAaYFxDvKzyvOpgnY"],
    "images": [],
    "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
  }
}

Retrieve a paylink

GET /paylink/{id}

Returns the details of an existing paylink.

Path parameters

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"

const response = await fetch(
  "https://api.orafi.app/paylink/cmjwxuwpl0000v8fwozati4d1",
  { headers: { "x-api-key": "ora_test_your_api_key" } }
);

import requests

response = requests.get(
"https://api.orafi.app/paylink/cmjwxuwpl0000v8fwozati4d1",
headers={"x-api-key": "ora_test_your_api_key"}
)

{
  "success": true,
  "message": "Paylink retrieved successfully",
  "data": {
    "id": "cmjwxuwpl0000v8fwozati4d1",
    "title": "Chidi and Co.",
    "description": "Battery and spare parts",
    "mode": "test",
    "amount": 4000,
    "imageBlobIds": [
      "AaV6MqcXjdhL64Crb_OqGu9qyHXAaYFxDvKzyvOpgnY"
    ]
  }
}

List paylinks

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"

const response = await fetch("https://api.orafi.app/paylink", {
  headers: { "x-api-key": "ora_test_your_api_key" }
});

import requests

response = requests.get(
"https://api.orafi.app/paylink",
headers={"x-api-key": "ora_test_your_api_key"}
)

{
  "success": true,
  "message": "Paylinks retrieved successfully",
  "data": [
    {
      "id": "cmjftyjne0002v8vsgi1j8k8f",
      "title": "Chidi and Co.",
      "description": "Battery and spare parts",
      "mode": "test",
      "amount": 4000,
      "imageBlobIds": ["AaV6MqcXjdhL64Crb_OqGu9qyHXAaYFxDvKzyvOpgnY"],
      "images": [],
      "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
    },
    {
      "id": "cmjwxuwpl0000v8fwozati4d1",
      "title": "Chidi and Co.",
      "description": "Battery and spare parts",
      "mode": "test",
      "amount": 4000,
      "imageBlobIds": ["AaV6MqcXjdhL64Crb_OqGu9qyHXAaYFxDvKzyvOpgnY"],
      "images": [],
      "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
    }
  ]
}

Delete a paylink

DELETE /paylink/{id}

Permanently deletes a paylink. This action cannot be undone.

Path parameters

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"

const response = await fetch(
  "https://api.orafi.app/paylink/cmjwxuwpl0000v8fwozati4d1",
  {
    method: "DELETE",
    headers: { "x-api-key": "ora_test_your_api_key" }
  }
);

import requests

response = requests.delete(
"https://api.orafi.app/paylink/cmjwxuwpl0000v8fwozati4d1",
headers={"x-api-key": "ora_test_your_api_key"}
)

{
  "success": true,
  "message": "Paylink deleted successfully",
  "data": null
}

Overview

Transactions

Payments

Refunds

Payouts

Customers

Subscriptions

Webhooks

Webhook Deliveries

Crypto Settlements

Fiat Settlements

Profile

Mode

Notifications

Extras

Paylinks

The paylink object

Create a paylink

Request body

Retrieve a paylink

Path parameters

List paylinks

Delete a paylink

Path parameters

​The paylink object

​Create a paylink

​Request body

​Retrieve a paylink

​Path parameters

​List paylinks

​Delete a paylink

​Path parameters

The paylink object

Create a paylink

Request body

Retrieve a paylink

Path parameters

List paylinks

Delete a paylink

Path parameters