Detail Invoice

get detail of invoice

The Detail Invoice endpoint retrieves detailed information about a specific invoice. This includes the invoice's URL, amounts, fees, status, and associated shop and payment details. Use this endpoint to get a comprehensive view of an invoice's current state and its related financial information.

GET https://api.payhubix.com/v1/payment/invoices/INV-LUE9K66Q/

Note: you must insert your invoice link

Request Header:

Name

Type

Description

X-Api-Key*

string

Your API key for authentication and authorization.

Response:

Name

Type

Description

invoice_url*

string

URL to view the invoice.

currency_amount*

float

The original amount for the invoice.

remaining_currency_amount*

float

The remaining unpaid amount.

currency_symbol*

string

The symbol of the currency used (USD, e.g.).

link*

string

Unique identifier for the invoice.

transfer_fee_by*

string

Specifies who covers the transfer fee. Either Customer or Merchant.

service_fee_by*

string

Specifies who covers the service fee. Either Customer or Merchant.

service_fee_percent*

float

The percentage of the service fee.

status*

string

The current status of the invoice (Created, Pending, Paid,Canceled,Partially, PartiallyExpired,Expired).

customer_email

string

Customer's email address that provided by merchant.

manual_customer_email

string

Email address that provided manually by the customer.

created_at*

string

Timestamp of when the invoice was created.

expire_at*

string

Timestamp of when the invoice will expire.

pure_expire_time*

string

Time duration in HH:MM before the invoice expires.

order_id

string

Unique identifier for the order (nullable).

order_description

string

Description of the order (nullable).

shop.name*

string

The name of the shop that issued the invoice.

shop.website

string

The website of the shop (nullable).

shop.shop_id*

string

Unique identifier for the shop.

shop.transfer_fee_by*

string

Who covers the transfer fee for the shop. Either Customer or Merchant.

shop.service_fee_by*

string

Who covers the service fee for the shop. Either Customer or Merchant.

shop.logo_url

string

URL to the logo of the shop (nullable).

currencies[].currency_id*

uint

Unique identifier for the currency.

currencies[].currency_name*

string

Name of the currency (e.g., Bitcoin, Ethereum).

currencies[].currency_status*

string

Status of the currency (Enable or Disable).

currencies[].currency_symbol*

string

The symbol of the currency (e.g., BTC, ETH).

currencies[].currency_type*

string

Type of currency (Fiat or Crypto).

currencies[].currency_icon_url*

string

URL to the currency's icon.

currencies[].network_id*

uint

Unique identifier for the currency network (e.g., Ethereum, Tron).

currencies[].network_symbol*

string

Symbol of the network.

currencies[].network_status*

string

Status of the network (Enable or Disable).

currencies[].network_name*

string

Name of the network (e.g., Ethereum, Tron).

currencies[].network_icon_url*

string

URL to the network's icon.

currencies[].fee_withdraw*

float

Fee for withdrawal in this currency.

currencies[].fee_payment*

float

Fee for payment in this currency.

currencies[].minimum_withdraw*

float

Minimum amount required to withdraw in this currency.

currencies[].precision*

int

Decimal precision for the currency.

currencies[].withdrawable*

bool

Indicates if the currency is withdrawable.

currencies[].paymentable*

bool

Indicates if the currency can be used for payments.

payments

array

Payment details, if available.

selected_payment

object

Details of the selected payment option.

callback_url

string

URL to which the payment result will be sent.

payments[].currency_amount*

float

The original currency amount for the payment.

payments[].remaining_currency_amount*

float

The remaining amount of the currency to be paid.

payments[].transfer_fee

float

Transfer fee, if applicable (nullable).

payments[].service_fee

float

Service fee, if applicable (nullable).

payments[].ratio

float

Exchange rate ratio, if applicable (nullable).

payments[].crypto_amount

float

Original amount of cryptocurrency to be paid.

payments[].final_crypto_amount

float

Final calculated amount of cryptocurrency required.

