import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: 'My API Key',
});
const payout = await client.payouts.retrieve({ id: 'id' });
console.log(payout.id);
{
"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>"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"metadata": {},
"createdAt": "<any>",
"updatedAt": "<any>",
"paymentReference": "<string>"
}
Retrieve a payout object by id.
import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: 'My API Key',
});
const payout = await client.payouts.retrieve({ id: 'id' });
console.log(payout.id);
{
"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>"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"metadata": {},
"createdAt": "<any>",
"updatedAt": "<any>",
"paymentReference": "<string>"
}
API key for authentication
Retrieve a payout
The response is of type object
.
Was this page helpful?