Skip to main content
POST
/
api
/
v1
/
checkouts
curl -X POST 'https://api-sandbox.paywithsoap.com/api/v1/checkouts' \
--header 'Content-Type: application/json' \
--header 'Authorization: YOUR_API_KEY' \
--data '{
    "customer_id": "cus_vi57KegYgcRqcGHqip8q6UZiqtrwMT870",
    "type": "deposit"
}'

{
    "url": "https://wallet-sandbox.paywithsoap.com?clientSecret=HMC3VTosbzJd7cLsoP3geC5QmSz8jqF6",
    "id": "chk_HBq6ExeoRDMPFCCabR8n1h7S1towds7K",
    "client_secret": "HMC3VTosbzJd7cLsoP3geC5QmSz8jqF6",
    "line_items": [],
    "line_items_total_amount_cents": null,
    "balance_amount_cents": null,
    "type": "deposit",
    "experience": null
}
Use this endpoint to create a new checkout session for a customer. We support three types of checkouts:
  • A deposit checkout is used to deposit money into a customer’s balance.
  • A purchase checkout is used to purchase a product or service (e.g., Sweepstake coins).
  • A withdrawal checkout is used to withdraw money from a customer’s balance.
curl -X POST 'https://api-sandbox.paywithsoap.com/api/v1/checkouts' \
--header 'Content-Type: application/json' \
--header 'Authorization: YOUR_API_KEY' \
--data '{
    "customer_id": "cus_vi57KegYgcRqcGHqip8q6UZiqtrwMT870",
    "type": "deposit"
}'

{
    "url": "https://wallet-sandbox.paywithsoap.com?clientSecret=HMC3VTosbzJd7cLsoP3geC5QmSz8jqF6",
    "id": "chk_HBq6ExeoRDMPFCCabR8n1h7S1towds7K",
    "client_secret": "HMC3VTosbzJd7cLsoP3geC5QmSz8jqF6",
    "line_items": [],
    "line_items_total_amount_cents": null,
    "balance_amount_cents": null,
    "type": "deposit",
    "experience": null
}

Authorizations

​
Authorization
string
header
required

Body

application/json
  • Deposit
  • Fixed Deposit
  • Sweeps Purchase
  • Withdrawal
  • Fixed Withdrawal
​
customer_id
string
required
Example:
​
type
enum<string>
required
Available options:
deposit
Example:
​
experience
enum<string>
Available options:
web,
webview
​
return_url
string
Example:

Response

​
url
string
​
id
string
​
client_secret
string
​
line_items
object[]
​
line_items_total_amount_cents
integer | null
​
balance_amount_cents
integer | null
​
type
enum<string>
Available options:
deposit,
withdrawal
​
experience
enum<string>
Available options:
web,
webview