Paytrie Developer Documentation
API ReferenceApi credits

Get Api Credits

Retrieve API credits information including fee credits spent and remaining for the authenticated integrator

GET
/apiCredits

Authorization

ApiKeyAuth
x-api-key<token>

API key

In: header

Query Parameters

endDate?string
startDate?string

Response Body

application/json

curl -X GET "https://api.paytrie.com/apiCredits"
{
  "data": {
    "feeCreditsRemaining": 1000,
    "feeCreditsSpent": 500,
    "period": {
      "endDate": "2024-01-31",
      "startDate": "2024-01-01"
    },
    "sponsoredCompleteTransactions": 20,
    "totalCompleteTransactions": 25
  },
  "message": "API credits retrieved successfully",
  "status": "success"
}
Empty