Skip to main content
POST
Create a Payment Link

Headers

X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

user_id
string<uuid>
required

Unique identifier (UUID) of the user whose payment records are being retrieved.

Body

application/json
amount
number
required

Amount to be collected via the payment link.

Example:

150.75

description
string | null

Optional note or context about the payment (e.g., product name, service details).

Maximum string length: 255
Example:

"Payment for June invoice"

invoice_number
string | null

Optional invoice reference tied to this payment request.

Maximum string length: 20
Example:

"INV-2025-0012"

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

data
ExternalApiPaymentLinkRead · object | null

The main response payload, if applicable

queryGeneratedTime
number | null
default:1783679844.273462

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400