payments[].received_crypto_amount

float

Amount of cryptocurrency received.

payments[].remaining_crypto_amount

float

Remaining amount of cryptocurrency to be received.

payments[].memo

string

Memo or description for the payment (nullable).

payments[].address

string

Address to which the cryptocurrency should be sent (nullable).

payments[].status*

string

Current status of the payment (Created, Pending, etc.).

payments[].created_at*

string

Timestamp when the payment was created.

payments[].expire_time*

string

Expiration time for the payment.

payments[].pure_expire_time*

string

Expiration duration in HH:MM.

payments[].selected_currency

object

Details of the selected currency.

payments[].transactions

array

List of related payment transactions.

payments[].transactions[].tx_hash*

string

Hash of the transaction on the blockchain.

payments[].transactions[].scaner_link*

string

URL to the transaction on the blockchain explorer (nullable).

An example of response:

{
    "error": false,
    "number": 0,
    "message": [
    {
        "invoice_url": "https://payhubix.com/pay/INV-LUE9K66Q",
        "currency_amount": 1,
        "remaining_currency_amount": 0,
        "currency_symbol": "USD",
        "link": "INV-LUE9K66Q",
        "transfer_fee_by": "Customer",
        "service_fee_by": "Merchant",
        "service_fee_percent": 1,
        "status": "Paid",
        "customer_email": null,
        "manual_customer_email": null,
        "created_at": "2024-09-30 20:58:22.354937 +0000 UTC",
        "expire_at": "2024-09-30 22:58:22.354377 +0000 UTC",
        "pure_expire_time": "02:00",
        "order_id": "#12325425",
        "order_description": "macbook air m3",
        "shop": {
            "name": "Amazon",
            "website": "https://www.amazon.com/",
            "shop_id": "019242e7-d18f-788f-813e-a2c72177e172",
            "transfer_fee_by": "Customer",
            "service_fee_by": "Merchant",
            "logo_url": null
        },
        "currencies": [
            {
                "currency_id": 1,
                "currency_name": "Tron",
                "currency_status": "Enable",
                "currency_symbol": "TRX",
                "currency_type": "Crypto",
                "currency_icon_url": "https://payhubix.com/payhubix/coins_icons/TRX_logo.jpg",
                "slug": "",
                "network_id": 1,
                "network_symbol": "TRX",
                "network_status": "Enable",
                "network_name": "Tron",
                "network_icon_url": "https://payhubix.com/payhubix/network_icons/TRX_logo.jpg",
                "network_scaner_url": "",
                "fee_withdraw": 0,
                "fee_payment": 0,
                "minimum_withdraw": 0,
                "precision": 0,
                "withdrawable": false,
                "paymentable": false,
                "status": "",
                "is_native": false
            }
        ],
         "payments": [
            {
                "currency_amount": 1,
                "remaining_currency_amount": 0.01,
                "transfer_fee": 1,
                "service_fee": 0.066666,
                "ratio": 0.15,
                "crypto_amount": 6.666666,
                "final_crypto_amount": 7.666666,
                "received_crypto_amount": 7.666666,
                "remaining_crypto_amount": 0,
                "memo": "0",
                "address": "TQVnKBjfFZEojxZqi4aTKNQDkmiKDPS6XE",
                "status": "Paid",
                "created_at": "2024-09-30 20:58:34.571817 +0000 UTC",
                "expire_at": "2024-09-30 21:28:34.571263 +0000 UTC",
                "pure_expire_time": "00:30",
                "selected_currency": {
                    "currency_id": 1,
                    "currency_name": "Tron",
                    "currency_status": "Enable",
                    "currency_symbol": "TRX",
                    "currency_type": "Crypto",
                    "precision": 6,
                    "withdrawable": true,
                    "paymentable": true,
                    "status": "Enable",
                    "slug": "tron",
                    "tag": "popular-coins",
                    "currency_icon_url": "https://payhubix.com/payhubix/coins_icons/TRX_logo.jpg",
                    "network_id": 1,
                    "network_symbol": "TRX",
                    "network_status": "Enable",
                    "network_name": "Tron",
                    "network_icon_url": "https://payhubixstorage.darkube.app/payhubix/network_icons/TRX_logo.jpg",
                    "network_scaner_url": "https://tronscan.org/#/transaction/",
                    "fee_withdraw": 2,
                    "fee_payment": 1,
                    "minimum_withdraw": 5,
                    "is_native": true
                },
                "transactions": [
                    {
                        "tx_hash": "b9c090470fdb649b47b9c9102d9cd5001cc4d3b06eaf89c94e14829b2c109089",
                        "scaner_link": "https://tronscan.org/#/transaction/b9c090470fdb649b47b9c9102d9cd5001cc4d3b06eaf89c94e14829b2c109089"
                    }
                ]
            }
        ],
     "selected_payment": {
            "currency_amount": 1,
            "remaining_currency_amount": 0.01,
            "transfer_fee": 1,
            "service_fee": 0.066666,
            "ratio": 0.15,
            "crypto_amount": 6.666666,
            "final_crypto_amount": 7.666666,
            "received_crypto_amount": 7.666666,
            "remaining_crypto_amount": 0,
            "memo": "0",
            "address": "TQVnKBjfFZEojxZqi4aTKNQDkmiKDPS6XE",
            "status": "Paid",
            "created_at": "2024-09-30 20:58:34.571817 +0000 UTC",
            "expire_at": "2024-09-30 21:28:34.571263 +0000 UTC",
            "pure_expire_time": "00:30",
            "selected_currency": {
                "currency_id": 1,
                "currency_name": "Tron",
                "currency_status": "Enable",
                "currency_symbol": "TRX",
                "currency_type": "Crypto",
                "precision": 6,
                "withdrawable": true,
                "paymentable": true,
                "status": "Enable",
                "slug": "tron",
                "tag": "popular-coins",
                "currency_icon_url": "https://payhubix.com/payhubix/coins_icons/TRX_logo.jpg",
                "network_id": 1,
                "network_symbol": "TRX",
                "network_status": "Enable",
                "network_name": "Tron",
                "network_icon_url": "https://payhubix.com/payhubix/network_icons/TRX_logo.jpg",
                "network_scaner_url": "https://tronscan.org/#/transaction/",
                "fee_withdraw": 2,
                "fee_payment": 1,
                "minimum_withdraw": 5,
                "is_native": true
            },
            "transactions": null
        },
        "callback_url": "https://example.com/callback"
        }
    [
}

{
    "error": true,
    "number": 401,
    "message": "Unauthorized access to api"
}

{
    "error": true,
    "number": 403,
    "message": "You don't have permission to access this resource."
}

{
    "error": true,
    "number": 500,
    "message": "Oops! Something went wrong on our end."
}

Example codes:

curl --location 'https://api.payhubix.com/v1/payment/invoices/INV-LUE9K66Q/' \
--header 'X-Api-Key: YOUR_API_KEY'

import requests

headers = {
    'X-Api-Key': 'YOUR_API_KEY',
}

response = requests.get('https://api.payhubix.com/v1/payment/invoices/INV-LUE9K66Q/', headers=headers)

import axios from 'axios';

const response = await axios.get('https://api.payhubix.com/v1/payment/invoices/INV-LUE9K66Q/', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY'
  }
});

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->get('https://api.payhubix.com/v1/payment/invoices/INV-LUE9K66Q/', [
    'headers' => [
        'X-Api-Key' => 'YOUR_API_KEY'
    ]
]);

package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("GET", "https://api.payhubix.com/v1/payment/invoices/INV-LUE9K66Q/", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := io.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

Note: Please make sure to replace YOUR_API_KEY in the code snippets with your actual merchant API key

PreviousList Invoice (Shop)NextShop

Last updated 1 month ago