Create links

Overview

POST /partner/links creates a magic link. The body is a discriminated union on flow. Shared envelope fields apply to every flow; each flow adds its own config. Host: Partner API overview.

Shared envelope

Field	Required	Description
`referenceId`	Yes	Your end-user id
`flow`	Yes	Flow slug (`smart`, `m2m`, …)
`expiresInMinutes`	No	TTL 5–10080 (default partner setting, usually 60)
`externalId`	No	Your order/ticket id (copied to operations)
`campaign`	No	Campaign slug (`a-z`, `0-9`, `.`, `-`, `_`). Opaque join key to your campaign catalog. Stamped on the user at claim (first-touch) and copied onto every operation.
`metadata`	No	Arbitrary JSON (do not put the campaign slug here — use `campaign`)
`theme`	No	Opaque theme object for the flow UI
`language`	No	`en` or `es`
`callbackUrl`	No	Per-link Return to app URL while the magic link is still valid. Not a webhook. Dead links (410/409) use Partner Settings `sessionExpiredRedirectUrl`.
`headerName`	No	Brand name in widget header
`cipTemplateId`	No	CIP template override
`presentation`	No	`{ showSplash? }` (`showAgreement` is deprecated and ignored)
`contact`	No	`{ email? }` — end-user contact from your auth provider. Merged onto the User on claim when the claimer matches `referenceId`. Not used for notifications or corridor provisioning.
`config`	Flow-dependent	Flow-specific payload

campaign is lowercased and trimmed. Invalid slugs (spaces, uppercase leftovers, leading punctuation) are rejected with 400 — they are not rewritten, so the join key stays identical to the one in your campaign system. Fund-request and payout-claim links minted from a parent widget inherit the parent slug.

Smart (minimal)

curl -X POST https://raas-widgets-backend-sandbox.up.railway.app/partner/links \
  -H "X-API-Key: raas_sandbox_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "referenceId": "user-12345",
    "flow": "smart",
    "language": "es",
    "presentation": { "showSplash": false },
    "contact": { "email": "jane@example.com" }
  }'

M2M (prefill)

curl -X POST https://raas-widgets-backend-sandbox.up.railway.app/partner/links \
  -H "X-API-Key: raas_sandbox_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "referenceId": "user-12345",
    "flow": "m2m",
    "expiresInMinutes": 120,
    "config": {
      "userData": {
        "name": { "firstName": "Ana", "lastName": "García" },
        "paymentMethod": {
          "type": "bank_account",
          "bankAccount": {
            "country": "MX",
            "accountNumber": "012345678901234567"
          }
        }
      },
      "themeMode": "dark"
    }
  }'

Lola (WhatsApp handoff)

Chat-closed corridor, amount, recipient and payout. referenceId is the sender (wa:<E.164>). See Lola flow for the full config example. Set BASE_URL from Partner API overview.

curl -X POST "$BASE_URL/partner/links" \
  -H "X-API-Key: raas_sandbox_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "referenceId": "wa:+15551234567",
    "flow": "lola",
    "config": {
      "amount": 150,
      "amountAnchor": "send",
      "sourceCountry": "US",
      "destinationCountry": "MX",
      "sourceCurrency": "USD",
      "destinationCurrency": "MXN",
      "recipient": {
        "name": { "firstName": "Maria", "lastName": "Lopez" },
        "payoutMethod": {
          "type": "cash",
          "cash": { "payer": "ELEKTRA", "country": "MX" }
        }
      },
      "returnToChatUrl": "https://wa.me/15551234567"
    }
  }'

Do not send prices, capabilityKey, or funding instrument ids.

Common errors

Code	HTTP	Meaning
`FLOW_REQUIRED` / `UNKNOWN_FLOW`	400	Missing or invalid `flow`
`VALIDATION_FAILED`	400	Envelope or `config` failed validation
`FLOW_NOT_ALLOWED`	403	Flow not in partner `allowedFlows`
`USER_BLOCKED`	403	User cannot receive new links

Discover enabled flows

curl https://raas-widgets-backend-sandbox.up.railway.app/partner/flows \
  -H "X-API-Key: raas_sandbox_your_api_key_here"

Getting Started

Request API

Concepts

Integration

Flows

Webhooks

Operations

Overview

Shared envelope

Smart (minimal)

M2M (prefill)

Lola (WhatsApp handoff)

Common errors

Discover enabled flows

Next steps

Custom flow domains

API Reference

​Overview

​Shared envelope

​Smart (minimal)

​M2M (prefill)

​Lola (WhatsApp handoff)

​Common errors

​Discover enabled flows

​Next steps

Custom flow domains

API Reference

Overview

Shared envelope

Smart (minimal)

M2M (prefill)

Lola (WhatsApp handoff)

Common errors

Discover enabled flows

Next steps