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>"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"metadata": {},
"paymentReference": "<string>",
"transactionId": "<string>"
}
],
"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>"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"metadata": {},
"paymentReference": "<string>",
"transactionId": "<string>"
}
],
"skip": 123,
"count": 123,
"hasNext": true
}API key for authentication
List payouts
Show child attributes
The payout ID
The payout type
beneficiary, customer The payout destination
Show child attributes
iban, sort_code, bank_code, bban, wallet The payout status
paid, pending, in_transit, failed, canceled The payout amount
The payout currency
EUR, GBP, PLN, SEK, DKK The payout created at
The payout updated at
The payout payment reference
The payout transaction ID
Was this page helpful?