Send Payment Links by SMS or Email

This guide describes the Pay by Link API: how to create a payment whose link is delivered to the shopper by SMS or email, and how to check its status with a GET call.

The payment link is generated by seQura and delivered directly to the shopper through the channel you choose (sms or email). If you prefer to deliver it through your own means, use the no_op channel: nothing is sent to the shopper and the payment link is returned to you in the Location response header. In every case, you follow up on the payment through the result webhook or the status endpoint.

Authentication and environments

All calls require HTTP Basic Auth with your seQura merchant credentials (the username is your merchant reference). There is no separate sign-up step: on your first call with valid credentials, your merchant account is provisioned automatically.

Invalid credentials return 401 with error_codes: ["credentials_invalid"]; a missing Authorization header returns 401 with ["credentials_required"].

Create a payment and deliver the link

Endpoint: /api/workflow_payments/v1/payments

Method: POST

Creates the payment and triggers the delivery of the payment link to the shopper. With channel: "sms" the phone field is required.

Body parameters (JSON)

Example — send a payment link by SMS

curl -X POST "https://partner-integration-middleware-sandbox.sequra.com/api/workflow_payments/v1/payments" \
  -u "YOUR_MERCHANT_REF:YOUR_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "sms",
    "phone": "+34612345678",
    "email": "[email protected]",
    "given_names": "Ana",
    "surnames": "García",
    "reference": "ORDER-2026-0042",
    "total_amount": 10050,
    "currency": "EUR",
    "product": "tbs",
    "notification_url": "https://your-shop.com/webhooks/sequra"
  }'

Response: 201 Created with an empty body. The Location header contains the seQura order UUID.

HTTP/1.1 201 Created
Location: a3f1c9d2-8b47-4e02-9c11-5f6d7e8a9b0c

Example — with cart items

Each line accepts name (required), reference, quantity, price_with_tax and total_with_tax — amounts in cents, like total_amount. If items is omitted, a single "Payment" line is generated for the total.

curl -X POST "https://partner-integration-middleware-sandbox.sequra.com/api/workflow_payments/v1/payments" \
  -u "YOUR_MERCHANT_REF:YOUR_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "sms",
    "phone": "+34612345678",
    "email": "[email protected]",
    "given_names": "Ana",
    "surnames": "García",
    "reference": "ORDER-2026-0044",
    "total_amount": 10050,
    "currency": "EUR",
    "product": "pp3",
    "items": [
      {
        "name": "Running shoes",
        "reference": "SKU-SHO-001",
        "quantity": 2,
        "price_with_tax": 2500,
        "total_with_tax": 5000
      },
      {
        "name": "Waterproof jacket",
        "reference": "SKU-JAC-072",
        "quantity": 1,
        "price_with_tax": 5050,
        "total_with_tax": 5050
      }
    ],
    "notification_url": "https://your-shop.com/webhooks/sequra"
  }'

Example — same payment by email

curl -X POST "https://partner-integration-middleware-sandbox.sequra.com/api/workflow_payments/v1/payments" \
  -u "YOUR_MERCHANT_REF:YOUR_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email",
    "email": "[email protected]",
    "reference": "ORDER-2026-0043",
    "total_amount": 4999
  }'

Example — get the link without sending it (no_op)

With channel: "no_op", seQura does not deliver anything to the shopper. The payment link comes back in the Location response header, so you can read it and send it through your own means (your CRM, WhatsApp, a printed QR…).

curl -X POST "https://partner-integration-middleware-sandbox.sequra.com/api/workflow_payments/v1/payments" \
  -u "YOUR_MERCHANT_REF:YOUR_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "no_op",
    "email": "[email protected]",
    "reference": "ORDER-2026-0045",
    "total_amount": 7500
  }'

Response: 201 Created with an empty body. The Location header contains the payment link to share with the shopper.

HTTP/1.1 201 Created
Location: <payment link to share with the shopper>

Check the payment status

Endpoint: /api/workflow_payments/v1/payments/{payment_id}

Method: GET

Returns the current state of the payment. The response is deliberately minimal and does not include the payment link.

Example

curl "https://partner-integration-middleware-sandbox.sequra.com/api/workflow_payments/v1/payments/7418632b-6c32-40b9-9942-be7007e355e7" \
  -u "YOUR_MERCHANT_REF:YOUR_PASSWORD"

Response: 200 OK

{
  "payment_id": "7418632b-6c32-40b9-9942-be7007e355e7",
  "reference": "ORDER-2026-0042",
  "status": "authorized"
}

Possible statuses

Payment result webhook

If the create request included a notification_url, seQura sends a JSON POST to that URL when the payment is resolved. Your endpoint must respond 200; otherwise the notification is retried up to 9 times with exponential backoff (60 s × 3ⁿ⁻¹).

{
  "payment_id": "7418632b-6c32-40b9-9942-be7007e355e7",
  "order_id": "a3f1c9d2-8b47-4e02-9c11-5f6d7e8a9b0c",
  "reference": "ORDER-2026-0042",
  "status": "approved",
  "amount": 10050,
  "currency": "EUR",
  "timestamp": "2026-07-14T10:00:00Z"
}

• payment_id — use it to query the status endpoint.
• order_id — the seQura order UUID (the one returned in the Location header).
• status — approved, needs_review or failed.

Errors

All errors share the same JSON envelope:

{
  "request_id": "fcb7262b-…",
  "error_type": "validation_error",
  "error_codes": ["email_is_missing", "total_amount_is_missing"]
}