POST
/
api
/
service
/
merchant
/
payout
/
export
/
download
curl --request POST \
  --url https://api.sand.getivy.de/api/service/merchant/payout/export/download \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '{
  "reportId": "<string>",
  "format": "csv"
}'
{
  "payouts": [
    {
      "id": "<string>",
      "merchantAppId": "<string>",
      "amount": 123,
      "availableAt": "<string>",
      "transactions": [
        {
          "orderId": "<string>",
          "gross": 123,
          "fee": 123,
          "net": 123,
          "currency": "EUR",
          "reportingCategory": "<string>",
          "description": "<string>",
          "billingFullName": "<string>",
          "userMail": "<string>",
          "createdAt": "<string>",
          "referenceId": "<string>",
          "displayId": "<string>",
          "subaccountId": "<string>"
        }
      ]
    }
  ]
}

Authorizations

​
X-Ivy-Api-Key
string
header
required

Body

application/json
​
reportId
string
required

The unique identifier of the report you want to download. This was returned when creating a new Payout Report.

​
format
enum<string>
default:
csv

The format in which you want to download the report. Default is csv.

Available options:
csv,
json,
datev

Response

200
application/json
Returns the data based on the requested format.

JSON formatted payout report (returned when format=json)

​
payouts
object[]
required
Create a Payout ReportRetrieve a Payout Report status