Assign review
Assign a pending payment review to a team member. Replaces the current
assignee, and the review versionID advances. This route does not
unassign a review.
Fetch the review first and send its versionID as expectedVersionID.
Returns a 409 with error code version-conflict when the review changed
since that read, and changes no assignee. The problem’s currentVersion
is the current review versionID. Fetch the review again before you
retry. Returns a 409 with error code state-conflict when the review is
already resolved. Both 409 problems use the same status code, so check
type to tell them apart.
Returns 200 with the review detail, which includes the new assignee. A review from another provider and a missing review both return 404. Returns 422 when the body fails validation.
Auth: API key or bearer token. Scoped to the calling provider. An affiliated integrator needs the
moov-money-payment-reviews.write scope granted by the FI.
curl -X PUT https://api.moov.money/providers/{providerID}/reviews/{reviewID}/assignment \
-u "$MOOV_API_KEY_ID:$MOOV_API_KEY_SECRET" \
-H "X-Moov-Version: v2026.10.00" \
-H "Content-Type: application/json" \
-d '{
"assigneeUserID": "4d7c1b9e-2f3a-4e5b-8c6d-7e8f9a0b1c2d",
"expectedVersionID": "review-v2"
}'{
"review": {
"assessmentDecision": "allow",
"assessmentLevel": "high",
"assessmentScore": 0,
"assigneeDisplay": {
"displayName": "Alex Reviewer",
"kind": "user"
},
"assigneeUserID": "4d7c1b9e-2f3a-4e5b-8c6d-7e8f9a0b1c2d",
"counterparty": {
"displayName": "Jane Doe",
"externalID": "C-2077",
"funding": {
"createdOn": "2026-09-08T12:00:00Z",
"disabledOn": "2026-10-08T12:00:00Z",
"displayName": "Checking",
"fundingType": "bank_account",
"last4": "5612",
"providerSourceID": "src_01HF5J9ZKQT4RXP8M2VYBN3D"
},
"participantID": "counterparty-id_user",
"phoneNumber": "+15555551234"
},
"createdOn": "2026-08-31T12:00:00Z",
"flaggedParticipantID": "3v2whagmwvbujhwbt7v3nl6ffq_user",
"flaggedRole": "sender",
"fraudScore": 0,
"fundingSource": "src_01HF5J9ZKQT4RXP8M2VYBN3D",
"initiator": {
"displayName": "Jane Smith",
"externalID": "C-1042",
"funding": {
"createdOn": "2026-09-08T12:00:00Z",
"disabledOn": "2026-10-08T12:00:00Z",
"displayName": "Checking",
"fundingType": "bank_account",
"last4": "5612",
"providerSourceID": "src_01HF5J9ZKQT4RXP8M2VYBN3D"
},
"participantID": "participant-id_user",
"status": "active",
"suspended": false
},
"payout": {
"amount": {
"currency": {
"code": "USD",
"decimalPlaces": 2,
"name": "US Dollar",
"numericCode": "840"
},
"value": "100.00"
},
"assessmentIDs": [
"ras_01HF5J9ZKQT4RXP8M2VYBN3D"
],
"claimedOn": "2026-10-06T15:04:00Z",
"completedOn": "2026-10-06T15:05:00Z",
"createdOn": "2026-10-06T15:00:00Z",
"displayStatus": "pending",
"expiresOn": "2026-10-16T15:00:00Z",
"fundedFrom": {
"fundingType": "aft",
"reference": "mmr-abc-123"
},
"hold": {
"active": true,
"expiresOn": "2026-10-06T17:00:00Z",
"reviewIDs": [
"prv_01HF5J9ZKQT4RXP8M2VYBN3D"
]
},
"memo": "Rent split",
"operations": [
{
"externalReference": "aft-transfer-id",
"failureCode": "denied",
"occurredOn": "2026-10-06T15:00:01Z",
"operationID": "op_01HF5J9ZKQT4RXP8M2VYBN3D",
"rail": "aft",
"status": "succeeded",
"type": "collect"
}
],
"payoutID": "pay_01HF5J9ZKQT4RXP8M2VYBN3D",
"recipient": {
"displayName": "Jane Doe",
"externalID": "C-2077",
"funding": {
"createdOn": "2026-09-08T12:00:00Z",
"disabledOn": "2026-10-08T12:00:00Z",
"displayName": "Checking",
"fundingType": "bank_account",
"last4": "5612",
"providerSourceID": "src_01HF5J9ZKQT4RXP8M2VYBN3D"
},
"participantID": "counterparty-id_user",
"phoneNumber": "+15555551234"
},
"referenceNumber": "7K2Q9X4FC",
"reviewIDs": [
"prv_01HF5J9ZKQT4RXP8M2VYBN3D"
],
"sender": {
"displayName": "Jane Smith",
"externalID": "C-1042",
"funding": {
"createdOn": "2026-09-08T12:00:00Z",
"disabledOn": "2026-10-08T12:00:00Z",
"displayName": "Checking",
"fundingType": "bank_account",
"last4": "5612",
"providerSourceID": "src_01HF5J9ZKQT4RXP8M2VYBN3D"
},
"participantID": "participant-id_user",
"status": "active",
"suspended": false
},
"status": "initiated",
"termsAcceptedOn": "2026-10-06T15:02:00Z"
},
"reason": "Payout amount above review threshold",
"reasonCode": "suspected-fraud",
"request": {
"amount": {
"currency": {
"code": "USD",
"decimalPlaces": 2,
"name": "US Dollar",
"numericCode": "840"
},
"value": "100.00"
},
"createdOn": "2026-08-31T12:00:00Z",
"requestID": "01HF5J9ZKQT4RXP8M2VYBN3D_req",
"status": "created"
},
"requesterExternalID": "customer-abc-123",
"resolutionNotes": "Verified account holder",
"resolvedByDisplay": {
"displayName": "Alex Reviewer",
"kind": "user"
},
"reviewID": "prv_01HF5J9ZKQT4RXP8M2VYBN3D",
"reviewStatus": "pending",
"riskAssessmentID": "ras_01HF5J9ZKQT4RXP8M2VYBN3D",
"senderExternalID": "customer-abc-123",
"type": "payout",
"versionID": "review-v2"
}
}Response body application/problem+json
application/problem+json.
From v2026.10.00, every error response that has a body uses this schema.type
string
requiredhttps://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
requiredstatus
integer<int32>
requireddetail
stringinstance
stringerrors
array<object>Show child attributes
errors[]
pointer
string
requireddetail
string
requiredResponse body application/problem+json
application/problem+json.
From v2026.10.00, every error response that has a body uses this schema.type
string
requiredhttps://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
requiredstatus
integer<int32>
requireddetail
stringinstance
stringerrors
array<object>Show child attributes
errors[]
pointer
string
requireddetail
string
requiredRetry-After.Response body application/problem+json
application/problem+json.
From v2026.10.00, every error response that has a body uses this schema.type
string
requiredhttps://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
requiredstatus
integer<int32>
requireddetail
stringinstance
stringerrors
array<object>Show child attributes
errors[]
pointer
string
requireddetail
string
requiredHeaders
X-Moov-Version
stringv2026.10.00). When omitted, the server applies its default version.Path parameters
providerID
string
requiredreviewID
string
requiredRequest
assigneeUserID
string
requiredexpectedVersionID
string
requiredversionID from your latest read.Response
review.review
object
requiredShow child attributes
review
reviewID
string
requiredtype
string<enum>
requiredpayout carries the full payout detail; request carries the request summary.payout,
requestreviewStatus
string<enum>
requiredreviewStatus on the wire.pending,
approved,
rejectedversionID
string
requiredexpectedVersionID on your next assignment or resolution.reason
stringreasonCode
string<enum>suspected-fraud,
account-compromise,
customer-request,
compliance-review,
legal-hold,
policy-violation,
otherriskAssessmentID
stringsenderExternalID
stringrequesterExternalID
stringfundingSource
stringfraudScore
number<double>
required0 to 100. Higher means riskier. Moov Money stores and
returns the value as Sardine sends it, with no scaling or rounding.
0 when Sardine returns no customer score or when no assessment is
linked to the review.resolvedBy
stringresolutionNotes
stringpayout
objectShow child attributes
review.payout
payoutID
string
requiredreferenceNumber
string
requiredamount
object
requiredShow child attributes
review.payout.amount
value
string
requiredcurrency
object
requiredShow child attributes
review.payout.amount.currency
code
string
requireddecimalPlaces
integer<uint8>
requiredcode. Required.numericCode
stringname
stringmemo
stringstatus
string<enum>
requiredinitiated,
authorized,
accepted,
claiming,
completed,
failed,
payout_failed,
cancelled,
expired,
denieddisplayStatus
string<enum>
requiredstatus and hold.active.pending,
in_progress,
on_hold,
completed,
failed,
declined,
returning,
reversed,
cancelled,
expiredsender
object
requiredShow child attributes
review.payout.sender
participantID
string
requiredexternalID
stringdisplayName
stringstatus
string<enum>suspended shows it.active,
disabled,
pending,
deniedsuspended
booleanfunding
objectShow child attributes
review.payout.sender.funding
fundingType
string<enum>
requiredcard,
bank_accountdisplayName
stringlast4
stringcard, or of the bank account number for bank_account. Omitted when unknown. At most 4 characters.providerSourceID
stringproviderSourceID you registered for this funding source. Present
only when the instrument is a registered funding source of your
participant. Omitted for a payout that sent a provider source token
with no registered funding source.createdOn
string<date-time>providerSourceID is omitted.disabledOn
string<date-time>providerSourceID is omitted.recipient
object
requiredShow child attributes
review.payout.recipient
displayName
stringphoneNumber
stringparticipantID
stringexternalID
stringfunding
objectShow child attributes
review.payout.recipient.funding
fundingType
string<enum>
requiredcard,
bank_accountdisplayName
stringlast4
stringcard, or of the bank account number for bank_account. Omitted when unknown. At most 4 characters.providerSourceID
stringproviderSourceID you registered for this funding source. Present
only when the instrument is a registered funding source of your
participant. Omitted for a payout that sent a provider source token
with no registered funding source.createdOn
string<date-time>providerSourceID is omitted.disabledOn
string<date-time>providerSourceID is omitted.hold
object
requiredShow child attributes
review.payout.hold
active
boolean
requiredexpiresOn
string<date-time>active is false, and when any
blocking review has no expiry.reviewIDs
array<string>
requiredactive is true because another provider’s
review blocks it. Use it to open the review behind the hold.reviewIDs
array<string>
requiredassessmentIDs
array<string>
requiredfundedFrom
objectShow child attributes
review.payout.fundedFrom
fundingType
string<enum>
requiredaft,
core_ledger,
unknownreference
stringoperations
array<object>
requiredShow child attributes
review.payout.operations[]
operationID
string
requiredtype
string<enum>
requiredcollect,
authorize,
capture,
release,
disburse,
refundrail
string<enum>
requiredaft,
oct,
core_hold,
core_creditstatus
string<enum>
requiredreserved,
pending,
succeeded,
failed,
unknownoccurredOn
string<date-time>
requiredsucceeded and failed, otherwise the time of the latest recorded
change.externalReference
stringaft or
oct operation, or the hold, release, capture, or credit reference that
your ledger returned for a core_hold or core_credit operation. rail
identifies the kind. A ledger reference is not a transfer ID. Omitted
until the rail returns one.failureCode
stringstatus is failed, and while Moov Money retries the call. Omitted when
no failure was recorded. Treat an unknown value as opaque.createdOn
string<date-time>
requiredexpiresOn
string<date-time>
requiredtermsAcceptedOn
string<date-time>claimedOn
string<date-time>completedOn
string<date-time>request
objectShow child attributes
review.request
requestID
string
requiredamount
object
requiredShow child attributes
review.request.amount
value
string
requiredcurrency
object
requiredShow child attributes
review.request.amount.currency
code
string
requireddecimalPlaces
integer<uint8>
requiredcode. Required.numericCode
stringname
stringstatus
string<enum>
requiredcreated,
authenticated,
declined,
cancelled,
expired,
paying,
funded,
disbursing,
disbursement_failed,
completed,
reversing,
reversal_failed,
reversed,
deniedmemo
stringexpiresOn
string<date-time>
requiredcreatedOn
string<date-time>
requiredcreatedOn
string<date-time>
requiredholdExpiresOn
string<date-time>resolvedOn
string<date-time>assessmentScore
number<double>fraudScore stays 0 when
no legacy score was recorded.assessmentLevel
string<enum>low. Present whenever assessmentScore is present. Omitted
when no level was recorded, for example when the risk check was
unavailable.low,
medium,
high,
very_highassessmentDecision
string<enum>allow,
review,
denyassessmentReasons
array<string>flaggedParticipantID
stringflaggedRole
string<enum>sender,
requester,
payerresolvedByDisplay
objectresolvedBy still identifies that actor.Show child attributes
review.resolvedByDisplay
kind
string<enum>
requireduser,
application,
systemdisplayName
string
requireduser actor uses the name recorded when
they acted. An application actor uses the fixed label
API application. A system actor uses the fixed label Moov Money.stringinitiator
objectShow child attributes
review.initiator
participantID
string
requiredexternalID
stringdisplayName
stringstatus
string<enum>suspended shows it.active,
disabled,
pending,
deniedsuspended
booleanfunding
objectShow child attributes
review.initiator.funding
fundingType
string<enum>
requiredcard,
bank_accountdisplayName
stringlast4
stringcard, or of the bank account number for bank_account. Omitted when unknown. At most 4 characters.providerSourceID
stringproviderSourceID you registered for this funding source. Present
only when the instrument is a registered funding source of your
participant. Omitted for a payout that sent a provider source token
with no registered funding source.createdOn
string<date-time>providerSourceID is omitted.disabledOn
string<date-time>providerSourceID is omitted.counterparty
objectinitiator applies. Fields that are unbound or
not known are omitted. Omitted when no counterparty is recorded.Show child attributes
review.counterparty
displayName
stringphoneNumber
stringparticipantID
stringexternalID
stringfunding
objectShow child attributes
review.counterparty.funding
fundingType
string<enum>
requiredcard,
bank_accountdisplayName
stringlast4
stringcard, or of the bank account number for bank_account. Omitted when unknown. At most 4 characters.providerSourceID
stringproviderSourceID you registered for this funding source. Present
only when the instrument is a registered funding source of your
participant. Omitted for a payout that sent a provider source token
with no registered funding source.createdOn
string<date-time>providerSourceID is omitted.disabledOn
string<date-time>providerSourceID is omitted.assigneeUserID
stringassigneeDisplay
objectassigneeUserID still identifies the assignee.Show child attributes
review.assigneeDisplay
kind
string<enum>
requireduser,
application,
systemdisplayName
string
requireduser actor uses the name recorded when
they acted. An application actor uses the fixed label
API application. A system actor uses the fixed label Moov Money.string