POST
/
v1
/
checkout
curl -X POST https://api-eu.sulpayments.ch/v1/checkout \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "order": {
      "partner_code": "ORDER-002",
      "value": 250.00,
      "description": "Hosted checkout",
      "notification_url": "https://yourapp.com/webhooks/order",
      "redirect_url": "https://yourapp.com/thank-you",
      "payment_method": "credit_card"
    },
    "customer": {
      "name": "Jane Doe",
      "email": "jane@example.com",
      "phone": "+5511999999999",
      "document": "12345678909"
    }
  }'

{
  "id": "ord_b9c1d2e3",
  "status": "waiting_payment",
  "form_url": "https://api-eu.sulpayments.ch/checkout/ord_b9c1d2e3"
}
Returns a form_url to which you redirect the customer. The customer enters card data on the SulPayments-hosted page.

​
Headers

​
Authorization
string
required
Bearer {token}

​
Body

​
order

​
order.partner_code
string
required
Your unique reference.
​
order.value
number
required
Amount to charge.
​
order.description
string
required
Order description.
​
order.notification_url
string
required
HTTPS URL for postback notifications.
​
order.redirect_url
string
required
URL the customer is sent to after completing payment.
​
order.installments
integer
​
order.payment_method
string
required
Use credit_card.

​
customer

​
customer.name
string
required
​
customer.email
string
required
​
customer.phone
string
required
​
customer.document
string
required
​
customer.login
string
​
customer.birth
string

​
Response

​
id
string
Order identifier.
​
status
string
Initial status.
​
form_url
string
Hosted checkout URL. Redirect the customer here.
curl -X POST https://api-eu.sulpayments.ch/v1/checkout \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "order": {
      "partner_code": "ORDER-002",
      "value": 250.00,
      "description": "Hosted checkout",
      "notification_url": "https://yourapp.com/webhooks/order",
      "redirect_url": "https://yourapp.com/thank-you",
      "payment_method": "credit_card"
    },
    "customer": {
      "name": "Jane Doe",
      "email": "jane@example.com",
      "phone": "+5511999999999",
      "document": "12345678909"
    }
  }'

{
  "id": "ord_b9c1d2e3",
  "status": "waiting_payment",
  "form_url": "https://api-eu.sulpayments.ch/checkout/ord_b9c1d2e3"
}