Get Checkout Logs

View as Markdown

This method allows you to check the payment status and the IPN logs for a payment using our API.

Method: GET

Path: https://api.blockbee.io/checkout/logs/

Parameters

Query Parameters

apikeystring•Required

API Key provided by BlockBee's Dashboard. Unsure how to get yours? Check this tutorial.

Note: The API key can also be sent as a header named apikey.

tokenstring•Required

The payment_id provided upon requesting the payment link.

Example:fG78jtx96ugjtu0eIbeLmFB9z0feJf9N

Returns

Returns the payment logs. Returns an error if there's a missing required parameter or if you didn't configure the payment settings correctly.

statusstring

Status of the request. Should be success if the request didn't fail.

is_paidboolean

true if the payment is paid.

is_pendingboolean

true if the payment is pending blockchain confirmation.

is_expiredboolean

true if the payment is expired. Any payment sent to the generated addresses after expiration will be disregarded.

is_partialboolean

true if the payment is partially paid. This can happen if the amount transferred is below the total.

payment_dataobject[]

Detailed information about each payment option. This object contains the following fields:

valuestring

The total requested payment amount in the specified cryptocurrency.

value_paidstring

The amount that has already been paid.

value_outstandingstring

The remaining amount that has yet to be paid.

exchange_ratestring

The exchange rate applied to the payment.

coinstring

The cryptocurrency used for the payment (e.g., eth, btc, bep20_usdt).

txidstring[]

An array of transaction IDs related to the payment.

notificationsobject[]

A list of notifications sent for payment processing. This object contains the following fields:

request_urlstring

The URL to which the notification request was sent.

payloadobject

The JSON payload sent in the notification.

payment_urlstring

The URL for the hosted checkout page where the user can complete the payment.

redirect_urlstring

URL where your customers will be redirected to after successfully completing the payment.

valuestring

Value of the order.

success_tokenstring

A unique token that is passed to your redirect_url to verify the payment's authenticity on your end.

currencystring

The FIAT currency of the value.

is_paidinteger

1 if the payment is paid.

paid_amountstring

The amount paid by the user.

paid_coinstring

The cryptocurrency the user paid with.

exchange_ratestring

The exchange rate applied to the payment.

txidstring

The transaction ID of the payment.

addressstring

The address that received the payment.

statusstring

Status of the payment.

responsestring

The response received from the server for the notification.

response_statusstring

The HTTP status code of the notification response.

pendingboolean

Indicates whether the notification is still pending.

timestampstring

The timestamp when the notification was sent.