Skip to main content
POST
Retrieve a deposit

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
id
string<uuid>
required

The ID of the deposit

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

200 - application/json

Deposit retrieved successfully

id
string<uuid>
required

The ID of the deposit

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
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

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
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

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
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,
fednow,
rtp,
chips,
BTC,
BTC-TESTNET4,
ETH,
ETH-SEPOLIA,
SOL,
SOL-DEVNET,
MATIC,
MATIC-AMOY
txHash
string

The transaction hash for crypto deposits