Skip to main content
GET
/
customers
/
{id}
/
microdeposits
Get customer microdeposits
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers/{id}/microdeposits \
  --header 'X-API-Key: <api-key>'
[
  {
    "amount": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "currency_code": "<string>",
    "counterparty_name": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.iron.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner

Path Parameters

​
id
string<uuid>
required

the ID of the Customer to GET microdeposits for

Response

GET Microdeposits Succeeded

​
amount
string<decimal>
required

Amount of the microdeposit

​
created_at
string<date-time>
required

When the microdeposit was created

​
currency_code
string
required

Currency code of the microdeposit

​
counterparty_name
string

Name of the counterparty