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

id
string
required

The unique identifier of the beneficiary payout

type
enum<string>
required

The type of payout

Available options:
merchant,
customer
referenceId
string
required

The reference identifier for the payout

merchant
string
required

The merchant identifier

amount
number
required

The beneficiary payout amount

description
string
required

Description of the payout

statementDescriptor
string
required

The descriptor that appears on bank statements

status
enum<string>
required

The current status of the payout

Available options:
paid,
pending,
in_transit,
failed,
canceled
currency
enum<string>
required

The currency of the balance which was settled to the beneficiary bank account or wallet.

Available options:
EUR,
GBP,
PLN,
SEK,
DKK
createdAt
any
required

The creation timestamp of the payout