Payout Report
Download a Payout Report
Getting Started
Charge
Capabilities
Subaccount
Banking
Payout Report
Download a Payout Report
Download the actual Payout Report once the creation succeeded with this endpoint.
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
Body
application/json
Response
200
application/json
Returns the data based on the requested format.
JSON formatted payout report (returned when format=json)
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>"
}
]
}
]
}