session

Create charge session

post/v1/session/charge

Request

Base URL
https://checkout-api.frisbii.com
URL
https://checkout-api.frisbii.com/v1/session/charge
Auth
HTTP basic

Request body

configurationstring

Optional handle for a checkout configuration defined in the admin app to be used for this session

localestring

Optional locale for session. E.g. en_GB, da_DK, es_ES. Defaults to configuration locale or account locale.

ttlstring

Optional time-to-live duration. The session will expire after the duration from creation, meaning that payment attempts cannot be initiated after this duration. Notice though, that payments initiated within the time-to-live duration might finish after the TTL E.g. MobilePay Online flows. The duration must be given in the following notation: PTxS - x seconds, PTxM - x minutes, PTxH - x hours or PxD - x days. E.g. PT3H (three hours). The default time-to-live is three months.

phonestring

Phone number to use for payment methods able to use a prefilled phone number. E.g. MobilePay, Vipps and Swish. If no explicit phone number is defined, the phone number for the customer entity will be used.

invoicestring

Handle for existing invoice to charge. Either this argument must be provided or order.

settleboolean

Whether or not to immediately settle (capture). Default is false. If not settled immediately an authorization will be performed which can be settled later. Normally this have to be done within 7 days. Note that not all payment methods support immediate settle.

recurringboolean

If set a recurring payment method is stored for the customer and a reference returned. This parameter if set to true will limit payment methods to those that are reusable. Cannot be used in conjunction with recurring_optional.

accept_urlstring

If checkout is opened in separate window the customer will be directed to this page after success

cancel_urlstring

If checkout is opened in separate window the customer will be directed to this page if the customer cancels

payment_methodsstring[]

Optional list of payment methods to use for the checkout session. Format: <payment_methods> = list of <payment_method> <payment_method> = [sca-|nosca-]<payment_name> <payment_name> = The id of payment method, e.g. dankort See https://docs.frisbii.com/docs/checkout-payment-methods for full documentation

card_on_filestring

Reference to existing card payment method (ca_xxx) to use instead of having cardholder enter card data. CVV may still be required from cardholder.

card_on_file_require_cvvboolean

Require cvv from cardholder for card-on-file

card_on_file_require_exp_dateboolean

Require expiration date for card-on-file

button_textstring

Optional alternative button text. Maximum length 32 characters.

recurring_average_amountinteger

For cost based acquirer agreement selection this argument can be used to define the amount used in calculating the least expensive agreement for future recurring payments. Can only be used for sessions saving a payment method for later use. Must be given in minor unit for currency.

payment_method_referencestring

Optional reference given to the created payment method in case a recurring payment method is created by the session. Session id will be used by default if not defined. Max length 64 with allowable characters [a-zA-Z0-9_.-@].

account_fundingboolean

Indicates that Account Funding Transaction (AFT) is requested. It only can be used for instant settle (i.e. 'settle' = true)

agreement_filterstring[]

Optional list of agreement ids to filter which agreements will be used for card payments.

offline_agreement_filterstring[]

Optional list of offline agreement handles to filter which options are shown to the consumer.

vipps_epayment_agreement_filterstring[]

Optional list of vipps epayment agreement ids to filter which options are shown to the consumer.

allowed_ipstring

Optional IP address to restrict the use of the session to

force_mobileboolean

Optionally force use of mobile app URLs for payment methods supporting this.

require_cardholder_nameboolean

Require name on card for credit card payments. The argument will be ignored for card-on-file sessions.

wallet_cardholder_namestring

Optional cardholder name to use for Apple Pay and Google Pay payments.

text_on_statementstring

Optional argument to define the text on bank statement. Notice the following about this argument: 1. It only works for some acquirers. 2. Acquirers may have rigid rules on the content of the text on statement. Not complying to these rules will result in declined payments. 3) It is already possible to define custom text on statement using templating in the Frisbii Administration. Contact support for help. We highly recommend to only supply this argument if absolutely necessary, and the templated default text on statement is not sufficient. Maximum length is 128, but most acquirers require a maximum length of 22 characters. Truncating will be applied if too long for specific acquirer. Characters must match regex [\x20-\x7F]

acquirer_referencestring

Optional reference for the transaction at the acquirer. Notice the following about this argument:

It only works for some acquirers.
Acquirers may have rigid rules on the content of the acquirer reference. Not complying to these rules can result in declined payments.
It is already possible to define custom acquirer reference using templating in the Frisbii Administration. Contact support for help. We highly recommend to only supply this argument if absolutely necessary, and the templated default acquirer reference is not sufficient. Maximum length is 128, but most acquirers require a maximum length of 22 characters. Truncating will be applied if too long for specific acquirer. Characters must match regex [\x20-\x7F]

