Create recurring checkout

post

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

Creates a checkout for the first payment in a recurring subscription. Returns a subscription_id to be reused in subsequent orders.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

order_merchant_id

string

required

Defaults to order123456

Unique identifier used by the merchant for an order

amount

float

required

Defaults to 68.15

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

currency

string

required

Defaults to EUR

The 3-letter ISO currency code refering to the authorization currency

payment_channel

string

enum

required

Defaults to recurring

Describes where the transaction is taking place. Possible values: e-commerce, moto, pos, recurring

Allowed:

operation_type

string

enum

required

Defaults to authorize

Specify the kind of order you want to create: authorize or direct_capture

Allowed:

type

string

enum

required

Defaults to hosted_fields

The type of checkout

Allowed:

token_type

string

enum

The type of token that will be used

Allowed:

customer_email

string

The customer's e-mail address.

customer_first_name

string

The customer's first name.

customer_last_name

string

The customer's last name.

customer_id

string

The unique identifier of the customer.

customer_ip

string

order_description

string

The customer's ip address.

website_url

string

The website where the order was issued.

accept_url

string

URL to redirect your customer to once the payment process is completed successfully.

cancel_url

string

URL to redirect your customer to if the payment is cancelled (for hosted page only)

decline_url

string

URL to redirect your customer to after the payment is declined.

exception_url

string

URL to redirect your customer to after a system failure.

pending_url

string

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

authentication_indicator

string

enum

Selects the authentication scenario you want applied for this order

Allowed:

challenge_preference

string

enum

Selects the authentication scenario you want applied for this order

Allowed:

contract_id

string

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

customer_gender

string

enum

The customer's gender

Allowed:

customer_birth_date

date

The customer birth date.

customer_identification_number

integer

The customer's identification number. Depending on the payment method, this field can be used to send an ID number or a fiscal number.

customer_phone_number

string

length between 7 and 50

The customer phone number.

customer_phone_number_type

string

enum

The customer type of phone number

Allowed:

customer_city

string

The customer's city.

customer_country

string

length between 2 and 2

The customer's country. 2-letter ISO country code

customer_zip_code

string

The customer's zip code.

customer_street_name

string

The customer's address street name.

customer_os_version

string

Version of the mobile os of the customer

customer_account_creation_date

string

customer_account_change_date

date

The creation date of the customer's account.

customer_account_change_password_date

date

The date of the last password change on the customer's account.

customer_account_add_payment_means_date

date

customer_account_add_payment_means_date

customer_account_successful_orders_day

integer

The number of successful order registered for this customer in the last 24 hours.

customer_account_successful_orders_six_months

integer

The number of successful order registered for this customer in the last 6 months

customer_account_successful_orders_year

integer

The number of successful order registered for this customer in the last year.

customer_account_attempts_order_day

integer

The number of order (succesfull or failed) registered for this customer in the last 24 hours

customer_account_attempts_order_six_months

integer

The number of order (succesfull or failed) registered for this customer in the last 6 months

customer_account_attempts_order_year

integer

The number of order (succesfull or failed) registered for this customer in the last year

customer_items_reorder

boolean

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

customer_browser_info_accept_header

string

The accept header value of the customer's browser.

customer_browser_info_color_depth

string

The color depth of the customer's browser in bits per pixel.

customer_browser_info_java_enabled

boolean

Indicates if the customer's browser is able to execute java.

customer_browser_info_js_enabled

boolean

Indicates if the customer's browser is able to execute javascript

customer_browser_info_language

string

The language of the customer's browser.

customer_browser_info_screen_height

integer

The height of the customer's browser.

customer_browser_info_screen_width

integer

The width of the customer's browser.

customer_browser_info_time_zone

string

The time zone of the customer's browser.

customer_browser_info_user_agent

string

The user agent of the customer's browser.

shipping_address_city

string

The shipping address city.

shipping_address_country

string

length between 2 and 2

The shipping address country. 2-letter ISO country code

shipping_address_state

string

The shipping address state

shipping_address_street_name_line1

string

length ≤ 255

The shipping address street name (first line)

shipping_address_street_name_line2

string

length ≤ 255

The shipping address street name (second line)

shipping_address_zip_code

string

shipping_address_first_use_date

string

The shipping address zip code.

shipping_carrier_name

string

length ≤ 255

Name of the carrier used for the shipping

shipping_delivery_method

string

enum

Indicates where the order is being delivered : customer_address, in_store, pickup_store, other

Allowed:

shipping_delivery_range

string

enum

Estimated range of delivery. Possible values : sameday, lessthan2days, morethan2days

Allowed:

shipping_email

string

length ≤ 25

Email for the shipping

shipping_first_name

string

length ≤ 255

The shipping address first name.

shipping_last_name

string

length ≤ 255

The shipping address last name.

shipping_id

string

length ≤ 255

Unique identifier of the shipping.

shipping_phone_number

string

length between 7 and 25

The shipping address phone number

shipping_price

float

Total price of the delivery.

shipping_tax

string

Amount of tax included in the total shipping amount.

shipping_tax_rate

string

Tax rate applied on the shipping.

basket_id

string

Unique identifier of the basket.

basket_type

string

enum

Indicates the type of items in the basket : physical, digital or mixed

Allowed:

basket_content

array of objects

Details of the basket item by item. We strongly recommend that you either use this field or the 3 following ones : order_description, order_availability and order_availability_date.

basket_content

order_availability

boolean

Availability of the order at the moment of the order.

order_availability_date

date

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

order_tax_amount

float

Total amount of tax for the order

subscription_count

integer

The rank in the installments plan.

subscription_description

string

length ≤ 255

The description of the subscription.

subscription_end_date

date

The date of the end of the subscription

subscription_recurrence

string

enum

The occurence of the subscription: weekly, fifteen_days, month, two_months, three_months, yearly, other

Allowed:

subscriber_id

string

The unique id of the subscriber.

sca_exemption_reason

string

enum

Indicates the reason why the order should be exempted from 3DSecure : low_value, corporate, trusted_beneficiary, risk_analysis

Allowed:

hosted_fields_version

string

Version of the hosted fields or hosted elements used

sdk_version

string

Version of the sdk used: android_version_number, ios_version_number

device_type

string

enum

The type of device used by the customer for this order: mobile, laptop, desktop

Allowed:

locale

string

The 2-letter alpha ISO country code (ex: en, fr, it) followed by the 2-letter ISO language code (ex: en_GB, fr_FR, it_IT)

is_customer_registered

boolean

Indicates if the customer has an account.

is_return_accepted

boolean

Indicates if returns are accepted for this order.

plan_id

string

The unique id of the plan subscribed by the customer.

Headers

version

string

required

Defaults to 1.0.0

API version

Response

200Recurring checkout created successfully