premiumpay API for data (1.0.0)

Return the current version of the API

Return the status of the server and the rate limit of the user

Retrieve sales data for a period. The request must include the start_date_time and end_date_time parameters and the pasarela_id parameter (gateway id). The service_id parameter is optional. If the service_id parameter is included, the request will return the sales of the service. If the service_id parameter is not included, the request will return the sales of all the services belonging the gateway.

Retrieve list of gateways. The request must include the include_services parameter. If the include_services parameter is 'yes', the request will return the services of the gateway. If the include_services parameter is not included or have another value, the request will return the gateways without services list.

Retrieve aggregated sales data for a period. The request must include the start_date_time and end_date_time parameters and the aggregate_field parameter. The aggregate_field parameter can be 'country', 'payment_method' or 'service'.

Retrieve list of channels. The request can include the include_links parameter to return channel links. Additionally, you can filter channels by specific link names or exclude channels that have the specified link names. If include_links is 'yes', the response will include channel links. If exclude_link_names is 'yes' and link_names is provided, it will return channels that do NOT have the specified link names. You can also specify which fields to include in the response for both channels and links using channel_fields and link_fields. The consolidate_links parameter allows you to consolidate link data in the response.

Retrieve list of channel results. The request must include the start_date_time and end_date_time parameters and the channel_id parameter. The invitation_link parameter is optional. If the invitation_link parameter is included, the request will return the results of the invitation link. If the invitation_link parameter is not included, the request will return the results of the channel.

Retrieve sales data of a channel. The request must include the start_date_time and end_date_time parameters and the channel_id parameter. The invitation_link parameter is optional. If the invitation_link parameter is included, the request will return the sales of the invitation link. If the invitation_link parameter is not included, the request will return the sales of all the invitation links of the channel.

Create a public link for a channel. The request must include the channel_id parameter and optionally the duration_hours, requires_approval and auto_approval parameters. The request will return the public link created.

Create a personal welcome message for a channel. The request must include the channel_id and message parameters and optionally the invite_link, button, welcome_url and button_callback parameters.