Operations

Overview

After users complete transfers in a widget, you can query operations for reporting, support, and reconciliation. For status meanings and the webhooks that fire as an operation progresses, see Operation lifecycle.

Method	Path	Purpose
`GET`	`/partner/operations`	Paginated list with filters
`GET`	`/partner/operations/:operationId`	Full detail for one operation

Auth: X-API-Key (raas_sandbox_* / raas_live_*).

Status filter values

`status`	Meaning
`created`	Operation initiated
`processing`	Funds in transit / awaiting settlement
`completed`	Transfer successful
`failed`	Transfer failed
`cancelled`	Operation cancelled

List operations

Set BASE_URL from the Partner API overview.

curl "$BASE_URL/partner/operations?page=1&limit=20" \
  -H "X-API-Key: raas_sandbox_your_api_key_here"

Query parameters

Param	Description
`page`	Page number (default `1`)
`limit`	Page size (default `20`)
`referenceId`	Filter by your end-user id
`userId`	Filter by platform user id
`linkId`	Filter by magic link
`externalId`	Filter by the partner tracing ID set on the magic link
`campaign`	Filter by campaign slug stamped on the operation
`status`	Filter by operation status
Date range	Supported when present in OpenAPI (`from` / `to` style filters)

Response shape

{
  "success": true,
  "data": {
    "items": [
      {
        "operationId": "op_acme_abc123",
        "userId": "usr_acme_x1y2z3",
        "referenceId": "user_12345",
        "senderName": "Juan Perez",
        "recipientUserId": null,
        "recipientReferenceId": null,
        "recipientName": "Maria Lopez",
        "linkId": "link_acme_a1b2c3d4e5f6",
        "status": "completed",
        "amount": {
          "send": 100,
          "receive": 1850.5,
          "rate": 18.505,
          "fee": 3.99
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 42,
      "totalPages": 3
    }
  }
}

Get operation detail

curl "$BASE_URL/partner/operations/op_acme_abc123" \
  -H "X-API-Key: raas_sandbox_your_api_key_here"

Detail responses include funding/payout method summaries, amount breakdown, status timeline, references (pickup PIN as PAYOUT_CODE when issued), documents descriptors, and failure reason when applicable. When the operation selected a catalog payer, payout also includes payerCode (and stateCode / cityCode when the SKU is geo-scoped). Field schemas are in the Partner API overview OpenAPI (Get operation details).

{
  "success": true,
  "data": {
    "operationId": "op_acme_abc123",
    "status": "processing",
    "references": [
      {
        "type": "PAYOUT_CODE",
        "value": "998877",
        "label": { "en": "Payout code", "es": "Clave de cobro" },
        "presentation": "PROMINENT",
        "issuedAt": "2026-08-27T06:40:00.000Z"
      },
      {
        "type": "TRACKING_REF",
        "value": "IMX-2026-00421",
        "presentation": "SECONDARY"
      }
    ],
    "documents": [
      {
        "kind": "PAYOUT_RECEIPT",
        "mediaType": "application/pdf",
        "freshness": "LIVE",
        "availability": "AVAILABLE"
      }
    ]
  }
}

For the cash-pickup PIN, see Payout code (PIN) — pull from this GET or handle operation.references_available. The list endpoint does not include references.

For real-time status updates, subscribe to operation.created, operation.completed, operation.failed, and operation.cancelled — see Webhook events.

Next steps

Payout code (PIN)

Pull or webhook for the pickup PIN.

Operation lifecycle

Statuses and webhook mapping.

Users and CIP

User list, block/unblock, CIP readiness.

API overview

Envelopes, auth, pagination conventions.

Getting Started

Request API

Concepts

Integration

Flows

Webhooks

Operations

Overview

Status filter values

List operations

Query parameters

Response shape

Get operation detail

Next steps

Payout code (PIN)

Operation lifecycle

Users and CIP

API overview

​Overview

​Status filter values

​List operations

​Query parameters

​Response shape

​Get operation detail

​Next steps

Payout code (PIN)

Operation lifecycle

Users and CIP

API overview

Overview

Status filter values

List operations

Query parameters

Response shape

Get operation detail

Next steps