Billwerk+ is now Frisbii
API Reference
Frisbii WebsiteKnowledge BaseTry for freeBook a demo

Create subscription session

post
https://checkout-api.frisbii.com/v1/session/subscription
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

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

string

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

string

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.

string

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.

string

Handle for existing subscription to activate, add payment method to or change payment method for. Either this argument must be provided or prepare_subscription.

string

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

string

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

payment_methods
array of strings

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

payment_methods
string

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

boolean

Require cvv from cardholder for card-on-file

boolean

Require expiration date for card-on-file

string

Optional alternative button text. Maximum length 32 characters.

int64
≥ 0

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.

sca_data
object

Customer data used in strong customer authentication to reduce the need for a lengthy authentication process and ensure less fraud. The data is not stored at Reepay and only used in the process of strong customer authentication. The data is used by card issuer to determine if a frictionless authentication flow can be used.

session_data
object

Object to define payment type specific parameters

string

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_.-@].

boolean

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

account_funding_information
object

Optional sender information required for Account Funding Transaction (AFT). If not provided when requesting account funding transaction with account_funding=true, information will be gathered from invoice billing address and customer.

agreement_filter
array of strings

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

agreement_filter
offline_agreement_filter
array of strings

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

offline_agreement_filter
vipps_epayment_agreement_filter
array of strings

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

vipps_epayment_agreement_filter
string

Optional IP address to restrict the use of the session to

boolean

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

boolean

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

prepare_subscription
object

Prepare subscription object. Either this argument must be provided or reference to existing subscription in subscription. For prepare subscription object see: https://docs.frisbii.com/reference/preparesubscription

boolean

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.

boolean

Toggle whether to show subscription details. Default is to show details. Set this option to false if subscription details have already been shown in own system.

Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago