Get Platform Settlement Report

Fetch settlement details for a merchant's payout

SecurityLimepay-Token

Request

path Parameters

merchantId required	string
payoutId required	string

Responses

200

400

401

403

404

405

406

409

422

429

500

503

get/marketplaces/merchants/{merchantId}/payouts/{payoutId}/settlements

Request samples

Curl
JavaScript

Response samples

application/json

{"currency": "AUD",
"items": [{"entryDate": "2019-08-24",
"entryTimestamp": "2019-08-24T14:15:22Z",
"entryType": "Payment",
"entryDescription": "string",
"settlementDate": "2019-08-24",
"transactionType": "string",
"orderType": "online",
"orderId": "string",
"orderDescription": "string",
"orderMetadata": { },
"merchantOrderId": "ordr_Zz_kZlxhogfJCMgM",
"merchantId": "mcht_Zz_kZlxhogfJCMgI",
"merchantName": "string",
"transactionId": "tran_Zz_kZlxhogfJCMgL",
"transactionAmount": 0,
"refundId": "rfnd_Zz_kaFxhogfJCMgb",
"payoutId": "payout_Zz_kZ1xhogfJCMgV",
"currency": "AUD",
"netAmount": 0,
"grossAmount": 0,
"platformFeesInclTax": 0,
"platformFeesTax": 0,
"customFieldValues": {"property1": "string",
"property2": "string"
}
}
],
"totalPages": 0,
"totalRecords": 0,
"platformFeesInclTax": 0,
"platformFeesTax": 0,
"netAmount": 0,
"grossAmount": 0,
"payoutSummary": {"payoutId": "payout_Zz_kZ1xhogfJCMgV",
"currency": "AUD",
"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"paidOn": "2019-08-24",
"status": "paid",
"settlementType": "Net",
"failureReason": "string",
"openingBalance": 0,
"closingBalance": 0,
"payoutAmount": 0
},
"created": "2019-08-24T14:15:22Z"
}