Simulate funding instrument status

Simulate funding instrument status completes a microdeposit check in the sandbox. A microdeposit, sometimes called a penny drop, verifies a linked bank account without a live bank transfer.

Use this request when you need to:

• Test microdeposit verification.
• Activate a funding instrument.
• Confirm both a successful verification and a failed one.

For the wider sandbox approach, see Testing Nium. For how funding instruments are created, see Direct Debit.

important

This request works in the sandbox only.

Endpoint

POST /api/v1/simulations/client/{clientHashId}/customer/{customerHashId}/fundingInstruments/{fundingInstrumentId}/updateStatus

Simulate Funding Instrument Status Update marks the microdeposit as successful or reversed.

Path parameters

Parameter	Required	Description
clientHashId	Yes	Client identifier
customerHashId	Yes	Customer identifier
fundingInstrumentId	Yes	Funding instrument created for the customer

Headers

Header	Required	Description
Content-Type	Yes	application/json
X-Api-Key	Yes	Your API key

Request body

{
  "action": "MICRODEPOSIT_SUCCESSFUL"
}

Value	Result
MICRODEPOSIT_SUCCESSFUL	Verification succeeds
MICRODEPOSIT_REVERSED	Verification fails

Response

A successful call returns HTTP 200 and an empty body.

Status	Meaning
400	The request is invalid
401	The API key is missing or invalid
403	The caller does not have permission
404	The funding instrument was not found
500	The server could not complete the request

Test a microdeposit

1. Create a funding instrument with Add Funding Instrument.
2. Open the redirect URL and complete the Plaid link flow with the manual option.
3. Call this simulation API with MICRODEPOSIT_SUCCESSFUL or MICRODEPOSIT_REVERSED.
4. Call Get Funding Instrument Details and confirm the status description is paid after a successful microdeposit.