curl --request POST \
--url https://sandbox-platform.jupico.com/v1/checkouts \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"subMerchantId": "jpt-sim-md-1",
"totalAmount": 55,
"description": "<string>",
"hostedSession": {
"paymentMethods": {
"defaultMethod": "creditCard",
"creditCard": {
"enabled": true
},
"eCheck": {
"enabled": false
},
"applePay": {
"enabled": false
},
"googlePay": {
"enabled": false
}
},
"flow": {
"redirect": {
"successUrl": "https://yoursite.com/successUrl",
"cancelUrl": "https://yoursite.com/cancelUrl",
"backUrl": "https://yoursite.com/backUrl"
}
},
"functions": {
"collectBillingAddress": {
"enabled": true
},
"collectShippingAddress": {
"enabled": false
},
"collectPhoneNumber": {
"enabled": true
},
"callToAction": {
"enabled": true,
"label": "Pay",
"note": "Note desc."
},
"notes": {
"enabled": false
},
"collectEmail": {
"enabled": false,
"updateCustomer": false
}
},
"constraints": {
"timeLimit": 30
}
}
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/checkouts"
payload = {
"subMerchantId": "jpt-sim-md-1",
"totalAmount": 55,
"description": "<string>",
"hostedSession": {
"paymentMethods": {
"defaultMethod": "creditCard",
"creditCard": { "enabled": True },
"eCheck": { "enabled": False },
"applePay": { "enabled": False },
"googlePay": { "enabled": False }
},
"flow": { "redirect": {
"successUrl": "https://yoursite.com/successUrl",
"cancelUrl": "https://yoursite.com/cancelUrl",
"backUrl": "https://yoursite.com/backUrl"
} },
"functions": {
"collectBillingAddress": { "enabled": True },
"collectShippingAddress": { "enabled": False },
"collectPhoneNumber": { "enabled": True },
"callToAction": {
"enabled": True,
"label": "Pay",
"note": "Note desc."
},
"notes": { "enabled": False },
"collectEmail": {
"enabled": False,
"updateCustomer": False
}
},
"constraints": { "timeLimit": 30 }
}
}
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>',
hostedSession: {
paymentMethods: {
defaultMethod: 'creditCard',
creditCard: {enabled: true},
eCheck: {enabled: false},
applePay: {enabled: false},
googlePay: {enabled: false}
},
flow: {
redirect: {
successUrl: 'https://yoursite.com/successUrl',
cancelUrl: 'https://yoursite.com/cancelUrl',
backUrl: 'https://yoursite.com/backUrl'
}
},
functions: {
collectBillingAddress: {enabled: true},
collectShippingAddress: {enabled: false},
collectPhoneNumber: {enabled: true},
callToAction: {enabled: true, label: 'Pay', note: 'Note desc.'},
notes: {enabled: false},
collectEmail: {enabled: false, updateCustomer: false}
},
constraints: {timeLimit: 30}
}
})
};
fetch('https://sandbox-platform.jupico.com/v1/checkouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/checkouts';
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>',
hostedSession: {
paymentMethods: {
defaultMethod: 'creditCard',
creditCard: {enabled: true},
eCheck: {enabled: false},
applePay: {enabled: false},
googlePay: {enabled: false}
},
flow: {
redirect: {
successUrl: 'https://yoursite.com/successUrl',
cancelUrl: 'https://yoursite.com/cancelUrl',
backUrl: 'https://yoursite.com/backUrl'
}
},
functions: {
collectBillingAddress: {enabled: true},
collectShippingAddress: {enabled: false},
collectPhoneNumber: {enabled: true},
callToAction: {enabled: true, label: 'Pay', note: 'Note desc.'},
notes: {enabled: false},
collectEmail: {enabled: false, updateCustomer: false}
},
constraints: {timeLimit: 30}
}
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Create a checkout session
Creates a hosted checkout session where the customer completes payment on a Jupico-hosted page. Configure accepted payment methods, data collection, and redirect behavior through the hosted session settings.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/checkouts \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"subMerchantId": "jpt-sim-md-1",
"totalAmount": 55,
"description": "<string>",
"hostedSession": {
"paymentMethods": {
"defaultMethod": "creditCard",
"creditCard": {
"enabled": true
},
"eCheck": {
"enabled": false
},
"applePay": {
"enabled": false
},
"googlePay": {
"enabled": false
}
},
"flow": {
"redirect": {
"successUrl": "https://yoursite.com/successUrl",
"cancelUrl": "https://yoursite.com/cancelUrl",
"backUrl": "https://yoursite.com/backUrl"
}
},
"functions": {
"collectBillingAddress": {
"enabled": true
},
"collectShippingAddress": {
"enabled": false
},
"collectPhoneNumber": {
"enabled": true
},
"callToAction": {
"enabled": true,
"label": "Pay",
"note": "Note desc."
},
"notes": {
"enabled": false
},
"collectEmail": {
"enabled": false,
"updateCustomer": false
}
},
"constraints": {
"timeLimit": 30
}
}
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/checkouts"
payload = {
"subMerchantId": "jpt-sim-md-1",
"totalAmount": 55,
"description": "<string>",
"hostedSession": {
"paymentMethods": {
"defaultMethod": "creditCard",
"creditCard": { "enabled": True },
"eCheck": { "enabled": False },
"applePay": { "enabled": False },
"googlePay": { "enabled": False }
},
"flow": { "redirect": {
"successUrl": "https://yoursite.com/successUrl",
"cancelUrl": "https://yoursite.com/cancelUrl",
"backUrl": "https://yoursite.com/backUrl"
} },
"functions": {
"collectBillingAddress": { "enabled": True },
"collectShippingAddress": { "enabled": False },
"collectPhoneNumber": { "enabled": True },
"callToAction": {
"enabled": True,
"label": "Pay",
"note": "Note desc."
},
"notes": { "enabled": False },
"collectEmail": {
"enabled": False,
"updateCustomer": False
}
},
"constraints": { "timeLimit": 30 }
}
}
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>',
hostedSession: {
paymentMethods: {
defaultMethod: 'creditCard',
creditCard: {enabled: true},
eCheck: {enabled: false},
applePay: {enabled: false},
googlePay: {enabled: false}
},
flow: {
redirect: {
successUrl: 'https://yoursite.com/successUrl',
cancelUrl: 'https://yoursite.com/cancelUrl',
backUrl: 'https://yoursite.com/backUrl'
}
},
functions: {
collectBillingAddress: {enabled: true},
collectShippingAddress: {enabled: false},
collectPhoneNumber: {enabled: true},
callToAction: {enabled: true, label: 'Pay', note: 'Note desc.'},
notes: {enabled: false},
collectEmail: {enabled: false, updateCustomer: false}
},
constraints: {timeLimit: 30}
}
})
};
fetch('https://sandbox-platform.jupico.com/v1/checkouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/checkouts';
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>',
hostedSession: {
paymentMethods: {
defaultMethod: 'creditCard',
creditCard: {enabled: true},
eCheck: {enabled: false},
applePay: {enabled: false},
googlePay: {enabled: false}
},
flow: {
redirect: {
successUrl: 'https://yoursite.com/successUrl',
cancelUrl: 'https://yoursite.com/cancelUrl',
backUrl: 'https://yoursite.com/backUrl'
}
},
functions: {
collectBillingAddress: {enabled: true},
collectShippingAddress: {enabled: false},
collectPhoneNumber: {enabled: true},
callToAction: {enabled: true, label: 'Pay', note: 'Note desc.'},
notes: {enabled: false},
collectEmail: {enabled: false, updateCustomer: false}
},
constraints: {timeLimit: 30}
}
})
};
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 checkout.
"jpt-sim-md-1"
The total amount of the checkout.
55
The checkout 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
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.
Response
Checkout successfully created.
Was this page helpful?

