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 payouts = await client.payouts.list();
console.log(payouts.count);{
"items": [
{
"id": "<string>",
"type": "beneficiary",
"destination": {
"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>",
"blockchain": "ETH"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"metadata": {},
"paymentReference": "<string>",
"transactionId": "<string>",
"failure": {
"code": "account_closed",
"message": "<string>",
"retry": true
}
}
],
"skip": 123,
"count": 123,
"hasNext": true
}List payouts for a merchant.
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 payouts = await client.payouts.list();
console.log(payouts.count);{
"items": [
{
"id": "<string>",
"type": "beneficiary",
"destination": {
"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>",
"blockchain": "ETH"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"metadata": {},
"paymentReference": "<string>",
"transactionId": "<string>",
"failure": {
"code": "account_closed",
"message": "<string>",
"retry": true
}
}
],
"skip": 123,
"count": 123,
"hasNext": true
}API key for authentication
Was this page helpful?