Skip to main content
PATCH
/
paylinks
/
{paylinkId}
Edit paylink
curl --request PATCH \
  --url https://api.orafi.app/v1/paylinks/{paylinkId} \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'payload=<string>' \
  --form 'images=<string>' \
  --form images.items='@example-file'
{
  "success": true,
  "message": "Paylink updated 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"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication required for most endpoints

Path Parameters

​
paylinkId
string
required

The paylink ID

Body

multipart/form-data
​
payload
string

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

​
images
file[]

Image files (up to 4 images total)

Maximum array length: 4

Response

Paylink updated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Paylink updated successfully"

​
data
object