Skip to main content

Get Payment Methods Summary

By calling this API, you can retrieve the summary of the payment methods that being used in the specified MokaPOS outlet.

POST /integrations/mokapos/outlets/{outlet_id}/v1/reporting/payment-methods

Path Parameters

AttributeDescriptionTypeRequired
outlet_idID of a MokaPOS businessStringRequired

Sample Request

curl -X POST /integrations/mokapos/outlets/{outlet_id}/v1/reporting/payment-methods \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d $'
{
"query": {
"range": {
"transaction_time": {
"gte": "2020-01-01T00:00:00+07:00",
"lte": "2020-01-30T23:59:59+07:00"
}
}
}
}
'

Sample Response - 200 Success

{
"success": true,
"data": {
"total_number_of_transactions": 5,
"total_collected": 5458000,
"reports": [
{
"Invoice": [
{
"payment_type": "Invoice",
"number_of_transactions": 5,
"collected": 5458000
}
]
}
]
}
}
note

To perform this operation, you must be authenticated using go_auth_client_credentials(mokapos:reporting:read).