Pay sandbox request
Pay a sandbox request for payment as the participant in the body, using the payment method the sandbox card token created. The call runs the payer pay flow and returns the pay-attempt outcome.
A committed retry returns the stored result at its original status, even
after the payment resolves. To observe the payment’s current lifecycle
status, list the participant’s payments with
GET /providers/{providerID}/participants/{participantID}/payments.
Returns 200 with outcome: pending, outcome: completed, or
outcome: failed.
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 or the payment method does not belong to the participant.
Sandbox fraud fixtures. The sandbox fraud provider applies the fixture
catalog documented on the payout claim route
(POST /providers/{providerID}/sandbox/payouts/{payoutID}/claims).
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}/payments \
-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",
"paymentMethodID": "pm_01HF5J9ZKQT4RXP8M2VYBN3D"
}'{
"payment": {
"authorizationCode": "AUTH123",
"createdOn": "2026-10-19T15:00:00Z",
"denialReason": "denied_payer",
"failureReason": "issuer_decline",
"institutionName": "Example Bank",
"outcome": "pending",
"paymentMethod": "Visa 1234",
"paymentMethodType": "pull-from-card",
"transferID": "aft-transfer-id"
}
}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 payment ID or a changed request body, or when an identical request
with the same key is still active. A committed retry returns the original
attempt at its original status instead.Response body application/problem+json
type is
https://api.moov.money/errors#idempotency-key-reused when the key was
replayed with a changed payment ID or a changed request body, or
https://api.moov.money/errors#idempotency-request-in-progress when an
identical request with the same key is still active.detail
stringtype
string<enum>
requiredhttps://api.moov.money/errors#idempotency-key-reused,
https://api.moov.money/errors#idempotency-request-in-progresstitle
string
requiredstatus
integer<int32>
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.X-Idempotency-Key
string
requiredPath parameters
providerID
string
requiredrequestID
string
requiredRequest
participantID from the payment method in
paymentMethodID.participantID
string
requiredpaymentMethodID
string
requiredpaymentMethodID.Response
payment.payment
object
requiredShow child attributes
payment
transferID
stringoutcome
string<enum>
requiredpending,
completed,
failedfailureReason
stringdenialReason
stringpaymentMethod
stringpaymentMethodType
stringinstitutionName
stringauthorizationCode
stringcreatedOn
string<date-time>
required