Part payment orders

Part Payment lets a customer pay for their purchase in interest-free instalments without creating a recurring subscription. The number of instalments depends on the product configured for your merchant account.

The integration flow:

Create the order
Send SMS to the customer
Cancel (if needed)

Step 1 — Create the order

POST /api/public/v1/orders

Requires Basic Auth.

{
  "merchant": {
    "id": "merchant_1",
    "store_ref": "store_1"
  },
  "operator_ref": "[email protected]",
  "reference": "pos_1234",
  "mobile_phone": "+34666123456",
  "given_names": "María",
  "surnames": "García López",
  "date_of_birth": "1990-01-01",
  "nin": "12345678A",
  "address": "Calle Mayor 1",
  "postal_code": "08001",
  "city": "Barcelona",
  "cart_items": [
    {
      "reference": "FRAME-001",
      "name": "Designer Frame",
      "price_with_tax": 25000,
      "quantity": 1
    }
  ]
}

Note: Cart items must not be subscription-type items. Use standard product references from your catalogue.

Response

Returns a cart object. Save the id — you need it for Step 2.

{
  "id": 4567,
  "reference": "pos_1234",
  "status": "pending",
  "total_with_tax": "250.00",
  "currency": "EUR",
  "sms_mobile_phone": "+34666123456",
  "operator_ref": "[email protected]",
  "cart_items": [
    {
      "reference": "FRAME-001",
      "name": "Designer Frame",
      "price_with_tax": 25000,
      "quantity": 1,
      "total_with_tax": 25000
    }
  ],
  "customer_data": {
    "given_names": "María",
    "surnames": "García López",
    "nin": "12345678A",
    "email": "",
    "phone": "+34666123456",
    "dob": "1990-01-01"
  },
  "solicitation": null,
  "order_uuid": null,
  "subscription_id": null,
  "joint_customer": null,
  "can_resend_sms": true,
  "created_at": "2024-01-15T10:00:00.000Z"
}

Step 2 — Send the checkout link by SMS

Once the order is created, trigger an SMS to the customer's mobile number with a link to complete the payment agreement.

POST /api/public/v1/orders/:id/send_sms

Requires Basic Auth.

Parameter	Type	Required	Description
`mobile_phone`	string	No	Override the phone number. Defaults to the number provided in the order.

Response

{
  "message": "SMS sent successfully"
}

The customer receives an SMS with a checkout URL. They open it on their own device and complete the instalment agreement with seQura. You will receive a webhook notification when the order is confirmed.

Cancelling an order

An order can be cancelled while it is in pending or confirmed status.

POST /api/public/v1/orders/:id/cancel

Requires Basic Auth. No request body needed.

Behaviour

Order status	What happens
`pending`	Order is immediately cancelled in seQura.
`confirmed`	seQura sends a cancellation request to the financing provider.

Response

{
  "success": true,
  "message": "Order cancelled successfully"
}

Error responses

HTTP status	Reason
422	Order is not in a cancellable status (already cancelled, completed, etc.)
422	Order belongs to a subscription — use the subscriptions cancel endpoint instead
401	API account not authorised for this order
404	Order not found