checkout

Get Checkout Jwt Token

Changed on

Gets a Checkout Jwt Token for a purchase

Checkout JWT tokens ensure:

  1. The arguments of the purchase cannot be manipulated
  2. The checkout JWT is only valid for a single purchase
  3. The arguments of the purchase are encrypted to be hidden from the user (webhook info, chargebackProtectionData, etc...)
post/checkout/jwt-token

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/checkout/jwt-token
  • Auth
    API key in header Authorization

Request body

emailstring
webhookInfoGetCheckoutLinkArgsWebhookInfo
authOnlyboolean

Only authorize the purchase. This will not actually capture the payment.(default: false)

allowedPaymentMethodsPaymentMethods[]

The payment methods displayed on the UI. If omitted, all available payment methods will be displayed.

blockchain'solana' | 'eth' | 'polygon' | 'base' | 'arbitrum' | 'stellar' | 'monad' | 'tempo' | 'user'

Coinflow Types *

presentment'USD' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES'
chargebackProtectionAccountType'guest' | 'private' | 'business'
settlementType'Credits' | 'USDC'
threeDsChallengePreference'NoPreference' | 'Frictionless' | 'Challenge'
supportEmailstring

Your company email address that the customer can contact.

planCodestring
useNativeSubtotalboolean

When true, the Apple Pay button skips the totals (fee quote) fetch and charges exactly the subtotal passed to the component.

sessionKeystring
isZeroAuthorizationboolean
partialUsdcCheckedboolean

If true, pre-checks the partial USDC payment checkbox when USDC balance is available. If false or undefined, maintains default behavior (unchecked).

deviceIdstring

The DeviceID gotten from the Coinflow SDK: https://docs.coinflow.cash/guides/checkout/fraud-protection/chargeback-protection/implement-chargeback-protection#how-to-add-chargeback-protection

originsstring[]

If rendering the Coinflow component within multiple nested iframes, all ancestors in the chain must be provided as a comma-separated list.

Example: Primary origin that will be interacting with the Coinflow iFrame: foo.com Subsequent origins that will render foo.com: bar.com The origin array would then be: [https://foo.com,https://bar.com]

depositAmountsnumber[]

Custom preset deposit amounts (in dollars) to display in the AmountSelector. Only the first 3 values are used. Defaults to [10, 25, 50] if not provided.

feePercentagenumber double

If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is taken from the subtotal amount.

stellarTransactionstring

(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.

For transaction purchases, pass the base64 XDR string created using .toXDR() on a transaction built with generated TypeScript bindings (e.g., NftClientWrapper.buildNftPurchaseTx).

For direct USDC transfers (no merchant transaction), omit this field or pass undefined.

Gas fees for the transaction will be automatically calculated and added to the total charged to the customer.

destinationAuthKeystring

If utilizing USDC settlement to addresses other than your main merchant settlement address. Utilize this destinationAuthKey which is a JWT encoded with the information for which address to send the USDC to.

overrideChargebackProtectionDecisionboolean
doNotReviewChargebackProtectionboolean
destinationstring

If utilizing USDC settlement to addresses other than your main merchant settlement address. Utilize this destination which is the address to send the USDC to.

idempotencyKeystring

(Optional) Idemptotency Key to pass to prevent multiple purchases with the same checkout link. If not passed, a random one will be generated for you automatically.

statementDescriptorstring

If custom statement descriptors are enabled for your merchant account and the bank supports dynamic descriptors, this will appear on the customer's statement.

Response

Ok

checkoutJwtTokenunknown required

Changes

  • f7dc6dbf5437Revision changes
    • warning

      removed the request property

  • c6e94e0ae714Revision changes
    • breaking

      request property / list-of-types was narrowed by removing types number from media type application/json

    • breaking

      the // request property type changed from number to integer, and format from double to no format