Skip to main content
GET
/
payment-link
/
get
/
{id}
Retrieve the payment link record by order ID.
curl --request GET \
  --url https://sandbox.omnispay.com/api/payment-link/get/{id} \
  --header 'X-HMAC-Signature: <api-key>' \
  --header 'accountId: <api-key>' \
  --header 'apiKey: <api-key>'
{
  "status": "<string>",
  "message": "<string>",
  "response": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.omnispay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Retrieve Payment Link

This endpoint retrieves the payment link record associated with the given order ID.

​
Path Parameters

  • orderId (string, required): The unique identifier for retrieves the payment link record.

​
Request Headers

  • User-Agent (string, optional): The User-Agent header, which is not mandatory.

​
Example Request

GET /payment-link/get/12345
User-Agent: Mozilla/5.0

Authorizations

​
apiKey
string
header
required
​
X-HMAC-Signature
string
header
required
​
accountId
string
header
required

Headers

​
User-Agent
string

Path Parameters

​
id
string
required

Order ID for retrieving the payment link record

Response

OK. Payment link record retrieved successfully

​
status
string
​
message
string
​
response
object