POST
/
api
/
service
/
beneficiary-payout
/
create
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: 'My API Key',
});

const beneficiaryPayouts = await client.beneficiaryPayouts.create();

console.log(beneficiaryPayouts);
[
  {
    "id": "<string>",
    "type": "merchant",
    "referenceId": "<string>",
    "merchant": "<string>",
    "amount": 123,
    "description": "<string>",
    "statementDescriptor": "<string>",
    "status": "paid",
    "currency": "EUR",
    "createdAt": "<any>"
  }
]

Authorizations

​
X-Ivy-Api-Key
string
header
required

API key for authentication

Response

200 - application/json

Succeeded Beneficiary Payouts of available balances

Array of Beneficiary Payouts