⏺️Reports

An essential aspect of managing your CoinbarPay account is having the ability to retrieve and analyze your payments history and individual transaction details.

The CoinbarPay API offers methods to access this data effectively. This topic explains how to use the API to get payments and individual payment details.

Impotant Note

Elements such as Settlements, Payments full histories, and other payments related data are exportable from the CoinbarPay Dasbhboard.

Dashboard Platform

Get Payment By Request ID

To fetch the details of an individual payment, use the following endpoint. The API will return a JSON object containing the details of the requested payment.

Get payment details

GET https://sandbox.coinbar.io/coinbar/api/v2/paymentgateway/reports/{{payment_request_id}}

Path Parameters

Name	Type	Description
payment_request_id	String	Payment Request Id used to request the payment

Headers

Name	Type	Description
CBPAY-API-KEY*	String	{{SERVICE_CLIENT_ID}}
Content-Type	String	application/json
SIGNATURE	String	{{SIGNATURE_TOKEN}} HMAC SHA-256 body validation

200: OK

{
    "payment_id_coinbar": "5fdf0222-c84d-4f46.....",
    "payment_request_id_client": "48e70c61-ead4.....",
    "service_client_id": "4cb1a993.....",
    "customer": {
        "external_user_id": "id495935834583",
        "name": "Mario",
        "surname": "Rossi",
        "email": "[e-mail]",
        "post_balance": "-0.00045145423250897323"
    },
    "products": [{
        "product_name": "The Fallout",
        "product_price": 8.99,
        "product_amount": 1,
        "product_id": "id123921392",
        "product_type": "MOVIE"
    }],
    "status": "CANCELED",
    "payment_detail": {
        "transaction_id": "",
        "type": "external",
        "wallet_origin": "",
        "coin": "BTC",
        "pair": "BTC/EUR",
        "amount_crypto": 0.00045145423250897323,
        "timestamp": null,
        "coin_price": 19913.425,
        "total_price": 8.99,
        "transaction_timeout_date": {
            "$date": "2022-05-11T12:19:30.774Z"
        },
        "payment_string": "bitcoin:1Q5BBBBBBBBBBBBBBBBBBBBBBBBB?amount=0.00045145"
    },
    "input_coin": "EUR",
    "urlcallback": "https://.....",
    "creation_time": {
        "$date": "2022-05-11T12:16:01.064Z"
    },
    "update_time": {
        "$date": "2022-05-11T12:16:35.059Z"
    },
    "market_data": {
        "current_change": 19913.425
    },
   
    "status_descr": "Canceled by client request"
}

By using these API methods, you can efficiently fetch and analyze your payments history and individual transaction information, enabling you to monitor your CoinbarPay account and better manage your business' finances.