Decline sandbox request
Decline a sandbox request for payment as the participant in the body. The call runs the payer decline flow and returns the committed decline.
Normal decline eligibility applies. An open request can be declined. A
request that is already closed, such as a paid or cancelled request,
returns 409 with problem type state-conflict. A committed retry returns
the stored result at its original status. Returns 200 with the declined
request.
Send X-Idempotency-Key to identify the attempt. Replaying the key with a
changed request ID or a changed request body returns 409 with problem type
idempotency-key-reused; an identical request that is still active
returns 409 with problem type idempotency-request-in-progress. The
reservation covers the authenticated caller account, the target provider,
and this action. Both problems use application/problem+json.
Returns 400 when the body is malformed or the key is missing. Returns 401 when your credentials are missing or invalid. Returns 403 when the target is a production provider. Returns 404 when the request is not found or belongs to another provider, or when the participant does not belong to the provider.
Auth: API key or bearer token. Application callers must use an application
credential authorized for the provider in the path. An affiliated
integrator needs the /accounts/{providerID}/moov-money-participants.write
and /accounts/{providerID}/transfers.write grants from the FI.
curl -X POST https://api.moov.money/providers/{providerID}/sandbox/requests/{requestID}/declines \
-u "$MOOV_API_KEY_ID:$MOOV_API_KEY_SECRET" \
-H "X-Moov-Version: v2026.10.00" \
-H "X-Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"participantID": "3v2whagmwvbujhwbt7v3nl6ffq_user"
}'{
"request": {
"requestID": "01HF5J9ZKQT4RXP8M2VYBN3D_req",
"status": "declined"
}
}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
requiredX-Idempotency-Key was
replayed with a changed request ID or a changed request body, an identical
request with the same key is still active, or the request is not in a
declinable state, such as an already-closed request. A committed retry
returns the original attempt at its original status instead.Retry-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.X-Idempotency-Key
string
requiredPath parameters
providerID
string
requiredrequestID
string
requiredRequest
participantID.participantID
string
requiredResponse
request.request
object
requiredShow child attributes
request
requestID
string
requiredstatus
string<enum>
requireddeclined.declined