import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: 'My API Key',
});
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>"
}
},
"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>"
}
},
"bankStatementReference": "<string>",
"rail": "<string>",
"returns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "initiated",
"amount": 123,
"currency": "EUR",
"createdAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"succeededAt": "2023-11-07T05:31:56Z"
}
]
}
Retrieves a deposit by its ID.
import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: 'My API Key',
});
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>"
}
},
"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>"
}
},
"bankStatementReference": "<string>",
"rail": "<string>",
"returns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "initiated",
"amount": 123,
"currency": "EUR",
"createdAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"succeededAt": "2023-11-07T05:31:56Z"
}
]
}
API key for authentication
Deposit retrieved successfully
The response is of type object
.
Was this page helpful?