IBibexmercado

Create Checkout

Changed on
post/ecommerce/{virtualBPTId}/checkout

Request

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

Path parameters

virtualBPTIdstring required

Request body

amountnumber float required

amount of fiat

orderIdstring required

ID of the order on the shop side

webhookUrlstring

Optional URL to notify when the transaction is paid. A /POST with is made to webhookUrl. Check the request body below.

webhookSecretstring

Optional secret for the webhook

descriptionstring

Optional text explaining whats on the transaction

successUrlstring

URL to redirect when the invoice is paid, only works if using IBEXPay checkout page.

gobackUrlstring

URL to go back when cancelling the checkout, only works if using IBEXPay checkout page.

notifyAllboolean

Optional param to specify the webhooks you want to received, true if you want to received webhooks for all the states of the transaction, or false if you just want to received the webhook when the transaction is paid. By default is false. You can always get the state of the transaction by calling the get checkout endpoint

previousAmountMsatinteger

Msat amount before updating the exchange rate

addressTypestring

Optional address type to generate. Supported types: P2WKH, NP2WKH, P2TR

Response

200

idstring
amountinteger
orderIdstring
webhookUrlstring
transactionIdinteger

Example response

{
  "id": "1",
  "amount": 1,
  "orderId": "Nf$3",
  "webhookUrl": "https://example.com/my/webhook",
  "transactionId": 1
}

Changes