Create an order

post

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

Use this endpoint to create an order and optionally capture funds immediately.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

operation_type

string

required

Defaults to authorize

authorize or direct_capture

checkout_id

string

required

Defaults to 67ceb0cb9af8068910f8a752

Specify the id of the checkout previously created.

token

string

required

Defaults to b65ab7f6099b1fd8e357ea319dc851f70daebe9e333be065a23d8239130089c3

Given in response to the create token request

amount

float

required

Defaults to 68.18

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

currency

string

required

length ≤ 3

Defaults to EUR

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

order_merchant_id

string

required

Defaults to 276398531664

Unique identifier used by the merchant for an order

payment_channel

string

required

Defaults to e-commerce

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

merchant_contract

string

The merchant contract id used to process the transaction. You will find this information in your account.

payment_method_name

string

Payment method name. Find all available values here

website_url

uri

The website where the order was issued.

device_type

string

enum

The type of device used by the customer for this order.

Allowed:

authentication_indicator

string

enum

The authentication scenario you want applied for this order.

Allowed:

account_holder_first_name

string

For a bank transfer order, the first name of the account holder.

account_holder_last_name

string

For a bank transfer order, the last name of the account holder.

account_number

string

For a bank transfer order, the account number (no SEPA) of the account holder.

account_routing_number

string

For a bank transfer order, the account routing number (no SEPA) of the account holder.

account_iban

string

For a bank transfer order, the IBAN of the account holde.

account_bic

string

For a bank transfer order, the BIC of the account holder.

dynamic_descriptor_authorization

string

The description passed along on the customer bank statement. This option may not always be possible depending on the route chosen.

customer_id

string

The unique identifier of the customer.

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_identification_number

string

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_gender

string

enum

The customer's gender.

Allowed:

customer_street_name

string

The customer's address' street name.

customer_city

string

The customer's city.

customer_zip_code

string

The customer's zip code.

customer_country

string

length ≤ 2

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

customer_ip

string

The customer's ip address.

customer_billing_first_name

string

The billing customer first name.

customer_billing_last_name

string

The billing customer last name.

customer_billing_street_name

string

The billing customer address' street.

customer_billing_city

string

The billing customer city.

customer_billing_zip_code

string

The billing customer zip code.

customer_billing_country

string

length ≤ 2

The billing customer country. 2-letter ISO country code.

customer_birth_date

date

The customer birth date.

customer_phone_number

string

The customer phone number.

customer_phone_number_type

string

enum

The customer type of phone number.

Allowed:

is_customer_registered

boolean

Indicates if the customer has an account.

customer_account_creation_date

date

The creation date of the customer's account.

customer_account_change_date

date

The date of the last update 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_attempts_add_card

integer

The number of attempts to add a card on the customer's account since the opening of the account.

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_account_add_payment_means_date

date

The date of the payment method 's registration on the customer's account.

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_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. It could be in one of the following format: ±hh:mm, ±hhmm or ±hh

customer_browser_info_user_agent

string

The user agent of the customer's browser.

is_return_accepted

boolean

Indicates if returns are accepted for this order.

basket_id

string

Unique identifier of the basket.

basket_type

string

enum

Indicates the type of items in the basket.

Allowed:

order_description

string

General description of the order.

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.

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

customer_items_reorder

boolean

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

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. Possible values.

Allowed:

shipping_delivery_method

string

enum

Indicates where the order is being delivered

Allowed:

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_email

string

The shipping email address.

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 | null

The shipping address street name (second line)

shipping_address_city

string

The shipping address city.

shipping_address_zip_code

string

The shipping address zip code.

shipping_address_state

string

The shipping address state.

shipping_address_country

string

length ≤ 2

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

shipping_address_first_use_date

date

The date when the shipping address was first used.

plan_id

string

The unique id of the plan subscribed by the customer.

contract_id

string

The unique id of the plan subscribed by the customer.

subscription_id

string

The unique id of the subscription.

subscriber_id

string

The unique id of the suscriber.

subscription_first_id

string

The ID send by the scheme during the first transaction of the plan. We highly recommend you to send this information in order to be exempted from 3DS authentication.

subscription_end_date

date

The date of the end of the subscription.

subscription_recurrence

string

enum

The frequency of the subscription.

Allowed:

subscription_description

string

The description of the subscription.

subscription_count

integer

The rank in the installments plan.

giftcard_used

boolean

Indicates if a gift card was used.

giftcard_amount

float

Total amount used on the gift(s) card.

giftcard_currency

string

Currency of the gift(s) card. 3-letter ISO currency code.

giftcard_number

integer

Number of gift cards used.

max_attempts

integer

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

apm_code

string

Specific id to be send when using an APM (please refer to our Support Team to know what to send depending on the payment method).

3ds_data

object

Restricted object. Please refer to the integration when using an external MPI.

sca_exemption_reason

string

enum

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

Allowed:

merchant_data

array of objects

Custom field where you can send your own data. For each, please specify the below object.

merchant_data

accept_url

string

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

decline_url

uri

URL to redirect your customer to after the payment is declined. Max. 500 characters.

pending_url

uri

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

exception_url

uri

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

challenge_preference

string

enum

Selects the authentication scenario you want applied for this order.

Allowed:

locale

string

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

merchant_store_id

string

Free field accepting 255 caracters to be used in routing engine.

integration_id

string

An optional technical id to be provided by us.

Headers

x-api-keu

string

required

Private API key

content-type

string

required

Defaults to application/json

Response

200Successful create order respone