BillKit/DocsConsole
Checkout

Get one-shot payment

Retrieve one one-off payment, including how much of it has been refunded.

GET/v1/checkout/one_shot/{one_shot_id}
Operation get_one_shot·Scope checkout_sessions:read·OpenAPI v1.1.0

Parameters

ParameterDescription
one_shot_idstring · pathrequiredId of the one-shot payment, which starts osp_.

Returns

Returns an OneShotPaymentResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the checkout_sessions:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/checkout/one_shot/osp_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "amount_cents": 1900,
  "amount_disputed_cents": 1900,
  "amount_refundable_cents": 1900,
  "amount_refunded_cents": 1900,
  "cancel_url": "https://acme.example/welcome",
  "client_secret": "string",
  "created": 1789392000,
  "currency": "EUR",
  "customer_id": "cus_9XKp2vQ1",
  "description": "string",
  "expires_at": 1789392000,
  "failure_reason": "string",
  "id": "osp_9XKp2vQ1",
  "livemode": false,
  "metadata": {},
  "net_cents": 1900,
  "object": "one_shot_payment",
  "paid_at": 1789392000,
  "payment_method": "creditcard",
  "redirect_url": "https://acme.example/welcome",
  "status": "open",
  "success_url": "https://acme.example/welcome",
  "tax_cents": 1900,
  "tax_reverse_charged": false,
  "ui_mode": "hosted"
}