---
title: "Get Checkout"
method: GET
path: "/ecommerce/checkout/{checkoutId}"
---

# Get Checkout

`GET /ecommerce/checkout/{checkoutId}`

## Request

- Base URL: `https://ibexpay-api.ibexmercado.com`
- URL: `https://ibexpay-api.ibexmercado.com/ecommerce/checkout/{checkoutId}`
- Auth: API key in header `Authorization`

Get lightning invoice associated with checkout transaction
If you don't want to use the IBEXPay Checkout page, you can build your own integration. On this endpoint is all the information you need.
Use the id from the CreateCheckoutResponse to make the following call and get the actual Bolt11 and the OnChain address to deposit the funds.

## Path parameters

- `checkoutId` string, required

## Response `200`

200

- object
  - `id` string
  - `amount` number
  - `description` string
  - `bptId` string
  - `successUrl` string
  - `gobackUrl` string
  - `transactionId` integer
  - `onchainAddress` string
  - `transaction` object
    - `id` integer
    - `invoiceHash` string
    - `onchainAddress` string
    - `createdAtUtc` string
    - `settledAtUtc` unknown
    - `amountMsat` integer
    - `taxMsat` integer
    - `receivedMsat` integer
    - `feeProcessMsat` integer
    - `tag` unknown
    - `accountId` string
    - `bptId` string
    - `isPaid` boolean
    - `splitBitcoinPercentage` integer
    - `transactionOnchain` object[]
      - `onchainTransactionId` string
      - `networkTransactionId` string
      - `status` string
      - `amountMsat` integer
    - `transactionFiat` object
      - `transactionId` integer
      - `currencyId` integer
      - `amount` integer
      - `tax` integer
      - `received` integer
      - `fees` integer
      - `exchangeRate` number
      - `exchangeCurrencyPair` string
      - `currency` object
        - `id` integer
        - `name` string
        - `isFiat` boolean
        - `symbol` string
    - `transactionOnchainAmount` object
      - `confirmedSats` integer
      - `unconfirmedSats` integer
      - `requiredSats` integer
  - `invoice:` object
    - `hash` string
    - `bolt11` string
    - `preImage` unknown
    - `memo` string
    - `creationDateUtc` string
    - `expiryDateUtc` string
    - `settleDateUtc` unknown
    - `amountMsat` integer
    - `receiveMsat` integer
    - `stateId` integer
    - `state` object
      - `id` integer
      - `name` string
      - `description` unknown

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `0b7d0265e831`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ibexmercado/apis/ibexpay-api/changes/ecommerce/checkout/:checkoutId/get.md)

---

[API](https://skmtc.dev/ibexmercado/apis/ibexpay-api.md) - [All operations](https://skmtc.dev/ibexmercado/apis/ibexpay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ibexmercado/apis/ibexpay-api/revisions/0b7d0265e831?raw)
