Preview

List participant relationship actions

GET
/providers/{providerID}/participants/{participantID}/relationship-actions

List the recorded suspensions and reactivations of your provider’s relationship with a participant, newest first. Returns an empty list when none are recorded. Returns 404 when neither key matches a participant within your provider.

History is best effort. It can lag the current state, and it can omit an action that Moov Money committed but did not record. Read the current state from the participant relationship, and do not use this history to decide whether a participant can send.

Pagination is cursor-based. Omit cursor to fetch the first page; use nextCursor from each response to fetch the next page. A cursor from a different participant or query returns a 400 with error code invalid-cursor.

Auth: API key or bearer token. Scoped to the calling provider.

Request
cURL
curl -X GET https://api.moov.money/providers/{providerID}/participants/{participantID}/relationship-actions \
  -u "$MOOV_API_KEY_ID:$MOOV_API_KEY_SECRET" \
  -H "X-Moov-Version: v2026.10.00"
Responses
200 400 401 403 404
The request completed successfully.
{
  "actions": [
    {
      "actionID": "ra_01HF5J9ZKQT4RXP8M2VYBN3D",
      "actor": {
        "applicationKeyID": "5f0c3b2a-8d4e-4b7a-9c1f-2e6d7a8b9c0d",
        "callingAccountID": "acc_01HF5J9ZKQT4RXP8M2VYBN3D",
        "kind": "user",
        "userID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
      },
      "note": "Unusual activity reported by the customer",
      "occurredOn": "2026-10-06T16:00:00Z",
      "participantReviewID": "8b1f6c2e-4d3a-5e7f-9a0b-1c2d3e4f5a6b",
      "reasonCode": "suspected-fraud",
      "relationship": {
        "suspended": false,
        "versionID": "relationship-v3"
      },
      "type": "suspension"
    }
  ]
}
Malformed request: the body or headers failed validation.
Response body application/problem+json
RFC 9457 Problem Details error body, served as application/problem+json. From v2026.10.00, every error response that has a body uses this schema.

type

string required
URI that tells you which problem occurred. Branch on this value; it never changes. Moov problem types look like https://api.moov.money/errors#<code> (for example invalid-request, idempotency-key-reused, or idempotency-request-in-progress). Treat the value as an opaque constant and do not fetch it. about:blank means the HTTP status code says everything there is to know.

title

string required
Short human-readable name of the problem type. Fixed per type; defaults to the HTTP status text.

status

integer<int32> required
The HTTP status code of this response.

detail

string
Human-readable explanation of this specific occurrence.

instance

string
URI reference that identifies this specific occurrence.

errors

array<object>
The request-body fields that failed validation. Present on validation errors only.
Show child attributes

errors[]

pointer

string required
RFC 6901 JSON Pointer to the field, using the public JSON field names. If the field is missing, the pointer shows where it belongs.

detail

string required
What is wrong with the field.
Authentication missing, invalid, or insufficient.
Authentication present but the action is forbidden for this principal/claim.
The requested resource was not found.

Headers

X-Moov-Version

string
Set this header to the API version being targeted (e.g. v2026.10.00). When omitted, the server applies its default version.

Path parameters

providerID

string required
Your provider account ID.

participantID

string required
The participant’s participantID, or your externalID for them. Both resolve to the same participant.

Query parameters

cursor

string
Opaque pagination cursor from a previous response’s nextCursor. Omit to fetch the first page.

limit

integer <int32>
Maximum number of actions to return. Defaults to 25; values outside 1-100 return 400.

Response

Response envelope for list relationship actions.

actions

array<object> required
The page of relationship actions, newest first.
Show child attributes

actions[]

actionID

string required
Unique identifier for this action.

type

string<enum> required
Kind of action.
Possible values: suspension, reactivation

occurredOn

string<date-time> required
When the action took effect.

reasonCode

string<enum>
Why the participant was suspended. Present when type is suspension.
Possible values: suspected-fraud, account-compromise, customer-request, compliance-review, legal-hold, policy-violation, other

note

string
Note supplied with the action. Always present when type is reactivation. For a suspension, omitted when none was supplied.

participantReviewID

string
Present when a participant-review suspension wrote this action.

actor

object required
Who performed the action.
Show child attributes

actions[].actor

kind

string<enum> required
Kind of actor.
Possible values: user, application, system

userID

string
Moov user ID of the person who acted. Present when kind is user. Omitted when kind is application or system.

applicationKeyID

string
ID of the application key that acted. Present when kind is application. Omitted when kind is user or system.

callingAccountID

string
Moov account ID that the actor acted from. Present when kind is user or application. Omitted when kind is system.

relationship

object required
The relationship state that this action produced.
Show child attributes

actions[].relationship

suspended

boolean required
Whether you suspended this participant. A suspended participant cannot send payouts or create requests through your provider. Money that a payer sends for one of their existing requests is not paid out to them until you reactivate them or the request expires. Signing in, payments that already started, reversals, and refunds are not affected.

versionID

string required
Opaque version of the relationship state. Send it as expectedVersionID on your next suspension or reactivation. It is not a relationship ID.

nextCursor

string
Opaque cursor for the next page; absent on the last page.

hasMore

boolean required
Whether another page of results follows this one.