Skip to main content

​
Overview

Use the Request API when your product needs to start a request-money flow and surface status to end users or internal systems. You call the familiar versioned paths under /v1/request-money. RaaS Widgets hosts that contract: same JSON over HTTPS, same create/lookup shape, now backed by fund-request links and operations on this platform.

​
What you get

The authoritative schemas live in the API Reference (OpenAPI tag request-money).

​
How it fits RaaS Widgets

Under the hood, a successful create:
  1. Screens the requester identity when required
  2. Creates a money request (requestId, e.g. req_…)
  3. Mints a fund-request magic link for the sender
  4. Returns the links and public status you already expect
When the sender pays, RaaS Widgets creates an operation. You correlate fulfillment with requestId on operation.* webhooks. Those events (and Partner GET /partner/operations) also include recipientReferenceId: your requestData.userReferenceId (who is paid). Operation referenceId is the payer. The Request API GET snapshot does not include recipientReferenceId. See Lifecycle and Operation lifecycle.
You can also originate asks with the widget request flow, or mint payer links directly with fund-request. The Request API remains the server-to-server path for partners who already integrate /v1/request-money.

​
Environments

The Request API uses the same host as the rest of the Partner API. Copy it from the Partner API overview. In samples, set BASE_URL to that host (no trailing slash, no /v1). Append /v1/request-money in your client. Authenticate with X-API-Key using Partner Portal keys (raas_sandbox_* / raas_live_*). See Authentication. Your partner must have the request-money API feature enabled.
Never use production API keys in development, shared sandboxes, or public repositories.

​
Next steps

Quickstart

Create and look up a request in a few minutes.

Create and lookup

POST/GET payloads, status values, and idempotency.

Lifecycle

Ask → fund-request link → operation → settlement.

Webhooks

Event names, payloads, and signature headers.