Transactions

Blockchain transactions

The Transaction Object

Name	Type	Description
id	Number	Unique identifier for the object
amount	Number	Actually received/paid amount
blockchainFee	Number	Blockchain miners fee
address	String	Blockchain address
txnHash	String	Transaction hash
tag	String	Destination tags are unique identification codes used by cryptocurrencies to identify the receiver of a transaction
status	String	The status of the payment
createdAt	Date	Time at which the object was created

Lists all Transactions

GET /api/v2/transactions

Returns a list of previously created Transactions. The Transactions are returned in sorted order, with the most recent transaction appearing first. You can optionally provide parameters to filter out the results by time created

Query Parameters

Name	Type	Description
from	Date	Filter by created time. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss
to	Date	Filter by created time. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss
page	Number	Current page

200: OK Example of successful response

{
    "data": [
        {
            "id": 284,
            "amount": "21.000000000000000000",
            "blockchainFee": "0.000012000000000000",
            "address": "rMUq****BPrm",
            "txnHash": "2758****2A3D",
            "tag": "4280318148",
            "status": "Confirmed",
            "createdAt": "2022-11-11T08:16:00.000000Z"
        },
        {
            "id": 285,
            "amount": "0.001010000000000000",
            "blockchainFee": "0.000000000000000000",
            "address": "bc1q****sxsu",
            "txnHash": "714e****a087",
            "tag": null,
            "status": "Received",
            "createdAt": "2022-11-11T08:19:13.000000Z"
        },
        {
            "id": 286,
            "amount": "0.001010000000000000",
            "blockchainFee": "0.000000000000000000",
            "address": "bc1q****8rav",
            "txnHash": "ab47****591f",
            "tag": null,
            "status": "Received",
            "createdAt": "2022-11-11T11:59:02.000000Z"
        },
        {
            "id": 288,
            "amount": "0.001030000000000000",
            "blockchainFee": "0.000000000000000000",
            "address": "bc1q****nf0x",
            "txnHash": "a6c9b****7a8d",
            "tag": null,
            "status": "Confirmed",
            "createdAt": "2022-11-11T12:55:02.000000Z"
        }
    ],
    "links": {
        "first": "/api/v2/transactions?page=1",
        "last": "/api/v2/transactions?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/api/v2/transactions?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/api/v2/transactions",
        "per_page": 20,
        "to": 4,
        "total": 4
    }
}

422: Unprocessable Entity Example of the response with errors

{
    "message": "The given data was invalid.",
    "errors": {
        "from": [
            "The from is not a valid date."
        ]
    }
}

Get Transaction by id

GET /api/v2/transactions/{id}

Retrieves the details of a Transaction that has previously been created. Supply the id and the API will return the corresponding Transaction information.

Path Parameters

Name	Type	Description
id*	Number	Unique identifier for the object

200: OK Example of successful response

{
    "data": {
        "id": 284,
        "amount": "21.000000000000000000",
        "blockchainFee": "0.000012000000000000",
        "address": "rMUq****BPrm",
        "txnHash": "2758****2A3D",
        "tag": "4280318148",
        "status": "Confirmed",
        "createdAt": "2022-11-11T08:16:00.000000Z"
    }
}

422: Unprocessable Entity Example of the response with errors

{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id must be a number."
        ]
    }
}