recurring_optionalboolean

Option to show a checkbox for reusable payment methods to allow the customer to select to save the payment method or not. If set to true the checkbox will be checked by default and vice versa. If the customer chooses to save the payment method, the payment_method parameter will be returned. Cannot be used in conjunction with recurring.

recurring_optional_textstring

Optional alternative text to show if the recurring_optional option is used

show_termsboolean

Toggle whether terms should be shown and acceptance required. If not defined the default is to show terms if no payment method has previously been added. Set this option to false if terms have already been showed in own system.

Example request

{
  "locale": "en_US",
  "ttl": "PT3H",
  "phone": "+4531313131",
  "order": {
    "handle": "order-0000213",
    "key": "5ee00b2b-effb-453e-a246-c3cc26acaeb9",
    "amount": 20000,
    "currency": "USD",
    "customer": {
      "email": "carl@leone.com",
      "title": "Mr",
      "address": "Grove Street 12",
      "address2": "Ganton",
      "city": "Los Santos",
      "country": "US",
      "phone": "555-gotcars",
      "company": "Leones Cars",
      "vat": "US123456789",
      "language": "en",
      "handle": "customer006",
      "test": true,
      "metadata": {
        "key": "value"
      },
      "invoice_email": "carl@leone.com",
      "dunning_email": "carl@leone.com",
      "first_name": "Carl",
      "last_name": "Johnson",
      "date_of_birth": "1990-05-15",
      "postal_code": "4531",
      "debtor_id": 10001,
      "sales_rep_id": "sales-rep-001",
      "order_id": "order-12345",
      "shipping_first_name": "Carl",
      "shipping_last_name": "Johnson",
      "shipping_company": "Leones Cars",
      "shipping_vat": "US123456789",
      "shipping_attention": "Receiving dept.",
      "shipping_address": "Grove Street 12",
      "shipping_address2": "Ganton",
      "shipping_city": "Los Santos",
      "shipping_state_or_province": "SA",
      "shipping_postal_code": "4531",
      "shipping_country": "US",
      "shipping_email": "receiving@leone.com",
      "shipping_phone": "555-gotcars",
      "generate_handle": true
    },
    "metadata": {
      "key": "value"
    },
    "ordertext": "Super product",
    "order_lines": [
      {
        "ordertext": "Soda",
        "amount": 20000,
        "vat": 0.25,
        "quantity": 1,
        "tax_policy": "default_tax_policy_handle",
        "period_from": "2015-05-14T00:00:00",
        "period_to": "2015-05-14T00:00:00",
        "cost_object": "KT-4711"
      }
    ],
    "customer_handle": "cust-0022",
    "billing_address": {
      "company": "Leones Cars",
      "vat": "US123456789",
      "attention": "Mary Schmidt",
      "address": "Grove Street 12",
      "address2": "Ganton",
      "city": "Los Santos",
      "country": "US",
      "email": "carl@leone.com",
      "phone": "555-gotcars",
      "first_name": "Carl",
      "last_name": "Johnson",
      "postal_code": "4531",
      "state_or_province": "WA"
    },
    "shipping_address": {
      "company": "Leones Cars",
      "vat": "US123456789",
      "attention": "Mary Schmidt",
      "address": "Grove Street 12",
      "address2": "Ganton",
      "city": "Los Santos",
      "country": "US",
      "email": "carl@leone.com",
      "phone": "555-gotcars",
      "first_name": "Carl",
      "last_name": "Johnson",
      "postal_code": "4531",
      "state_or_province": "WA"
    }
  },
  "recurring": true,
  "accept_url": "https://myshow.com/success/order-343",
  "cancel_url": "https://myshow.com/cancel/order-343",
  "recurring_average_amount": 10000,
  "sca_data": {
    "name": "John Doe",
    "email": "mail@example.com",
    "home_phone": {
      "cc": "45",
      "subscriber": "56565656"
    },
    "mobile_phone": {
      "cc": "45",
      "subscriber": "56565656"
    },
    "work_phone": {
      "cc": "45",
      "subscriber": "56565656"
    },
    "billing_address": {
      "address1": "Grove Street 12",
      "address2": "Ganton",
      "address3": "Apartment 10",
      "city": "Los Santos",
      "country": "US",
      "postal_code": "4531",
      "state_or_province": "WA"
    },
    "shipping_address": {
      "address1": "Grove Street 12",
      "address2": "Ganton",
      "address3": "Apartment 10",
      "city": "Los Santos",
      "country": "US",
      "postal_code": "4531",
      "state_or_province": "WA"
    },
    "address_match": true,
    "account_id": "123456",
    "challenge_indicator": "preference",
    "risk_indicator": {
      "delivery_email": "mail@example.com",
      "delivery_timeframe": "overnight_shipping",
      "gift_card_amount": 123,
      "gift_card_count": 5,
      "gift_card_currency": "USD",
      "pre_order_date": "2020-11-05",
      "pre_order_purchase_indicator": "merchandise_available",
      "reorder_items_indicator": "first_time_ordered",
      "shipping_indicator": "billing_address"
    },
    "account_info": {
      "created": "2020-11-03",
      "changed": "2020-11-03",
      "age_indicator": "this_transaction",
      "change_indicator": "more_than_60_days",
      "password_change": "2020-11-03",
      "password_change_indicator": "no_change",
      "purchase_count": 2,
      "transactions_day": 2,
      "transactions_year": 32,
      "card_age": "2020-10-02",
      "card_age_indicator": "more_than_60_days",
      "shipping_address_usage": "2020-09-21",
      "shipping_address_usage_indicator": "more_than_60_days",
      "shipping_name_indicator": true
    }
  },
  "session_data": {
    "ssn": "200519903345",
    "account_holder_name": "John Doe",
    "mps_amount": 20000,
    "mps_plan": "Premium Subscription",
    "mps_description": "Free access",
    "mps_frequency": "monthly",
    "mps_external_id": "sub-0021",
    "mps_payment_description": "Welcome package",
    "mps_cancel_redirect_url": "https://merchant.com/my-mps-cancel-page.html",
    "mpo_flow": "dual",
    "applepay_recurring_payment_start_date": "2022-06-01",
    "applepay_recurring_payment_end_date": "2022-12-01",
    "applepay_recurring_payment_interval_unit": "year",
    "applepay_recurring_payment_interval_count": 12,
    "applepay_recurring_trial_label": "Premium Subscription",
    "applepay_recurring_trial_amount": 100,
    "applepay_recurring_label": "Premium Subscription",
    "applepay_recurring_amount": 20000,
    "applepay_supported_countries": [
      "EU"
    ],
    "sepa_debtor_name": "Michael Schmidt",
    "sepa_debtor_address": "Mainzer Landstrasse 51",
    "sepa_debtor_postal_code": "60329",
    "sepa_debtor_city": "Frankfurt am Main",
    "sepa_debtor_country": "DE",
    "sepa_debtor_iban": "DE12345678901234567890",
    "sepa_debtor_bic": "DEUTDEFFXXX",
    "sepa_mandate_amount": 20000,
    "klarna_recurring_amount": 20000,
    "klarna_recurring_product_name": "Premier subscription",
    "klarna_recurring_interval_count": 12,
    "klarna_recurring_interval_unit": "year",
    "vipps_recurring_amount": 20000,
    "vipps_recurring_product_name": "Premier subscription",
    "vipps_recurring_pricing_type": "variable",
    "vipps_recurring_product_description": "Access to all games",
    "vipps_recurring_interval_count": 12,
    "vipps_recurring_interval_unit": "year",
    "vipps_recurring_initial_payment_description": "Welcome package",
    "vipps_recurring_merchant_cancel_url": "https://www.reepay.com/vipps-recurring-cancel-page.html",
    "vipps_recurring_campaign_amount": 20000,
    "vipps_recurring_campaign_interval_count": 30,
    "vipps_recurring_campaign_interval_unit": "day",
    "vipps_recurring_campaign_end_date": "2024-05-14T05:03:56.656Z",
    "vipps_recurring_campaign_event_text": "Christmas",
    "anyday_webshop_url": "https://www.mywebshop.com",
    "vipps_epayment_blocked_sources": [
      "[commercial_cards]"
    ]
  },
  "payment_method_reference": "order-3424",
  "account_funding": true,
  "account_funding_information": {
    "sender_country": "DK",
    "sender_date_of_birth": "1990-07-01"
  },
  "allowed_ip": "1.2.3.4",
  "wallet_cardholder_name": "John Doe",
  "text_on_statement": "myshop.com 23",
  "recurring_optional": true,
  "recurring_optional_text": "Save payment method for later use"
}

Response

Successful operation

idstring required

Session id

urlstring required

Session url

Changes

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