Conversions

BTPay allows you to accept crypto payments and exchange them into one currency of your choice: FIAT Currency, Coin, StableCoin or Token.

The Conversion Object

Name	Type	Description
id	Number	Unique identifier for the object
baseAmount	Number	Base amount
baseCurrency	String	Three-letter currency code
quoteAmount	Number	Quote amount
quoteCurrency	String	Three-letter currency code
rate	Number	Exchange rate
clientOrderId	String	Exchange order id
conversionStatus	String	The status of the conversion
createdAt	Date	Time at which the conversion was created.

Lists all Conversions

GET /api/v2/conversions

Returns a list of previously created Conversions. The Conversions are returned in sorted order, with the most recent conversion 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": 257,
            "baseAmount": "0.001037000000000000",
            "baseCurrency": "BTC",
            "quoteAmount": "22.524448086000000000",
            "quoteCurrency": "USD",
            "rate": "22314.690000000000000000",
            "clientOrderId": "9uE0Wc****83zG8f",
            "conversionStatus": "Success",
            "createdAt": "2022-07-18 16:38:15"
        },
        {
            "id": 284,
            "baseAmount": "0.001030000000000000",
            "baseCurrency": "BTC",
            "quoteAmount": "16.660000000000000000",
            "quoteCurrency": "USD",
            "rate": "17352.610000000000000000",
            "clientOrderId": "1668154560",
            "conversionStatus": "Success",
            "createdAt": "2022-11-11 00:00:00"
        },
        {
            "id": 285,
            "baseAmount": "0.002000000000000000",
            "baseCurrency": "BTC",
            "quoteAmount": "33.320000000000000000",
            "quoteCurrency": "USD",
            "rate": "17386.770000000000000000",
            "clientOrderId": "1668154753",
            "conversionStatus": "Success",
            "createdAt": "2022-11-11 00:00:00"
        },
        {
            "id": 286,
            "baseAmount": "0.002000000000000000",
            "baseCurrency": "BTC",
            "quoteAmount": "33.320000000000000000",
            "quoteCurrency": "USD",
            "rate": "17337.290000000000000000",
            "clientOrderId": "1668167942",
            "conversionStatus": "Success",
            "createdAt": "2022-11-11 00:00:00"
        },
        {
            "id": 288,
            "baseAmount": "14.000000000000000000",
            "baseCurrency": "ETH",
            "quoteAmount": "17689.000000000000000000",
            "quoteCurrency": "USD",
            "rate": "1289.310000000000000000",
            "clientOrderId": "1668171302",
            "conversionStatus": "Success",
            "createdAt": "2022-11-11 00:00:00"
        }
    ],
    "links": {
        "first": "/api/v2/conversions?page=1",
        "last": "/api/v2/conversions?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/conversions?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/api/v2/conversions",
        "per_page": 20,
        "to": 5,
        "total": 5
    }
}

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 Conversion by id

GET /api/v2/conversions/{id}

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

Path Parameters

Name	Type	Description
id*	Number	Unique identifier for the object

200: OK Example of successful response

{
    "data": {
        "id": 257,
        "baseAmount": "0.001037000000000000",
        "baseCurrency": "BTC",
        "quoteAmount": "22.524448086000000000",
        "quoteCurrency": "USD",
        "rate": "22314.690000000000000000",
        "clientOrderId": "9uE0WcD****Hln83zG8f",
        "conversionStatus": "Success",
        "createdAt": "2022-07-18 16:38:15"
    }
}

422: Unprocessable Entity Example of the response with errors

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