The recharge_history
endpoint allows you to query the history of recharge transactions for an organization. It includes details such as the recharge amount, bonus amount, payment method, transaction ID, and creation time. This endpoint supports pagination to efficiently navigate through historical records.
To retrieve recharge history, send a GET
request to the following URL:
GET https://api.genaifactory.ai/v1/recharge_history
Ensure that your request includes the following header:
Name
Type
Required
Description
formacloud-api-key
string
Yes
API key required for authenticating your request.
You can use the following query parameters to specify the time period, pagination, and other details for retrieving the recharge history:
Name
Type
Required
Description
start
string
No
The start date of the history retrieval period in UTC (e.g., 2023-01-01T00:00:00Z
).
end
string
No
The end date of the history retrieval period in UTC (e.g., 2023-01-31T23:59:59Z
).
page_size
int
No
The maximum number of records to retrieve per page (default: 10).
page
int
No
The page number to retrieve (default: 0).
The response will include a list of recharge records and pagination details. Each recharge record contains the following information:
Name
Type
Required
Description
recharge_id
int
Yes
The unique identifier of the recharge record.
recharge_amount
decimal
Yes
The amount of money recharged.
bonus_amount
decimal
No
The bonus amount received during the recharge.
payment_method
string
No
The payment method used for the recharge (e.g., Credit Card
).
transaction_id
string
Yes
The unique transaction ID for the recharge.
note
string
No
Additional notes about the recharge.
recharge_time
string
Yes
The time when the recharge occurred, in UTC.
Success Response (Status Code 200)
Failure Response (Status Code 4XX)