FIfinix
Microdeposits

Fetch a Microdeposit

Changed on

Retrieve the details of a Microdeposit to check the verification's status, remaining submission tries, and expiration.

get/microdeposits/{microdeposit_id}

Request

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

A single Microdeposit

idstring

The ID of the Microdeposit resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

applicationstring

ID of the Application the resource was created under.

currency'CAD' | 'USD'

ISO 4217 3-letter currency code.

expires_atstring date-time

The timestamp indicating when the 30-day verification window closes. A microdeposit that isn't verified by this time expires.

failure_code'INVALID_BANK_ACCOUNT_ROUTING_NUMBER' | 'MICRODEPOSIT_RETURNED' | 'MICRODEPOSIT_VERIFICATION_ATTEMPTS_EXCEEDED' | 'MICRODEPOSIT_VERIFICATION_EXPIRED' | 'TOTAL_MICRODEPOSIT_ATTEMPTS_EXCEEDED_ACCOUNT_LOCKED' nullable

Details why the verification failed. Returns null unless state is FAILED.

failure_messagestring nullable

Details why the verification failed.

instrumentstring

The ID of the bank account Payment Instrument being verified.

railstring

The payment rail Finix used to send the $0.01 microdeposit.

state'PENDING' | 'VERIFIED' | 'FAILED'

The state of the Microdeposit.

verification_attemptsinteger

The number of code submission tries used so far.

verification_attempts_remaininginteger

The number of code submission tries left for this microdeposit. Returns 0 once the verification has failed.

Example response

{
  "id": "microdeposit_8cFbWq5n2KjXcVbtQkC1U1",
  "instrument": "PIkfiTDWYhQ4VbtQkC1U1ceJ",
  "rail": "RTP",
  "verification_attempts": 1,
  "verification_attempts_remaining": 2
}

Changes