List payment links
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/paymentlinks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/paymentlinks"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/paymentlinks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/paymentlinks';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"count": 123,
"data": [
{
"spProductId": "<string>",
"subMerchantId": "<string>",
"paymentLinkId": "<string>",
"items": [
{
"amount": 123,
"quantity": 123,
"description": "<string>"
}
],
"totalModifiers": [
{
"amount": 123,
"description": "<string>",
"type": "<string>"
}
],
"totalAmount": 123,
"description": "<string>",
"status": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"hostedSession": {
"hostedSessionId": "<string>",
"url": "<string>"
}
}
],
"query": {
"criteria": {},
"options": {}
}
}Query
List payment links
Returns payment links with usage details and status.
POST
https://sandbox-platform.jupico.com
/
v1
/
query
/
paymentlinks
List payment links
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/paymentlinks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/paymentlinks"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/paymentlinks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/paymentlinks';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"count": 123,
"data": [
{
"spProductId": "<string>",
"subMerchantId": "<string>",
"paymentLinkId": "<string>",
"items": [
{
"amount": 123,
"quantity": 123,
"description": "<string>"
}
],
"totalModifiers": [
{
"amount": 123,
"description": "<string>",
"type": "<string>"
}
],
"totalAmount": 123,
"description": "<string>",
"status": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"hostedSession": {
"hostedSessionId": "<string>",
"url": "<string>"
}
}
],
"query": {
"criteria": {},
"options": {}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
The body is of type object.
Response
200 - application/json
Find PaymentLinks
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Machine-readable result code. See the Error Codes reference.
Number of records.
The response payload.
Show child attributes
Show child attributes
Echo of the query envelope that produced this result.
Show child attributes
Show child attributes
Last modified on August 31, 2026
Was this page helpful?

