INVOICE DETAIL

Invoice Detail API Endpoints

Complete documentation for all Invoice Detail related endpoints.

GET

Invoice Detail

Get the full detail of one of your invoices, including its payment attempts and balance-payment info.

Endpoint Details

HTTP Request

GET https://0xhost.com/API/invoices/detail

Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Invoice / order UUID

Authentication

API Key Required in header

Headers

Header	Value	Required	Description
`x-api-key`	`your_api_key_here`	Yes	Your unique API key for authentication
`Content-Type`	`application/json`	Optional	Recommended for consistent response handling

Response Fields

Field	Type	Description
`success`	boolean	Indicates if the operation was successful
`message`	string	Response message describing the result
`data`	object/array	Contains the response data

Success Response

API Response Example

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "id": "demo_id_123",
    "updated_at": "2025-01-15 10:30:00"
  }
}

Code Examples

Programming Languages

JavaScript (Fetch API)

async function makeRequest() {
  try {
    const response = await fetch('https://0xhost.com/API/invoices/detail?id=inv12345-6789-0123-4567-890123456789', {
      method: 'GET',
      headers: {
        'x-api-key': 'your_api_key_here',
        'Content-Type': 'application/json'
      }
    });

    const data = await response.json();
    console.log('Response:', data);
    return data;
  } catch (error) {
    console.error('Error:', error);
  }
}

Python (Requests)

import requests

def make_request(api_key):
    url = 'https://0xhost.com/API/invoices/detail?id=inv12345-6789-0123-4567-890123456789'
    headers = {
        'x-api-key': api_key,
        'Content-Type': 'application/json'
    }

    response = requests.get(url, headers=headers)

    if response.status_code == 200:
        return response.json()
    else:
        print(f'Error: {response.status_code}')
        return None

PHP (cURL)

function makeRequest($apiKey) {
    $url = 'https://0xhost.com/API/invoices/detail?id=inv12345-6789-0123-4567-890123456789';

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'x-api-key: ' . $apiKey,
        'Content-Type: application/json'
    ]);

    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    return json_decode($response, true);
}

cURL Command

curl -X GET \
  'https://0xhost.com/API/invoices/detail?id=inv12345-6789-0123-4567-890123456789' \
  -H 'x-api-key: your_api_key_here' \
  -H 'Content-Type: application/json'

0xHost API