Skip to main content
POST
/
api
/
service
/
deposit
/
retrieve
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const deposit = await client.deposits.retrieve({ id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

console.log(deposit.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "received",
  "amount": 123,
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "EUR",
  "receivedAt": "2023-11-07T05:31:56Z",
  "payer": {
    "type": "iban",
    "iban": {
      "accountHolderName": "<string>",
      "iban": "<string>",
      "bic": "<string>"
    },
    "sortCode": {
      "accountHolderName": "<string>",
      "sortCode": "<string>",
      "accountNumber": "<string>"
    },
    "bankCode": {
      "accountHolderName": "<string>",
      "code": "<string>",
      "accountNumber": "<string>"
    },
    "bban": {
      "accountHolderName": "<string>",
      "bban": "<string>",
      "bic": "<string>"
    },
    "wallet": {
      "address": "<string>"
    }
  },
  "payee": {
    "type": "iban",
    "iban": {
      "accountHolderName": "<string>",
      "iban": "<string>",
      "bic": "<string>"
    },
    "sortCode": {
      "accountHolderName": "<string>",
      "sortCode": "<string>",
      "accountNumber": "<string>"
    },
    "bankCode": {
      "accountHolderName": "<string>",
      "code": "<string>",
      "accountNumber": "<string>"
    },
    "bban": {
      "accountHolderName": "<string>",
      "bban": "<string>",
      "bic": "<string>"
    },
    "wallet": {
      "address": "<string>"
    }
  },
  "returns": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "initiated",
      "amount": 123,
      "currency": "EUR",
      "createdAt": "2023-11-07T05:31:56Z",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "failedAt": "2023-11-07T05:31:56Z",
      "succeededAt": "2023-11-07T05:31:56Z"
    }
  ],
  "bankStatementReference": "<string>",
  "rail": "sepa_instant",
  "txHash": "<string>"
}

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,
USDC
​
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,
ETH,
ETH-SEPOLIA,
SOL,
SOL-DEVNET,
MATIC,
MATIC-AMOY
​
txHash
string

The transaction hash for crypto deposits