Create Checkout

post

https://api-sandbox.norbr.io/payment/checkout

Use this endpoint to create a checkout session. Accepts numerous fields related to the customer, order, basket, and payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

operation_type

string

enum

required

Kind of order: authorize or direct_capture

Allowed:

type

string

enum

required

The type of checkout: hosted_fields, hosted_page, api, mobile_sdk, qrcode, mail_to_pay

Allowed:

amount

float

required

Defaults to 68.12

A positive number with 3 decimals digit max to describe the charge of the order. Min. 0.02

currency

string

required

Defaults to EUR

3-letter ISO currency code

order_merchant_id

string

required

Defaults to 1234567890

Unique identifier used by the merchant for an order

payment_channel

string

enum

required

Where the transaction occurs: e-commerce, moto, pos

Allowed:

order_tax_amount

float

Total amount of tax for the order.

accept_url

string

URL to redirect your customer to once the payment process is completed successfully. For testing, please make sure to either send it in the request or have it set in your merchant account. Max. 500 characters.

pending_url

string

URL to redirect your customer to when the payment request was processed but response is not yet available. Max. 500 characters.

cancel_url

string

Hosted Page only: URL to redirect your customer to if the payment was canceled. For testing, please make sure to either send it in the request or have it set in your merchant account. Max. 500 characters.

decline_url

string

URL to redirect your customer to if the payment was declined. For testing, please make sure to either send it in the request or have it set in your merchant account. Max. 500 characters.

exception_url

string

URL to redirect your customer to after a system failure. Max. 500 characters.

website_url

string

Website where order was issued

hosted_fields_version

string

Version of the hosted fields or hosted elements used

authentication_indicator

string

enum

The authentication scenario you want applied for this order.

Allowed:

order_availability

boolean

Availability of the order at the moment of the order.

order_availability_date

string

Estimated date of availability of the order if not available at the moment of the order.

order_description

string

General description of the order.

expiration_date

string

The checkout expiration date. A date in ISO format. The expiration will be 15mn by default if not provided. It could be not later than 6hrs from the creation time.

challenge_preference

string

enum

Selects the authentication scenario you want applied for the order.

Allowed:

locale

string

Locale code (fr_FR, en_GB, etc.)

max_attempts

integer

Maximum number of attempts possible on this order. Includes update and fallbacks

payment_method_name

string

Payment method name. Find all available values here

payment_method_type

string

enum

Payment method name

token_type

string

enum

The type of token that will be used.

Allowed:

device_type

string

Device used by customer: mobile, laptop, desktop

integration_id

string

An optional technical id to be provided in very specific integrations (please request via our Support team).

customer_id

string

Customer unique ID

customer_email

string

Customer email

customer_first_name

string

Customer first name

customer_last_name

string

Customer last name

customer_identification_number

string

ID/fiscal number

customer_gender

string

Customer gender: male, female, other

customer_street_name

string

Customer street

customer_city

string

Customer city

customer_zip_code

string

Customer zip code

customer_country

string

Customer country ISO code

customer_ip

string

Customer IP address

customer_items_reorder

boolean

Indicates if the customer has already ordered one of the items in the basket during the past year.

customer_os_version

string

Version of the mobile os of the customer.

customer_billing_first_name

string

Billing first name

customer_billing_last_name

string

Billing last name

customer_billing_street_name

string

Billing street

customer_billing_city

string

Billing city

customer_billing_zip_code

string

Billing zip code

customer_billing_country

string

Billing country ISO code

customer_birth_date

string

Customer birth date

customer_phone_number

string

Phone number

customer_phone_number_type

string

Phone type: mobile, home, work

is_customer_registered

boolean

Indicates if customer has an account

is_return_accepted

boolean

Indicates if returns are accepted

customer_account_creation_date

string

Account creation date

customer_account_change_date

string

Last account change

customer_account_change_password_date

string

Last password change

customer_account_attempts_order_day

integer

Number of orders last 24h

customer_account_attempts_order_six_months

integer

Number of orders last 6 months

customer_account_attempts_order_year

integer

Number of orders last year

customer_account_successful_orders_day

integer

Successful orders last 24h

customer_account_successful_orders_six_months

integer

Successful orders last 6 months

customer_account_successful_orders_year

integer

Successful orders last year

customer_account_add_payment_means_date

string

Date of payment method registration

customer_browser_info_accept_header

string

Browser accept header

customer_browser_info_color_depth

string

Browser color depth

customer_browser_info_java_enabled

boolean

Java enabled

customer_browser_info_js_enabled

boolean

JS enabled

customer_browser_info_language

string

Browser language

customer_browser_info_screen_height

integer

Screen height

customer_browser_info_screen_width

integer

Screen width

customer_browser_info_time_zone

string

Browser timezone

customer_browser_info_user_agent

string

Browser user agent

basket_id

string

Unique basket ID

basket_type

string

Type of basket: physical, digital, mixed

basket_content

array of objects

Details of basket items

basket_content

shipping_id

string

Unique identifier of the shipping.

shipping_carrier_name

string

Name of the carrier used for the shipping

shipping_delivery_range

string

enum

Estimated range of delivery

Allowed:

shipping_delivery_method

string

enum

Indicates where the order is being delivered.

Allowed:

shipping_email

string

Email for the shipping

shipping_price

float

Total price of the delivery.

shipping_tax

float

Amount of tax included in the total shipping amount.

shipping_tax_rate

string

Tax rate applied on the shipping.

shipping_first_name

string

The shipping address first name.

shipping_last_name

string

The shipping address last name.

shipping_phone_number

string

The shipping address phone number

shipping_address_street_name_line1

string

The shipping address street name (first line)

shipping_address_street_name_line2

string

shipping_address_city

string

The shipping address city.

shipping_address_zip_code

string

The shipping address zip code.

shipping_address_country

string

The shipping address country. 2-letter ISO country code.

shipping_address_state

string

The shipping address state.

shipping_address_first_use_date

string

The date when the shipping address was first used.

plan_id

string

The unique id of the plan subscribed by the customer.

sca_exemption_reason

string

enum

Indicates the reason why the order should be exempted from 3DSecure

Allowed:

contract_id

string

The unique id of the contract between you and your customer.

sdk_version

string

Version of the sdk used in the following format: android_version_number, ios_version_number.

subscriber_id

string

The unique id of the suscriber.

subscription_count

string

The rank in the installments plan.

subscription_recurrence

string

enum

The rank in the installments plan.

Allowed:

subscription_end_date

string

The date of the end of the subscription.

subscription_description

string

The description of the subscription.

Headers

version

string

required

API version

Response

200Checkout created successfully