POST
/
api
/
service
/
beneficiary-payout
/
create
Performs a Merchant Payout on all supported currencies
curl --request POST \
  --url https://api.sand.getivy.de/api/service/beneficiary-payout/create \
  --header 'X-Ivy-Api-Key: <api-key>'
[
  {
    "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

Returns Payouts

Array of payout objects