Skip to main content
POST
/
paylinks
Create a paylink
curl --request POST \
  --url https://api.orafi.app/v1/paylinks \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'payload={"title":"Product","description":"Product description","amount":100,"currency":"USDC"}' \
  --form 'images=<string>' \
  --form images.items='@example-file'
{
  "success": true,
  "message": "Paylink created successfully",
  "data": {
    "id": "paylink_abc123",
    "title": "Product Payment",
    "description": "Payment for awesome product",
    "amount": 100,
    "currency": "USDC",
    "imageBlobIds": [
      "<string>"
    ],
    "mode": "live",
    "profileId": "profile_123",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "images": [
      {}
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication required for most endpoints

Body

multipart/form-data
​
payload
string
required

JSON string containing paylink data (title, description, amount, currency)

Example:

"{\"title\":\"Product\",\"description\":\"Product description\",\"amount\":100,\"currency\":\"USDC\"}"

​
images
file[]
required

Image files (1-4 images required)

Required array length: 1 - 4 elements

Response

Paylink created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Paylink created successfully"

​
data
object