Invoices

The API documentation for the Cryptocurrency Invoicing Service. This API enables users on your platform to create, view, and manage cryptocurrency invoices.

Base URL

https://api.payhubix.com/payment/public/v1/

Authentication

To interact with the API, users need to authenticate using an API key or token.

Key API Endpoints

  1. Create a New Invoice

    • Endpoint: POST /invoices/

    • Description: This endpoint allows users to create a new invoice. It requires certain details like the amount, currency type, and payment time.

    • Use Case: When a shop or individual wants to issue an invoice for a cryptocurrency payment.

  2. List All Invoices

    • Endpoint: GET /invoices/

    • Description: Retrieves a list of all the invoices associated with the user's account. Supports pagination and filtering options to manage the data effectively.

    • Use Case: When a user wants to review all generated invoices or filter them based on specific criteria (e.g., date, status).

  3. Get Invoice Details

    • Endpoint: GET /invoices/:link/

    • Description: Fetches detailed information for a specific invoice using the unique link parameter provided when the invoice was created.

    • Use Case: When a user wants to check the status, details, and payment information of a specific invoice.

Use Case

This API is specifically designed for cryptocurrency-related payment systems where users can:

  • Create invoices for cryptocurrency payments.

  • View a list of generated invoices for tracking purposes.

  • Retrieve detailed information about individual invoices, including status and payment confirmation.

Last updated