Api ReferenceFiablePay ApiCheckoutFetch Checkout

Fetch Checkout

To retrieve the details of a checkout session, use the following endpoint:

  • Endpoint: GET https://service-sandbox.fiablepay.com/v3/checkout/{id}
  • Description: Fetch the details of a specific checkout session.

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the checkout session

Response

FieldTypeDescription
idstringUnique ID of the checkout session
invoice_currencystringCurrency of the invoice
amountintegerTotal amount for the checkout (default: 0)
amount_paidintegerAmount already paid (default: 0)
customer_detailsobjectCustomer information
success_urlstringURL to redirect to after successful payment
cancel_urlstringURL to redirect to if payment is canceled
webhook_urlstringWebhook URL for payment updates
payment_methodsarray of stringsSupported payment methods
transaction_descriptionstringDescription of the transaction
statusstringCurrent status of the checkout session
payment_statusstringPayment status (e.g., unpaid, paid)
urlstringURL for the checkout session

Example Response

{
  "status": "success",
  "message": "CHECKOUT.FETCH.SUCCESS",
  "data": {
    "id": "chk_ctj2hirigj2jdsminhi0",
    "invoice_currency": "USD",
    "amount": 120,
    "amount_paid": 0,
    "customer_details": {
      "customer": "cus_ctgp0rq2lprdpl0d6upg",
      "billing_details": null,
      "shipping_details": null
    },
    "success_url": "https://example.com/success",
    "cancel_url": "https://example.com/cancel",
    "webhook_url": "https://example.com/webhook",
    "payment_methods": ["card"],
    "transaction_description": "Order #12345",
    "status": "active",
    "payment_status": "unpaid",
    "url": "https://checkout-sandbox.fiablepay.com/transaction/vXeBpzkOhVB2ncwIF0gAp80yQlO2FImyHbFRQJT6WBk="
  }
}