IBibexmercado

Get Checkout

Changed on

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.

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

Path parameters

checkoutIdstring required

Response

200

idstring
amountnumber
descriptionstring
bptIdstring
successUrlstring
gobackUrlstring
transactionIdinteger
onchainAddressstring

Example response

{
  "id": "906d4227-9eaf-4f85-9b8f-40c66e048904",
  "amount": 0.01,
  "description": "TEST #1",
  "bptId": "58d80bbb-a1e3-4f6d-a6dc-b076b9f18f55",
  "transactionId": 30,
  "onchainAddress": "3BcSU94bcyYFQbyUR6ufdtotrZdb8GCTZf",
  "transaction": {
    "id": 30,
    "invoiceHash": "033278e0d15477f899fcdee4a6c052e25b9d1dde543e8ca27a376731edf943b7",
    "onchainAddress": "mhuCG3dgBPNjsX8gnDnxbjZW1rohF9wZJC",
    "createdAtUtc": "2022-06-08T12:00:06.150606-06:00",
    "amountMsat": 4360,
    "receivedMsat": 4330,
    "feeProcessMsat": 30,
    "accountId": "ad9ce438-9a99-4f73-87c8-2af1e759043d",
    "bptId": "58d80bbb-a1e3-4f6d-a6dc-b076b9f18f55",
    "splitBitcoinPercentage": 100,
    "transactionOnchain": [
      {
        "onchainTransactionId": "b431480c-e6b8-4225-80f8-52bbfa0ee3b",
        "networkTransactionId": "a5204cae1d41b3ab94c0470438b08b437a5efebc42161cc4829a5ff4d5e4670c",
        "status": "MEMPOOL",
        "amountMsat": 1000
      }
    ],
    "transactionFiat": {
      "transactionId": 30,
      "currencyId": 3,
      "amount": 1,
      "exchangeRate": 4291.4074,
      "exchangeCurrencyPair": "SATS-USD",
      "currency": {
        "id": 3,
        "name": "USD",
        "isFiat": true,
        "symbol": "$"
      }
    },
    "transactionOnchainAmount": {
      "confirmedSats": 1,
      "unconfirmedSats": 1,
      "requiredSats": 5
    }
  },
  "invoice:": {
    "hash": "033278e0d15477f899fcdee4a6c052e25b9d1dde543e8ca27a376731edf943b7",
    "bolt11": "lnbcrt43600p1p32pcaxpp5qve83cx323ml3x0ummj2dszjufde68w72slgegn6xannrm0egwmsdqqcqzpgxqzuysp5wl4x9jeacmp3aepwzypy72kdsy3uk2skjykk8tetmakchvd7k4pq9qyyssq5ldlr2u6lqeax3t5m7lz9sh73ycpcaeyxumg5sqxn8j2maw7wnt8zyr6ds56dlxv75qcpzkny2y4gap8lg4fk62cxy339ghjdf0m65sp3nxakf",
    "creationDateUtc": "2022-06-08T12:00:06.134765-06:00",
    "expiryDateUtc": "2022-06-08T12:15:06.134765-06:00",
    "amountMsat": 4360,
    "state": {
      "name": "OPEN"
    }
  }
}

Changes