Payments

Charge a saved card off-session

Charges a card saved at checkout without the customer present. Requires an Idempotency-Key. 201: succeeded; 202: the outcome is still unknown, payment.confirmed or payment.failed follows; 402 card_declined or authentication_required (bring the customer back to Checkout).

post/api/v1/payments

Request

  • Base URL
    https://merchant.zahlo.eu
  • Auth
    API key in header x-api-key

Headers

Idempotency-Keystring

Retry-safe key for create operations.

Request body

customerIdstring required
paymentMethodIdstring required

A card saved with setupFutureUsage or a setup session.

amountMinorinteger required
currencystring required
referencestring
metadataobject
offSessiontrue required

Response

The succeeded payment

idstring required
object'payment' required
livemodeboolean required
createdAtstring date-time required
status'pending' | 'succeeded' | 'failed' | 'cancelled' required
amountMinorinteger required
amountRefundedMinorinteger required
refundedboolean required
currencystring required
customerIdstring nullable
subscriptionIdstring nullable
checkoutSessionIdstring nullable
paymentLinkIdstring nullable
receiptNumberstring nullable
receiptUrlstring nullable
referencestring nullable
metadataobject required

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

disputedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.