Get Status

Get status and details of an invoice

GET Request to {Endpoint}/status/:id

(:id) is the parameter. This ID refers to the {id} that’s returned from a successful call to Create Invoice.

Successful Response (Status 200)

{
    "success": true,
    "data": {
        "client": {
            "name": "Optional Customer Name",
            "email": "[email protected]",
            "phone": "[phone]",
            "referenceID": "123test"
        },
        "paidAmount": 0.1,
        "subTotal": 0.1,
        "total": 0.1,
        "partialPaymentsEnabled": false,
        "currency": "USDC",
        "completed": true,
        "description": "Optional Order Description",
        "transactions": [
            {
                "tx": "0xd1c7fe2821a9df5240f3d31e570a760322fa979f84c0655a8f9f857023e7064f",
                "sender": "0x2F67f1426f33E25A920F0b2139cd460fDfb8997C",
                "amount": 0.09999999999999999,
                "cryptoAmount": 100000,
                "timestamp": "2024-09-05T21:00:27.000Z",
                "network": "MATIC_POLYGON"
            }
        ],
        "createdAt": "2024-09-05T20:59:47.429Z",
        "merchant": {
            "name": "Business Name",
            "initiator": "Internal Test POS API 1"
        },
        "id": "66da1bc34f03a871430c1a71"
    }
}

JSON Response Parameters

Parameter	Type	Details
id	String	ID for the invoice
client	Object	Client Object submitted during invoice creation
paidAmount	Number	Amount in USD that has been paid and converted into USDC
subTotal	Number	Subtotal associated with the order
total	Number	Total amount of the invoice, after fees (if applicable)
partialPaymentsEnabled	boolean	True if the invoice enables a customer to make partial payments against the invoice
currency	String	Cryptocurrency to be paid out to the merchant. NOTE: Bitcoin payments may not be converted to currency, depending on merchant configuration
completed	boolean	True if the invoice is fully paid
description	String	Optional description provided during invoice creation
transactions	Object	An array of individual transactions that were paid towards the invoice. See below
createdAt	datetime	Date associated with invoice creation
merchant	Object	contains name of the merchant, and initiator, which is the name associated with the API key that created the invoice.

transactions Object Info

Parameter	Type	Details
tx	String	Blockchain transaction hash
currency	String	crypto currency sent by user, if Ethereum -> ETH, if ERC20 -> token address
sender	String	Address of the sender with blockchain format
amount	Number	USD equivalent of the transaction
cryptoAmount	Number	Amount of cryptocurrency in the transactions
timestamp	datetime	Timestamp assocaited with the transaction

An unsuccessful call is returned when an invalid transaction is queried. If necessary, the data field will contain details on the error. The data field is not always present.