FIfinix
Microdeposits

List Microdeposits

Changed on

Retrieve a list of Microdeposit resources. Filter by payment_instrument_id to find microdeposits for a specific Payment Instrument.

get/microdeposits

Request

Query parameters

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

limitinteger
Example:10

The numbers of items to return.

payment_instrument_idstring
Example:PIcgYZswyRfqSSbvMsxuaHxZ

Filter by Payment Instrument ID.

Headers

Finix-Versionstring
Example:2022-02-01

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

Response

List of Microdeposit resources

Example response

{
  "_embedded": {
    "microdeposits": [
      {
        "id": "microdeposit_8cFbWq5n2KjXcVbtQkC1U1",
        "instrument": "PIkfiTDWYhQ4VbtQkC1U1ceJ",
        "rail": "RTP",
        "verification_attempts": 1,
        "verification_attempts_remaining": 2
      }
    ]
  }
}

Changes