post
https://app.shuttleglobal.com/c/api/instances/{instance_key}/checkouts
Create a hosted checkout session. The checkout accepts all parameters from the
Create Payment API (except payment_method), plus additional options that control
the checkout UX.
The response includes a checkout id (nonce) which you embed on your page via shuttle.js:
<div data-shuttle-checkout="CHECKOUT_ID" data-shuttle-style="INLINE"></div>
<script src="https://app.shuttleglobal.com/shuttle-1.4.X.js"></script>Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Business Rules
The logic behind this operation, by what the request carries:
- Change the payment method on a contract — action TOKENISE with contracts[] naming the contract; sets up the selection, the change itself is the PUT above or the tokenise below
- Collect a contract's arrears now — body carries contract; the admin app sends source MOTO and default_amount equal to the arrears
- Set up a recurring or scheduled agreement — frequency other than ONEOFF, or scheduled_date / scheduled_days, or a charges[] schedule; prepares the checkout the form then submits
- Save a payment method without charging it — action TOKENISE for an account; prepares the checkout, the save itself is the POST below
- Take a one-off payment — frequency ONEOFF for an account
Bad request - invalid parameters