POST
/
v1
/
order
curl -X POST https://api-eu.sulpayments.ch/v1/order \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "order": {
      "partner_code": "ORDER-001",
      "value": 100.00,
      "description": "Subscription",
      "notification_url": "https://yourapp.com/webhooks/order",
      "installments": 1,
      "payment_method": "credit_card"
    },
    "customer": {
      "name": "Jane Doe",
      "email": "jane@example.com",
      "phone": "+5511999999999",
      "document": "12345678909"
    },
    "credit_card": {
      "holder": "JANE DOE",
      "number": "4111111111111111",
      "cvv": "123",
      "due_date": "12/2030",
      "brand": "visa"
    }
  }'
{
  "id": "ord_5f1a3b2c",
  "status": "waiting_payment"
}
Submit a credit card payment without redirecting the customer to a hosted form. The cardholder data is sent server-to-server.

Headers

Authorization
string
required
Bearer {token} from POST /v1/auth.

Body

order

order.partner_code
string
required
Your unique reference for this order.
order.value
number
required
Amount to charge in your local currency.
order.description
string
required
Short description shown on the customer’s statement and dashboard.
order.notification_url
string
required
HTTPS URL that will receive status updates (postback).
order.installments
integer
Number of installments. Defaults to 1.
order.payment_method
string
required
Payment method identifier. Use credit_card.

customer

customer.name
string
required
Full name (first and last).
customer.email
string
required
Valid email address.
customer.phone
string
required
Phone number with country code.
customer.document
string
required
Customer tax ID (CPF for Brazil).
customer.login
string
Customer identifier on your platform.
customer.birth
string
Date of birth (YYYY-MM-DD).

credit_card

credit_card.holder
string
required
Cardholder name as printed on the card.
credit_card.number
string
required
Card number, digits only.
credit_card.cvv
string
required
Card verification value.
credit_card.due_date
string
required
Expiration date in MM/YYYY format.
credit_card.brand
string
required
One of visa, master, amex, elo, aura, jcb, diners, discover, hipercard, hiper, sorocred.

address

address.street
string
address.number
string
address.neighborhood
string
address.zip
string
address.city
string
address.state
string

risk

risk.ip
string
Customer’s IP at the time of purchase.
risk.browser
string
User-Agent string.
risk.fingerprint
string
Device fingerprint identifier.

Response

id
string
Unique order identifier.
status
string
Initial status (typically waiting_payment).
curl -X POST https://api-eu.sulpayments.ch/v1/order \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "order": {
      "partner_code": "ORDER-001",
      "value": 100.00,
      "description": "Subscription",
      "notification_url": "https://yourapp.com/webhooks/order",
      "installments": 1,
      "payment_method": "credit_card"
    },
    "customer": {
      "name": "Jane Doe",
      "email": "jane@example.com",
      "phone": "+5511999999999",
      "document": "12345678909"
    },
    "credit_card": {
      "holder": "JANE DOE",
      "number": "4111111111111111",
      "cvv": "123",
      "due_date": "12/2030",
      "brand": "visa"
    }
  }'
{
  "id": "ord_5f1a3b2c",
  "status": "waiting_payment"
}