Pre-authorization
Reserve funds on a payment instrument without capturing immediately.
Retry a previous pre-authorization
Use this same endpoint to create a new retry attempt. In the request body, provideretry.originating_id for a previous SmartRetry transaction. You can also import the originating
attempt from a payment provider by providing retry.provider_key and either
retry.provider_transaction_id or a non-empty retry.interactions history.
Idempotency-Key. See Idempotency.transaction_id. The response includes order_id when it is available.Authorizations
Headers
Optional idempotency key, scoped to terminal + matched route pattern. A replayed request returns the cached response with Idempotency-Replayed: true.
255^[\w-]+$Path Parameters
The unique identifier of the terminal.
6^[\dA-Za-z]{6}$Body
- Option 1
- Option 2
- Option 3
Exactly one of token, provider_token, or order.payment_instrument must be supplied, unless payment_collection is hosted_page.
A unique identifier for the transaction generated by the merchant.
100The amount to be authorized, in major currency units (e.g. 10.00 for $10.00 USD).
0.01 <= x <= 999999.99AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL A unique identifier for the order generated by SmartRetry. Internally this is the friendly_id for the order and not the actual order_id in the database.
8^[\dA-Za-z]{8}$The IP address of the payer making the request.
^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$01, 02, 03, 04, 05, 06, 07, 08, 09 Indicates how long the shipping address has been associated with the customer.
Indicates the delivery timeframe for the order.
A description of the pre-authorization.
500A stored payment token from the merchant's Payment Instruments.
88A tokenized payment method reference issued directly by the payment provider (e.g. a Stripe payment_method or Adyen storedPaymentMethodId), forwarded to the processor as-is. Distinct from token, which is a SmartRetry Payment Instrument token.
1 - 255CVV/CVC of the card. Optional for added security (cannot be stored).
3 - 4^[0-9]{3,4}$hosted_page