curl --request POST \
--url https://sandbox-platform.jupico.com/v1/paymentlinks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"subMerchantId": "jpt-sim-md-1",
"totalAmount": 55,
"description": "<string>"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/paymentlinks"
payload = {
"subMerchantId": "jpt-sim-md-1",
"totalAmount": 55,
"description": "<string>"
}
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({subMerchantId: 'jpt-sim-md-1', totalAmount: 55, description: '<string>'})
};
fetch('https://sandbox-platform.jupico.com/v1/paymentlinks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/paymentlinks';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({subMerchantId: 'jpt-sim-md-1', totalAmount: 55, description: '<string>'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Create a payment link
Creates a shareable payment link. Each customer who opens the link pays on a Jupico-hosted page — no integration code required at the point of sharing.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/paymentlinks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"subMerchantId": "jpt-sim-md-1",
"totalAmount": 55,
"description": "<string>"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/paymentlinks"
payload = {
"subMerchantId": "jpt-sim-md-1",
"totalAmount": 55,
"description": "<string>"
}
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({subMerchantId: 'jpt-sim-md-1', totalAmount: 55, description: '<string>'})
};
fetch('https://sandbox-platform.jupico.com/v1/paymentlinks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/paymentlinks';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({subMerchantId: 'jpt-sim-md-1', totalAmount: 55, description: '<string>'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The subMerchantId associated with the payment link.
"jpt-sim-md-1"
The total amount of the payment link.
55
The payment link description.
Object to edit configuration of created hosted session.
Hide child attributes
Hide child attributes
Payment methods offered on the hosted page.
Hide child attributes
Hide child attributes
Default payment method one of ["creditCard","eCheck", "applePay","googlePay"]
"creditCard"
Navigation behavior of the hosted page.
Hide child attributes
Hide child attributes
Default payment method one of ["standalone","redirect"]
"redirect"
URLs the customer is redirected to during the flow.
Hide child attributes
Hide child attributes
URL the customer is redirected to after successful payment.
"https://yoursite.com/successUrl"
URL the customer is redirected to if they cancel.
"https://yoursite.com/cancelUrl"
URL the customer is redirected to when they navigate back.
"https://yoursite.com/backUrl"
Hosted session functions
Hide child attributes
Hide child attributes
Customization of the pay button.
Collect the customer's email address during checkout.
How many times the hosted session link can be used.
Response
Payment link successfully created.
Was this page helpful?

