Skip to main content
POST
JavaScript

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
id
string<uuid>
required

The ID of the deposit

Response

200 - application/json

Deposit retrieved successfully

id
string<uuid>
required

The ID of the deposit

status
enum<string>
required

The status of the deposit

Available options:
received
amount
number
required

The amount of the deposit

transactionId
string<uuid>
required

The ID of the transaction that initiated the deposit

currency
enum<string>
required

The currency of the deposit

Available options:
EUR,
GBP,
PLN,
SEK,
DKK,
USD,
USDC,
BTC,
ETH,
SOL,
POL
receivedAt
string<date-time>
required

The date and time the deposit was received

payer
object
required

The payer account identifier

payee
object
required

The payee account identifier

returns
object[]
required
bankStatementReference
string

The reference that appears on the bank statement

rail
enum<string>

The payment rail or blockchain used for the deposit

Available options:
sepa_instant,
faster_payments,
sepa,
elixir,
express_elixir,
sek_account_to_account,
sumclearing,
straksclearing,
swift,
internal,
target,
ach,
fedwire,
BTC,
BTC-TESTNET4,
ETH,
ETH-SEPOLIA,
SOL,
SOL-DEVNET,
MATIC,
MATIC-AMOY
txHash
string

The transaction hash for crypto deposits