Get Payment Metrics
GET /payments/metrics
Description
Retrieve metrics related to payments.
Path Parameters
| Name | Type | Description |
|---|---|---|
| None | No parameters |
Example
GET /payments/metrics
Accept: application/json
Response Code: 200 - OK
Description
Successful retrieval of payment metrics.
Response Fields
| Field | Type | Description |
|---|---|---|
status | boolean | Indicates if the operation was successful |
statusCode | integer | Status code |
message | string | Response message |
data | object | Data related to the payment metrics |
errors | array | List of error messages, if any |
Example
{
"status": true,
"statusCode": 0,
"message": "Payment metrics retrieved successfully",
"data": {},
"errors": [
{
"message": "Some error occurred",
"descriptiveMessage": "Detailed error message"
}
]
}
Headers
| Accept | Value |
|---|---|
| Content-Type | application/json |
LANGUAGE
CURL REQUEST
curl --request GET \
--url /payments/metrics \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!