new: Support authorization callback from Klarna
new: Support void, capture, and refund for Dintero PSP transactions
new: Extend payout configuration to support
dynamic_overrides
to support using theorder.store.id
to setorder.payout_destination_id
. The new option enables existing integration that useorder.store.id
to start using payout withorder.payout_destination_id
set
update: Allow splits to be empty when creating a payment session. A transaction created from session with empty items/shipping_option splits will require splits to be specified when capture or refund is performed.
update: Transactions can be filtered by
customer_id
new: Add support for
Dintero-Feature-Toggles
header when updating session
new: Add full support for configuring an Express checkout session or profile with custom checkboxes.
new: Support finish authorizing
dintero_psp.creditcard
and handle redirect
new: Support getting payment operations for
dintero_psp.creditcard
new: Support
dintero_psp.creditcard
payment configuration
new: Add support for using Dintero Wallets card to partly/fully authorize the payment session
update: Add optional query param,
add: Support specifying
bambora_token_scope
inbambora.creditcard
payment options
update: Add
klarna.billie
payment option
update: Add Visa Tokenization credentials to Dintero PSP gateway.
new: Add partial support for configuring an Express checkout session with custom checkboxes.
new: Add support bambora tokenization Set token_scope and token_api_url on gateway configuration(prerequisite) Request payment(MIT) or recurrence(CIT) token on zero and non-zero amount session Use payment or recurrence token on payment to perform MIT or CIT
new: Add support for zero amount sessions by introducing new configuration option
configuration.dintero.zero.enable
. With the new option enabled a zero order session can be created, authorized, captured, refunded and voided. It make it possible to create express session to capture customer information via express without require any payment authorization by the customer.
new: Add support for extending transaction authorization
new: Add Dintero PSP gateway
new: Add support for the Klarna EMD marketplace orders package.
new: Add full support for the Klarna EMD travel-related transactions package (car rental reservation details).
new: Add partial support for the Klarna EMD travel-related transactions package (hotel reservation details).
new: Add partial support for the Klarna EMD travel-related transactions package (ferry reservation details).
new: Add partial support for the Klarna EMD travel-related transactions package (train reservation details).
new: Add partial support for the Klarna EMD travel-related transactions package (bus reservation details).
new: Add partial support for the Klarna EMD travel-related transactions package (air reservation details).
new: Add support for the Klarna EMD recurring payments package.
new: Add support for the Klarna EMD event package.
update: Deprecate endpoint in favor of PUT /v1/view/{session_id}/session/order/addresses
new: Add
generate_payment_token
tosession.payment_operation
.
break: Remove ingenico completely, i.e. payment type, payment operation, checkout config, gateway setup.
- GET / POST /v1/events/gateways/ingenico/transaction/hooks
- GET /v1/sessions/{session_id}/ingenico/redirect/{redirect_ref}
- PUT /v1/admin/gateways/ingenico
- PUT / GET /v1/admin/checkout
break: Administration of checkout gateways will no longer be supported via the scope
admin:checkout
and will requireadmin:dintero
. This affects the following endpoints:
- PUT /v1/admin/gateways/bambora
- PUT /v1/admin/gateways/collector
- PUT /v1/admin/gateways/collector/credentials
- PUT /v1/admin/gateways/collector/override
- PUT /v1/admin/gateways/ingenico
- PUT /v1/admin/gateways/instabank
- PUT /v1/admin/gateways/klarna
- PUT /v1/admin/gateways/klarna/credentials
- PUT /v1/admin/gateways/netaxept
- PUT /v1/admin/gateways/netaxept/override
- PUT /v1/admin/gateways/payex
- PUT /v1/admin/gateways/payex/credentials
- PUT /v1/admin/gateways/payex/override
- PUT /v1/admin/gateways/santander
- PUT /v1/admin/gateways/santander/override
- PUT /v1/admin/gateways/swish
- PUT /v1/admin/gateways/swish/override
- PUT /v1/admin/gateways/vipps
- PUT /v1/admin/gateways/vipps/override
new: Support
payex.mobilepay
through payex v3 whengateway_api_version
is set to "payex.v3", and add payment operation forpay-payex-v3-mobilepay
.
new: Support
payex.googlepay
payment product type.
new: Add support for appswitch deeplink URL for
payex.mobilepay
sessions withchannel=in_app
set.
new: Support
payex.vipps
through payex v3 whengateway_api_version
is set to "payex.v3", and add payment operation forpay-payex-v3-vipps
.
new: Support
payex.swish
through payex v3 whengateway_api_version
is set to "payex.v3", and add payment operation forpay-payex-v3-swish
.
update: Require
locale
for initiating checkout payment forklarna.klarna
.
update: Add string representation of order to response from view payment operations for
klarna.klarna
new: Support
payex.clicktopay
payment type. Extend configuration on gateway and session to enable Click to Pay.
new: Add
version
to session
- POST /v1/view/{session_id}/payments/{payment_product_type}
- GET /v1/view/{session_id}/session
- PUT /v1/view/{session_id}/session/order/addresses
- PUT /v1/view/{session_id}/session/order/discount_codes
- PUT /v1/view/{session_id}/session/order/shipping_address
- PUT /v1/view/{session_id}/session/order/shipping_option
update: Also accept
version
property asIf-Unmodified-Since
to initiaite checkout payment.
update: Limit refund to positive amount
new: Add support for finishing authorization of Klarna payment and handle redirect.
update: Add support for
marketing_consent
when initiating Instabank payment
update: Add support for
query_gateway
query parameter when getting status of PayEx payment for a session.
new: Support
payex.applepay
payment product type. Extend configuration on gateway and session to enable Apple Pay.
new: Add support for getting payment operations for Klarna
new: Add support for enabling Klarna payment when creating payment sessions
new: Add support for configuring Klarna gateway
update: Include Klarna gateway and credentials details
update: Update Payex transaction. Extend
card.type
withDebit Card
, and letmetadata.payex:payment:number
andevent.metadata.payex:transaction:number
be either string or number.
update: Add support for
strict-success-merchant-reference
Dintero-Feature-Toggles header when creating merchant initiated session. The new flag allow "duplicates" if existing sessions failed
new: Add endpoint for handle callback for payex V3 payments
new: Add endpoint for handle redirect for payex V3 payments
update: Add support for
pay-payex-v3-creditcard
payment operations response from endpoint
update: Add support for specifying
gateway_api_versions
when configuring payment options
update: Add suport promiting credential to gateway and gateway override The new option add support for configuring gateway and overrides when credential is created or updated
new: Add endpoint for managing credentials for Collector gateway
new: Add endpoint for managing credentials for PayEx gateway
new: Add support for appswitch deeplink URL for
payex.vipps
sessions withchannel=in_app
set.
new: Add support for including metadata about discounts via
discount_lines
when capturing or refunding a transaction.
new: Add
metadata.payout
property to transaction, the new property will be set if payout is enabled and state what kind of payout will be done
change: Extend support for void on part capture. Void can now be used to release remaining authorization on part captured
payex.mobilepay
andpayex.vipps
transactions
new: Add possibility to change name of session_id query parameter in callback_url
change: Improve endpoint for handle unscheduled and recurring payments
- Block pay request with duplicate
merchant_reference
- Include
session_id
in error response, to use to check status on failure- Add
payment_operation
to session / transaction that state the intent with the payment session was, e.g.unscheduled_purchase
orrecurring_purchase
- POST /v1/sessions/pay
- GET /v1/sessions/{session_id}
- GET /v1/transactions/{id}
change: Add support for void on part capture Vipps transaction. Void can be used to release the remaining authorization on a part captured transaction.
new: Add strict mode header to validate correct session amounts
new: Add support for payout splits via Dintero Payout
new: Add item types to distinguish between physical and digital items, and a category for services
new: Add thumbnail url to order item to be shown in checkout
new: Add possibility to update session without locking it first
new: Add possibility to update session.express
new: Document support for recurring payments. Extend configuration to support generating recurring payment token for
payex.creditcard
payments and performing recurring payments via the pay endpoint
new: Add shipping_mode to decide if a shipping option is required
fix: Require
description
when creating session profile. Document thatdescription
is a required property for session profile. The property has always been required by the service.
new: Support
payex.mobilepay
payment product type. Extend configuration on gateway and session to enable MobilePay payment via PayEx PSP service.
new: Document
event_id
query parameter included in request sent to sessioncallback_url
new: Store initiating system request headers on session and transaction. Add ability to filter sessions on plugin name.
new: Add support for handle authorization redirect from Collector IdP
new: Add support for including
authorization_code
in Collector pay requests
change: Add ability to keep overrides for swish gateway PUT /v1/admin/gateways/swish
new: Add support for
order.payout_destination_id
when creating new sessions. The property will be included in the settlement reports and used if payout is enabled.
new: Pay with
payex.swish
, support for both E-Commerce and M-Commerce Swish Payments.
change: Validate PayEx subsite, return 400 if invalid subsite is used
new: The
profile_id
used when creating new sessions will now be included in the session and transactionmetadata.session:profile_id
property
new: Support for configuring payout for payment products
new: Support including
events.request_headers
when fetching session and transaction, and performing capture, refund or void on the transaction
change: Add support for
phone_number
when getting payment operations
change: Add support for
payex.vipps
payment product type
new: Support
payex.vipps
payment product type. Extend configuration on gateway and session to enable Vipps payment via PayEx PSP service.
new: Support
bambora.mobilepay
payment product type. Extend configuration on gateway and session to enable MobilePay payment via Bambora Wallet service. The payment type must be enabled by Bambora.
doc: Fix documentation for payment-token session endpoint.
session
andpayment_token
are required when creating payment-token session.
new: Support
enable_on_hold
-configuration on session configuration and in checkout configuration
new: Support
bambora.vipps
payment product type. Extend configuration on gateway and session to enable Vipps payment via Bambora Wallet service. The payment type must be enabled by Bambora.
new: Support session profile configuration when creating payment-token session
new: Extend shipping_address_callback response with support for updating the checkout session in addition to returning available shipping options. This will allow the callback endpoint to update the content of the order, like changing amount, or currency or update the items in the order.
change: Add support for void on part capture. Void can be used to release the remaining authorization on a part captured transaction. The support is limited to
payex.creditcard
transactions.
change: Add support for
language
query parameter when getting payment operations
change: Add support Bambora creditcard payment.
change: Add support for bypassing the Dintero redirect for in_app-payments, and redirect from app to app.
change Add support for includes query parameter in session url.callback_url.
includes
set to session will enable the sessions url.callback_url to include session data in the body.
new: It is now possible to use full ISO 8601 compliant datetimes in date range queries. Note: If timezone isn't specified, UTC is assumed Note: To keep things backwards compatible, end-dates with the "yyyy-mm-dd" format will be shifted forward by a day.
new: Add possibility to create myDintero-user in address change
new: Extend transaction data with embedded session data
includes
now supports 'session'
new: Extend Vipps transaction metadata with
vipps:merchantInfo.merchantSerialNumber
, the Merchant Serial Number (MSN) that was used when the transaction was initiated.
new Add support for setting settlements on a transaction, one event per payout to a bank account
new: Version support when updating PayEx gateway configuration. The new option allows the gateway to be configured with multiple merchant agreements
change: Add support for additional query parameters.
search
will match on merchant reference's and customer nametransaction_id
will filter results to include only sessions associated with the provided transaction idscreated_at.gte
will exclude all sessions created before provided datecreated_at.lte
will exclude all sessions created after provided date
new: Endpoint for initiating MIT payments
new: Checkout sessions and profiles supports theming via
configuration.theme
new: Add support for using external discount codes in Express checkout. A session can be configured with a
express.discount_code_callback_url
that will be invoked when the session is updated with a promotion code. The response from the callback will then be used to adjust the order and shipping options available.
new: Add support for an advance credit check of Collector B2B customers
new: Add support for overriding Collector gateway settings
new Add support for
collector.invoice_b2b_preapproved
andcollector.installment_b2b_preapproved
payment
new Async transaction operations. The response status from capture, refund or void can now be
202
if the request was accepted but the processing has not been completed.The transaction with an operation that was accepted will receive a update later when the processing completes. The event that completes the operation will include an
initiate_request_id
property. You can use thecallback_url
to receive a callback when the processing completes.The status of the transaction will remain unchanged until the processing of the operation completes.
new Add support for callback when transaction is updated. You can now receive callbacks on captures, refunds and void by including
report_event=<event>
query parameter in thecallback_url
.https://example.com/callback?report_event=CAPTURE&report_event=REFUND
new Added
in_store
as a possible payment channel for payments in physical stores.
new Added option for configurating the payment channel. See
configuration.channel
. The new option add support forin_app
channel with appswitch deeplink URL (Vipps).
new Add support for optional
order.discount_lines
when creating a new sessions.
new Add support for updating a session
total_income
moved from applicant to top level for instabank.invoice and instabank.installment. The field is required, but there will be a grace period of two months before it is enforced. Deprecatedapplicant.total_income
new Add support for optional
metadata
when creating a new session.
new Add support for optional
merchant_reference_2
when creating a new session
new Add support for delayed callback. You can enable the delay callback feature by including
delay_callback=<seconds>
query parameter in thecallback_url
https://example.com/callback?delay_callback=30
new: Add support for overriding Netaxept gateway settings
new: Add terminal options for Netaxept creditcard payment. Enable use of Netaxept hosted checkout, and provided custom configuration.
new: Add support for Netaxept.
new: Add support for overriding PayEx gateway settings
new: Include payment token in transaction details
new Added option for using payment token for payex.creditcard payments to prefill payment details so the customer (payer) do not need to enter all these details for every purchase.
new Added option for generating payment token for payex.creditcard payments, see
configuration.payex.creditcard
. Use the new option to generate a payment token that can be used in future payments to prefill the details for the creditcard.
new Added
instabank.postponement
payment type.
new Added
swish.swish
payment type, direct integration with Swish.
change Add support for
ON_HOLD
transaction status. The new status is limited to Collector transactions, to signal that the processing of the transaction is not yet completed. The new status will be used in cases where Collector performs aditional controls before approving the payment.
new Add support for setting
merchant_reference_2
to an existing transaction and search for transactions bymerchant_reference_2
.
new Add support for POST callback with the authorized transaction included in the request body. You can enable the POST callback feature by including
method=POST
query parameter in thecallback_url
https://example.com/callback?method=POST
new Add support for
instabank.installment
payment
changed: Removed error
capture
from list of valid error added to the redirect to theurl.redirect_url
. The error was used for payments withauto-capture
enabled, and set in case where the auto capture failed. The merchant can assume the transaction will be captured automatically as soon as possible when creating a session withauto-capture
enabled.
changed: A callback (when
url.callback_url
is set) will now be sent as soon as possible after the transaction isAUTHORIZED
. We will no longer wait until the transactionCAPTURED
in case whenauto-capture
is enabled.
change: Add support for creating session with Ingenico enabled
change: Add support for creating session with Ingenico enabled
new Add support for
collector.invoice_b2b
payment
new Add support for configuring Ingenico gateway
new Add support for enabling
Dintero-Signature
header for all system-to-system request sent from Dintero to the merchant
fix: Documentation for endpoint GET /v1/admin/api-keys. The resource returns a list of api-keys, not a single api-key.
new Add support for
collector.installment
payment
new Add support for putting merchant_terms_url in profile and session
new Add support for overriding gateway settings
new Add support for
include_session
query parameter
new Add support for discount calculation on sessions. The discounts will be calculated when customer is identified
Extend the order and transaction items with new properties to support discount calculation of session:
discount_lines
gross_amount
is_change
eligible_for_discount
Support calculating and updating session with discount from:
new Add store property to
session.order
and transaction. Adds support for including details about the sales location in the order
new Add
shipping_option
fromsession.order
to totransaction
changed Minor changes to the
shipping_option
object(s) in sessions
new Add an endpoint for abandon a checkout payment
changed: Express Checkout flow added to sessions
new Update a an Express Checkout session order
new: Extend Transaction with optional
billing_address
field.
new: Extend Transaction Event with correction field to handle correction of status after operations errors
changed: previously required fields are now optional for
instabank.finance
.
- mortgage_debt
- student_debt
- other_secured_debt
changed: Payments for payment product type
instabank.invoice
now contain an optionalapplicant
object used for sending more details about the payee. The applicant data will be required for amounts over a limit specified by Instabank.
changed: Payment sessions with
instabank.invoice
now contains anrequire_applicant
boolean flag in the instabank invoice configuration when getting the session.
changed: Adds detailed debt array to
instabank.finance
.
changed: Disabled
instabank.invoice
for amounts less than 500 NOK
new: Filter transaction list by
payment_product_type
:
- instabank.finance
- instabank.invoice
- vipps
- payex.creditcard
- payex.swish
new: Filter transactions list by
card_brand
:
- Visa
- MasterCard
new: Added optional
remember_me
boolean to POST pay request body when initializing a payment of a session.
fix:
Transaction.status
typo, renamePARTICALLY_CAPTURED_REFUNDED
toPARTIALLY_CAPTURED_REFUNDED
.
changed: replaced
card
payment type withpayex
. The payex payment type adds support for payment product types:
- payex.creditcard
- payex.swish
changed: Add support for optional custom expires_at parameter when creating a new session either directly or from a profile.
changed: Add support for override of configuration when creating a new session from a profile.
new: support cancel of session
changed: In SessionBase, extend order with
partial_payment
property that can be used in case where the payment is partial and theorder.amount
is less or equal to theorder.items.amount
.
break: Pay with
instabank.finance
type requires now additional properties to comply with new regulations from Finanstilsynet.
- POST /v1/sessions/{session_id}/pay changed: In SessionMeta events, extend event with
details
object and enumerate the event names available.- GET /v1/sessions/{session_id}
changed: Remove
instabank.installment
andinstabank.postponement
payment type. The types will no longer be accepted by:
In SessionMeta renamed field
expiry_at
toexpires_at
.
new: PaymentConfiguration extended with optional
auto_capture
boolean field. If set to true the checkout serivce will automatically capture the payment after the transaction isAUTHORIZED
.
new: Add support for checkout with SMS. A SMS with link to the checkout can now be sent when a new session is created. See relevant resources for more information.
fix: Fix documentation for the response from api-keys endpoints. No
gateways
property will be included in response to api-keys requests.
doc: Document support for JWT Bearer authentication. Use API client to get an JWT access token.
break: Administration of checkout gateways was moved to new endpoints. Gateway configuration will no longer be supported via the
PUT /admin/checkout
endpoint.
- PUT /admin/checkout
- POST /admin/gateways/{gateway}/status
- PUT /admin/gateways/instabank
- PUT /admin/gateways/vipps
removed:
(check gateway status)POST /admin/gateways/{gateway}
new: Extend transaction.event with
created_by
property. Include the user who created the event, i.e. applied an operation to the transaction.
new: Add support for checkout with QR-Code A QR Code can now be generated for a Checkout Session. See relevant resource for more information.
new: Add support for filter transactions with query parameters. Transactions can now be filtered on:
status
,payment_product
,merchant_reference
,session_id
,amount
andcreated_at
.
new: Add support for
session.url.callback_url
. Get system-to-system notification when session payment is completed.
A Checkout Session relates to an order in your system. When an order has been placed you create a corresponding Checkout Session to receive payment for that order.
Create a corresponding Checkout Session for an order placed in your system using predefined session profile
Note that items
is a required property when creating a session with
Instabank configured.
scopes:
include_session | boolean Include all details about the session created |
Dintero-Feature-Toggles | Array of strings Default: Items Value: "strict-session-amounts" Feature toggles that will change how the API works. These feature toggles are usually the preferred way to use the API, but they break the current API.
|
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
required | object (SessionOrder) |
required | object (SessionUrls) |
profile_id required | string configuration profile |
object | |
expires_at | string <date-time> |
Array of objects (CheckboxConfiguration) <= 2 items Configuration for checkboxes that should be part of the checkout | |
object (PaymentConfiguration) Override configuration for the profile. | |
object (Merchant) Configure merchant information used in the checkout. | |
object Present only for Express Checkout sessions.An Express Checkout session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated. Endpoints used in the Express Checkout flow. | |
object <= 10 properties Additional metadata about the resource |
{- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "tokens": {
- "bambora.creditcard": {
- "payment_token": "string",
- "recurrence_token": "string"
}, - "payex.creditcard": {
- "payment_token": "string",
- "recurrence_token": "string"
}
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string"
}
]
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable"
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
]
}, - "discounts": {
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "profile_id": "string",
- "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}, - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "metadata": {
- "system_x_id": "XAB1239",
- "number_x": 1921
}
}
{- "id": "string",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "session": {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}, - "cancelled_by": "string",
- "cancelled_at": "2019-08-24T14:15:22Z"
}
}
Create a corresponding Checkout Session for an order placed in your system
Note that items
is a required property when creating a session with
Instabank configured.
scopes:
include_session | boolean Include all details about the session created |
Dintero-Feature-Toggles | Array of strings Default: Items Value: "strict-session-amounts" Feature toggles that will change how the API works. These feature toggles are usually the preferred way to use the API, but they break the current API.
|
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
required | object (SessionOrder) |
required | object (SessionUrls) |
required | object (PaymentConfiguration) |
object | |
expires_at | string <date-time> |
Array of objects (CheckboxConfiguration) <= 2 items Configuration for checkboxes that should be part of the checkout | |
object Present only for Express Checkout sessions.An Express Checkout session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated. Endpoints used in the Express Checkout flow. | |
object <= 10 properties Additional metadata about the resource | |
object (Merchant) Configure merchant information used in the checkout. |
{- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "tokens": {
- "bambora.creditcard": {
- "payment_token": "string",
- "recurrence_token": "string"
}, - "payex.creditcard": {
- "payment_token": "string",
- "recurrence_token": "string"
}
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string"
}
]
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable"
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
]
}, - "discounts": {
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "metadata": {
- "system_x_id": "XAB1239",
- "number_x": 1921
}, - "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}
}
{- "id": "string",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "session": {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}, - "cancelled_by": "string",
- "cancelled_at": "2019-08-24T14:15:22Z"
}
}
List all Checkout sessions scopes:
limit | integer [ 1 .. 100 ] Default: 10 A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items. |
starting_after | string <checkout-id> cursor for use in pagination. starting_after is an object ID
that defines your place in the list. For instance, if you make
a list request and receive 100 objects, ending with |
id | Array of strings <checkout-id> [ items <checkout-id > ] List of ids that should be included in the result. ?id=A&id=B&id=X |
search | string Will try to match the search to either merchant_reference, merchant_reference_2,
or the customer name using the format |
transaction_id | Array of strings <checkout-id> [ items <checkout-id > ] The id(s) of the transaction(s) that should be included in the result |
created_at.gte | string <isodate> Session created after (ISO 8601. We recommend using a localised ISO 8601 datetime like |
created_at.lte | string <isodate> Session created before a date (ISO 8601. We recommend using a localised ISO 8601 datetime like |
store_id | Array of strings The store_id that the session relates to. ?store_id=A&store_id=B&store_id=X. |
initiating_system.dintero_system_plugin_name | Array of strings The dintero-system-plugin-name that the session was created with. |
payment_operation | string Example: payment_operation=unscheduled_purchase Filter on |
[- {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}, - "cancelled_by": "string",
- "cancelled_at": "2019-08-24T14:15:22Z"
}
]
scopes:
session_id required | string <checkout-id> The session ID |
includes | Array of strings Items Enum: "events.request_headers" "initiating_system_request_headers" Include aditional data that are by default excluded from the session details.
|
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}, - "cancelled_by": "string",
- "cancelled_at": "2019-08-24T14:15:22Z"
}
Session must be locked for paying before updating.
Requirements:
order.shipping_option
must be included in express_shipping_options
if both are set.order.amount
must be equal to the sum of order.items
and order.shipping_option
scopes:
session_id required | string <checkout-id> The session ID |
force_shipping_address_callback | boolean Default: false If If |
update_without_lock | boolean Default: false Allow updating session without it having been locked first. Allowed for server-to-server when the checkout has not been rendered yet. |
Dintero-Feature-Toggles | Array of strings Default: Items Value: "strict-session-amounts" Feature toggles that will change how the API works. These feature toggles are usually the preferred way to use the API, but they break the current API.
|
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
required | object (SessionOrderUpdate) |
object (SessionExpressUpdate) | |
remove_lock | boolean Default: true Remove lock after updating |
{- "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
]
}, - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required"
}, - "remove_lock": true
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}, - "cancelled_by": "string",
- "cancelled_at": "2019-08-24T14:15:22Z"
}
Cancel a session
The session transaction will be voided in case where it is initialized or authorized.
Cancel is not allowed in case where the current transaction state is not initialized or authorized.
scopes:
session_id required | string <checkout-id> The session ID |
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}, - "cancelled_by": "string",
- "cancelled_at": "2019-08-24T14:15:22Z"
}
Generate a QR Code containing the URL for the Checkout Session. The QR Code can be displayed in POS to enable Checkout payment.
scopes:
session_id required | string <checkout-id> The session ID |
format | string Value: "png" |
size | integer [ 300 .. 1024 ] Default: 300 Size of the QR code. The code is a square, so width and height are the same |
{- "format": "png",
- "size": 300
}
{- "qr": "string"
}
This endpoint lets you create payment and recurrence tokens without reserving or charging any amount.
The URL returned by this endpoint opens a web site where the customer can enter their payment details, e.g. card information.
The payment details will be validated and a transaction with a payment/recurrence token will be created on success containing the payment token created from the customer payment details.
scopes:
include_session | boolean Include all details about the session created |
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
required | object The session to create the payment token from |
required | object (TokenProvider) |
{- "session": {
- "order": {
- "currency": "NOK",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}
}, - "url": {
}, - "profile_id": "string",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "configuration": {
- "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}
}, - "metadata": {
- "system_x_id": "XAB1239",
- "number_x": 1921
}
}, - "token_provider": {
- "payment_product_type": "string"
}
}
{- "id": "string",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "session": {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}, - "cancelled_by": "string",
- "cancelled_at": "2019-08-24T14:15:22Z"
}
}
For Express Checkout sessions, the order.shipping_address
must be set on
the session, and a _order.items.shipping_option
item is required if the
session has either an express.shipping_address_callback_url
or the
session has at least one option in express.shipping_options
.
session_id required | string <checkout-id> The session ID |
If-Unmodified-Since | string Optional header. The put request is discarded and a 412 is returned if the header does not match the |
payment_product_type required | string The payment product type corresponding to this transaction |
phone_number required | string^\+?\d{5,15}$ mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) |
remember_me | boolean If true will either make the backend add or update a signed cookie with customer data. If false the cookie will be removed. If not set, any existing cookie will remain unchanged |
{- "payment_product_type": "swish.swish",
- "phone_number": "string",
- "remember_me": true
}
{- "success": true,
- "actions": [
- {
- "source": "DINTERO",
- "code": "200",
- "type": "success"
}
], - "redirect_url": "string",
- "poll_url": null,
- "error": "Rejected",
- "error_details": [
- {
- "code": "wrong_ssn",
- "category": "permanent",
- "field": "string"
}
]
}
For merchant initiated payments, where the customer is not involved.
Receives a session and pays it with the given card token.
scopes:
Dintero-Feature-Toggles | Array of strings Default: Items Enum: "strict-merchant-reference" "strict-success-merchant-reference" Example: strict-merchant-reference
|
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
object (PaySessionOptions) The session to create the payment from | |
object (PayPayment) |
{- "session": {
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "tokens": {
- "bambora.creditcard": {
- "payment_token": "string",
- "recurrence_token": "string"
}, - "payex.creditcard": {
- "payment_token": "string",
- "recurrence_token": "string"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "configuration": {
- "auto_capture": true
}, - "metadata": {
- "system_x_id": "XAB1239",
- "number_x": 1921
}
}, - "payment": {
- "payment_product_type": "string"
}
}
{- "id": "string",
- "payment_product": "bambora",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1",
- "metadata": {
- "bambora:transaction:status": "string",
- "bambora:transactionoperation:id": "string",
- "bambora:meta:action:source": "string",
- "bambora:meta:action:code": "string",
- "bambora:meta:action:type": "string"
}
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string",
- "gateway:id": "string",
- "bambora:merchant_number": "string",
- "bambora:transaction_id": "string",
- "bambora:reference": "string",
- "bambora:acquirer": "string",
- "bambora:wallet": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "payment_product_type": "bambora.creditcard",
- "card": {
- "brand": "Visa",
- "masked_pan": "476173******0416",
- "expiry_date": "string",
- "type": "Credit Card",
- "eci": "string",
- "country": "string"
}
}
session_id required | string <checkout-id> The session ID |
payment_product_type required | string Enum: "bambora.creditcard" "collector.installment" "collector.invoice" "collector.invoice_b2b" "collector.invoice_b2b_preapproved" "dintero_psp.creditcard" "payex.creditcard" "payex.mobilepay" "payex.swish" "payex.vipps" "payex.applepay" "payex.clicktopay" "payex.googlepay" "santander.debit_account" "klarna.klarna" "klarna.billie" |
language | string Example: language=nb-NO Preferred language to use in the payment operation |
phone_number | string <E.164> ^\+?[1-9]\d{1,14}$ Example: phone_number=+4738260107 Preferred phone number to use in the payment operation |
string Example: email=example@email.com Preferred email to use in the payment operation | |
organization_number | string Example: organization_number=919656396 The organization number that the payment is for. |
country | string Example: country=NO The country to ship to. Required for |
{- "operations": [
- {
- "method": "GET",
- "href": "string",
- "rel": "view-payment",
- "content_type": "application/javascript"
}, - {
- "method": "POST",
- "rel": "pay-collector-installment",
- "product": {
- "id": "IF_3_001",
- "type": "interest_free",
- "credit_time": 3,
- "campaign_fee": 0,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500
}, - "content_type": "application/json"
}, - {
- "method": "POST",
- "rel": "pay-collector-invoice-b2b",
- "shipping_address": {
- "id": "address_1",
- "business_name": "Dintero AS",
- "address_line": "Street road 1",
- "postal_place": "OSLO",
- "postal_code": 565,
- "country": "NO"
}, - "content_type": "application/json"
}, - {
- "method": "POST",
- "rel": "publish-secret-confirmation-code",
- "content_type": "application/json"
}, - {
- "method": "GET",
- "session": {
- "token": "fb49265d30aa4f1bb327b943c4d43b14"
}, - "rel": "pay-bambora-creditcard",
- "content_type": "text/html"
}, - {
- "method": "POST",
- "client_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
- "rel": "pay-klarna",
- "content_type": "application/json"
}
], - "version": "22596363b3de40b06f981fb85d82312e8c0ed511"
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "metadata": {
- "session:profile_id": "string"
}, - "operations": [
- {
- "method": "POST",
- "rel": "view-payex-creditcard",
- "content_type": "application/json"
}, - {
- "method": "POST",
- "rel": "view-collector-installment",
- "content_type": "application/json"
}
], - "pay_lock": {
- "pay_lock_id": "7ffdbd47-a7c8-476b-b06b-39e0a3f2a4c6"
}, - "version": "22596363b3de40b06f981fb85d82312e8c0ed511"
}
When locked, the session can not be paid. Locking the session is only available when express is enabled.
session_id required | string <checkout-id> The session ID |
{- "pay_lock": {
- "pay_lock_id": "7ffdbd47-a7c8-476b-b06b-39e0a3f2a4c6"
}
}
Changes the order.shipping_address
and order.billing_address
submitted by end user in the Express Checkout flow.
If the express.shipping_address_callback_url
is set, the express.shipping_options
in the response will be updated to show the available shipping options for
the updated address.
Also changes the checkboxes that are part of the session as they are checked or unchecked by the end user in the Express Checkout flow.
session_id required | string <checkout-id> The session ID |
If-Unmodified-Since | string Optional header. The put request is discarded and a 412 is returned if the header does not match the |
object (OrderAddress) Address | |
object (OrderAddress) Address | |
object (MyDinteroUserCreation) Options for myDintero | |
Array of objects (CheckboxUpdate) <= 2 items The checkboxes that should be updated |
{- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "my_dintero": {
- "actions": [
- "create_user"
],
}, - "checkboxes": [
- {
- "id": "string",
- "checked": true
}
]
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "metadata": {
- "session:profile_id": "string"
}, - "operations": [
- {
- "method": "POST",
- "rel": "view-payex-creditcard",
- "content_type": "application/json"
}, - {
- "method": "POST",
- "rel": "view-collector-installment",
- "content_type": "application/json"
}
], - "version": "22596363b3de40b06f981fb85d82312e8c0ed511"
}
Changes the order.discount_codes
submitted by end user in the Express Checkout flow.
If the express.discount_codes_callback_url
is set, the session will be
updated with discount on the order and the shipping options.
session_id required | string <checkout-id> The session ID |
If-Unmodified-Since | string Optional header. The put request is discarded and a 412 is returned if the header does not match the |
discount_codes | Array of strings |
{- "discount_codes": [
- "string"
]
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "metadata": {
- "session:profile_id": "string"
}, - "operations": [
- {
- "method": "POST",
- "rel": "view-payex-creditcard",
- "content_type": "application/json"
}, - {
- "method": "POST",
- "rel": "view-collector-installment",
- "content_type": "application/json"
}
], - "version": "22596363b3de40b06f981fb85d82312e8c0ed511"
}
Change the active gift_cards
for the session. Updating with empty gift cards
removes all gift cards from the session
session_id required | string <checkout-id> The session ID |
If-Unmodified-Since | string Optional header. The put request is discarded and a 412 is returned if the header does not match the |
required | Array of objects <= 1 items |
{- "gift_cards": [
- {
- "type": "dintero.wallets.card_id",
- "pin": "string",
- "value": "string"
}
]
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "metadata": {
- "session:profile_id": "string"
}, - "operations": [
- {
- "method": "POST",
- "rel": "view-payex-creditcard",
- "content_type": "application/json"
}, - {
- "method": "POST",
- "rel": "view-collector-installment",
- "content_type": "application/json"
}
], - "version": "22596363b3de40b06f981fb85d82312e8c0ed511"
}
Deprecated in favor of PUT /v1/view/{session_id}/session/order/addresses
Changes the order.shipping_address, submitted by end user in the Express Checkout flow.
If the express.shipping_address_callback_url
is set, the express.shipping_options
in the response will be updated to show the available shipping options for
the updated address.
session_id required | string <checkout-id> The session ID |
If-Unmodified-Since | string Optional header. The put request is discarded and a 412 is returned if the header does not match the |
first_name | string |
last_name | string |
address_line | string Gaustadalleen 21 |
address_line_2 | string PB 123 |
co_address | string |
business_name | string Name of the company |
postal_code | string The zip code / postal code of the address. |
postal_place | string The name of the postal code |
country | string <iso3166-alpha2> Country of the location |
phone_number | string^\+?\d{5,15}$ mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...) |
string The email address of a person or an organization | |
latitude | number |
longitude | number |
comment | string Comment about the address |
organization_number | string The organization number of the customer. |
organization_type | string Type indicating what kind of organization it is. |
customer_reference | string The customer's reference |
cost_center | string For companies that needs to specify a cost center. |
{- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "metadata": {
- "session:profile_id": "string"
}, - "operations": [
- {
- "method": "POST",
- "rel": "view-payex-creditcard",
- "content_type": "application/json"
}, - {
- "method": "POST",
- "rel": "view-collector-installment",
- "content_type": "application/json"
}
], - "version": "22596363b3de40b06f981fb85d82312e8c0ed511"
}
Changes the selected shipping_option, submitted by end user in the Express Checkout flow.
session_id required | string <checkout-id> The session ID |
If-Unmodified-Since | string Optional header. The put request is discarded and a 412 is returned if the header does not match the |
id required | string Id of this shipping option product. The express checkout will group all products with the same id. Used for grouping delivery to the same address at different time slots, or for grouping deliveries to different pick up points. |
line_id required | string Unique id of the specific configuration of this shipping product |
amount required | integer The monetary amount of the shipping option, including VAT and discounts. In smallest unit for the currency, e.g. cents |
operator required | string Name of company that provides shipping service |
title required | string A shipping option title. Eg. "Standard" |
countries | Array of strings <iso3166-alpha2> [ items <iso3166-alpha2 > ] Countries where this shipping option can be used |
vat_amount | integer The VAT of the |
vat | number The VAT percentage |
description | string A short description of the shipping option product |
delivery_method | string Enum: "delivery" "pick_up" "unspecified" "none" |
operator_product_id | string The operators own id for this shipping product |
object Estimated time of arrival | |
object A specified time for delivery to customer | |
object Address | |
object <= 20 properties Additional metadata about the shipping_option | |
object Environmental data about the shipping option | |
object (PayoutFeeSplit) Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations | |
Array of objects (PayoutSplit) An array of objects specifying how the amount should be split between sellers when using Dintero Payout Specify an empty array if the splits will be provided during capture.
|
{- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": {
- "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
}
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "metadata": {
- "session:profile_id": "string"
}, - "operations": [
- {
- "method": "POST",
- "rel": "view-payex-creditcard",
- "content_type": "application/json"
}, - {
- "method": "POST",
- "rel": "view-collector-installment",
- "content_type": "application/json"
}
], - "version": "22596363b3de40b06f981fb85d82312e8c0ed511"
}
This API endpoint on the merchant side allows Dintero to get
shipping_options and order with discounts based on the provided
session that had its order.discount_codes
updated.
required | object (SessionOrder) |
required | object (SessionUrls) |
required | object (PaymentConfiguration) |
id | string An ID that uniquely identifies the resource |
created_at | string <date-time> The date-time when the resource was created |
object | |
expires_at | string <date-time> The session expiration time after which the Checkout page wouldn't be available |
Array of objects (CheckboxConfiguration) <= 2 items Configuration for checkboxes that should be part of the checkout | |
object Present only for Express Checkout sessions.An Express Checkout session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated. Endpoints used in the Express Checkout flow. | |
updated_at | string <date-time> Last time when the Checkout was updated |
customer_ip | string The IP of the customer upon visiting the page. If the page is visited multiple times, the field is always updated with the last known value. |
user_agent | string The full user agent of the device the customer used when visiting the checkout page |
object (SystemRequestHeaders) | |
payment_operation | string (PaymentOperationIntent) Enum: "unscheduled_purchase" "recurring_purchase" "generate_payment_token" Initiated by the merchant or used to generate a token |
Array of objects Checkout process events | |
transaction_id | string Transaction which has been created using the checkout. |
object metadata about the session |
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": { }
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable"
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
]
}, - "discounts": {
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}
}
{- "order": {
- "discount_codes": [
- "string"
], - "amount": 72200,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "external",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
]
}, - "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}
]
}
This API endpoint on the merchant side allows Dintero to notify
the session.url.callback_url
when the payment is completed
The
transaction_id
is optional ifreport_error=true
transaction_id required | string The Id for the transaction created |
merchant_reference required | string The merchants reference |
time required | string <date-time> ISO 8601 format for when the transaction was created |
session_id | string Session Id. Either |
sid | string Session Id if |
error | string Example: error=authorization Error code |
event | string Event applied to transaction |
event_id | string Example: event_id=3 Id for the event applied to transaction |
method | string Example: method=POST The method to use when delivering the callback |
report_error | boolean Report error callback |
delay_callback | integer Delay before delivering the callback |
report_event | string Example: report_event=CAPTURE Deliver callback on othe transaction events |
Dintero-Signature | string Dintero signature that can be used to verify the payload from the callback. Only include if a signature secret exist: |
{ }
This API endpoint on the merchant side allows Dintero to notify
the session.url.callback_url
when the payment is completed
POST is only use if
callback_url
includesmethod=POST
query parameter.
The
body
andtransaction_id
is optional ifreport_error=true
transaction_id required | string The Id for the transaction created |
merchant_reference required | string The merchants reference |
time required | string <date-time> ISO 8601 format for when the transaction was created |
method required | string Example: method=POST POST method used to deliver the callback |
includes required | string Example: includes=session Aditional data included |
session_id | string Session Id. Either |
sid | string Session Id if |
error | string Example: error=authorization Error code |
event | string Event applied to transaction |
event_id | string Example: event_id=3 Id for the event applied to transaction |
report_error | boolean Report error callback |
delay_callback | integer Delay before delivering the callback |
report_event | string Example: report_event=CAPTURE Deliver callback on othe transaction events |
Dintero-Signature | string Dintero signature that can be used to verify the payload from the callback. Only include if a signature secret exist: |
payment_product required | string The payment product corresponding to this transaction |
amount required | integer Non-negative, minor units. Total amount of the transaction |
currency required | string <iso4217-code> ISO 4217 transaction currency |
payment_product_type required | string Enum: "bambora.creditcard" "bambora.vipps" The payment product type corresponding to this transaction |
id | string An ID that uniquely identifies the resource |
payout_destination_id | string <= 40 characters An id that identifies the seller, value will be included in the settlement reports |
merchant_reference | string A reference specified by the merchant to identify the transaction |
merchant_reference_2 | string A reference specified by the merchant to identify the transaction, can be updated after the transaction has been created |
dynamic_descriptor | string A short reference / descriptor that will show up on the customers bank statement |
payment_operation | string (PaymentOperationIntent) Enum: "unscheduled_purchase" "recurring_purchase" "generate_payment_token" Initiated by the merchant or used to generate a token |
settlement_status | string (SettlementStatus) Enum: "NOT_SETTLED" "PENDING_SETTLEMENT" "PARTIALLY_SETTLED" "SETTLED" Overall settlement status after the events |
object | |
customer_ip | string The IP address of the customer |
user_agent | string The full user agent string of the device the customer used to submit the transaction |
object (SystemRequestHeaders) | |
object (OrderAddress) Address | |
object (SplitShippingOption) A shipping option | |
object (OrderAddress) Address | |
object (Store) | |
Array of objects (Giftcard) The gift cards that used to partially or fully authorize the transaction | |
Array of objects The applicable transaction items | |
object | |
Array of objects All events recorded on the transaction | |
session_id | string The session id for the transaction |
object (Session) | |
updated_at | string <date-time> When the transaction was last modified. |
created_at | string <date-time> When the transaction was created |
object Additional details about the transaction | |
Array of objects (CheckboxConfiguration) <= 2 items Configuration for checkboxes that should be part of the checkout | |
object |
{- "id": "string",
- "payment_product": "bambora",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1",
- "metadata": {
- "bambora:transaction:status": "string",
- "bambora:transactionoperation:id": "string",
- "bambora:meta:action:source": "string",
- "bambora:meta:action:code": "string",
- "bambora:meta:action:type": "string"
}
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable"
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
]
}, - "discounts": {
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string",
- "gateway:id": "string",
- "bambora:merchant_number": "string",
- "bambora:transaction_id": "string",
- "bambora:reference": "string",
- "bambora:acquirer": "string",
- "bambora:wallet": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "payment_product_type": "bambora.creditcard",
- "card": {
- "brand": "Visa",
- "masked_pan": "476173******0416",
- "expiry_date": "string",
- "type": "Credit Card",
- "eci": "string",
- "country": "string"
}, - "status": "CAPTURED"
}
{ }
This API endpoint on the merchant side allows Dintero to get shipping options based on the provided session after an address update
required | object (SessionOrder) |
required | object (SessionUrls) |
required | object (PaymentConfiguration) |
id | string An ID that uniquely identifies the resource |
created_at | string <date-time> The date-time when the resource was created |
object | |
expires_at | string <date-time> The session expiration time after which the Checkout page wouldn't be available |
Array of objects (CheckboxConfiguration) <= 2 items Configuration for checkboxes that should be part of the checkout | |
object Present only for Express Checkout sessions.An Express Checkout session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated. Endpoints used in the Express Checkout flow. | |
updated_at | string <date-time> Last time when the Checkout was updated |
customer_ip | string The IP of the customer upon visiting the page. If the page is visited multiple times, the field is always updated with the last known value. |
user_agent | string The full user agent of the device the customer used when visiting the checkout page |
object (SystemRequestHeaders) | |
payment_operation | string (PaymentOperationIntent) Enum: "unscheduled_purchase" "recurring_purchase" "generate_payment_token" Initiated by the merchant or used to generate a token |
Array of objects Checkout process events | |
transaction_id | string Transaction which has been created using the checkout. |
object metadata about the session |
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}, - "gift_cards": {
- "dintero.wallets": [
- {
- "card_id": "string",
- "masked_card_token": "string"
}
]
}, - "tokens": {
- "payex.creditcard": { }
}
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable"
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
]
}, - "discounts": {
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
},
}, - "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string",
- "metadata": {
- "session:profile_id": "string"
}
}
{- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}
], - "order": {
- "amount": 29990,
- "currency": "NOK",
- "vat_amount": 6000,
- "items": [
- {
- "id": "item_01",
- "groups": [
- {
- "id": "B234",
- "name": "Stol"
}
], - "line_id": "1",
- "version": 0,
- "description": "Stablestol",
- "quantity": 1,
- "amount": 2000,
- "vat_amount": 400,
- "vat": 20,
- "unit_volume": 0,
- "unit_weight": 0,
- "unit_dimensional_weight": 0,
- "type": "physical",
- "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
], - "emd": {
- "event": [
- {
- "event_name": "Michael Jackson",
- "event_company": "Diamond Events",
- "genre_of_event": "Pop",
- "arena_name": "Oslo Spektrum",
- "arena_location": {
- "street_address": "Sonja Henies plass 2",
- "postal_code": "0185",
- "city": "Oslo",
- "country": "NO"
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-16T16:00:00Z",
- "access_controlled_venue": true,
- "ticket_delivery_method": "email",
- "ticket_delivery_recipient": "recipient@mail.com",
- "affiliate_name": "Klarna affiliate"
}
], - "subscription": {
- "subscription": {
- "subscription_name": "Contact lenses",
- "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-09-16T15:00:00Z",
- "auto_renewal_of_subscription": true,
- "affiliate_name": "Klarna affiliate"
}, - "customer_account_info": {
- "unique_account_identifier": "Adam Adamsson",
- "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": "2023-10-16T15:00:00Z"
}
}, - "travel": {
- "air_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure": "OSL",
- "departure_city": "Oslo",
- "arrival": "MUC",
- "arrival_city": "Munich",
- "carrier": "LH",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "bus_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Bus Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "train_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Train Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "ferry_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Ferry Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "hotel_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "hotel_name": "Premium Hotel",
- "address": {
- "street_address": null,
- "postal_code": null,
- "city": null,
- "country": null
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-20T15:00:00Z",
- "number_of_rooms": 2,
- "passenger_id": [
- 1
], - "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "hotel_price": 200000,
- "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "car_rental_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "rental_company": "Premium Cars",
- "drivers_id": [
- 1
], - "pick_up_location": {
- "street_address": null,
- "postal_code": null,
- "city": null,
- "country": null
}, - "drop_off_location": {
- "street_address": null,
- "postal_code": null,
- "city": null,
- "country": null
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-20T15:00:00Z",
- "car_price": 500000,
- "class": "Premium Cars Premium Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "drivers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}
}, - "marketplace_order": {
- "seller_info": {
- "unique_account_identifier_seller": {
- "email": "string",
- "phone_number": "97712123",
- "other": "string"
}, - "sub_merchant_id": "Marketbrick Ltd.",
- "product_category": "Phones",
- "product_name": "iPhone 14 Pro Max",
- "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": {
- "password": "2023-08-17T15:00:00Z",
- "email": "2023-08-17T15:00:00Z",
- "listing": "2023-08-17T15:00:00Z",
- "login": "2023-08-17T15:00:00Z",
- "address": "2023-08-17T15:00:00Z"
}, - "seller_rating": 5,
- "number_of_trades": 23,
- "volume_of_trades": 230
}, - "winner_info": {
- "unique_account_identifier_winner": {
- "email": "string",
- "phone_number": "97712123",
- "other": "string"
}, - "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": {
- "password": "2023-08-17T15:00:00Z",
- "email": "2023-08-17T15:00:00Z",
- "listing": "2023-08-17T15:00:00Z",
- "login": "2023-08-17T15:00:00Z",
- "address": "2023-08-17T15:00:00Z"
}, - "number_of_trades": 23,
- "volume_of_trades": 230
}
}
}, - "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 0,
- "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
]
}
], - "discount_codes": [
- "SUMMER20"
]
}
}
scopes:
id | Array of strings <checkout-id> [ items <checkout-id > ] List of ids that should be included in the result. ?id=A&id=B&id=X |
limit | integer [ 1 .. 100 ] Default: 10 A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items. |
starting_after | string <checkout-id> cursor for use in pagination. starting_after is an object ID
that defines your place in the list. For instance, if you make
a list request and receive 100 objects, ending with |
status | Array of strings Items Enum: "AUTHORIZATION_VOIDED" "AUTHORIZED" "CAPTURED" "DECLINED" "FAILED" "INITIATED" "ON_HOLD" "PARTIALLY_CAPTURED" "PARTIALLY_REFUNDED" "PARTIALLY_CAPTURED_REFUNDED" "REFUNDED" "UNKNOWN" The status of the transaction. |
payment_product | Array of strings The type of payment product used |
payment_product_type | Array of strings The payment product type |
card_brand | Array of strings The card brand for the payment |
merchant_reference | string The merchant reference used |
merchant_reference_2 | string The second merchant reference on the transaction |
session_id | Array of strings <checkout-id> [ items <checkout-id > ] The session id(s) associated with the transactions. ?session_id=A&session_id=B&session_id=X. |
store_id | Array of strings The store_id that the transaction belongs to. ?store_id=A&store_id=B&store_id=X. |
payout_correlation_id | Array of strings Filter by the |
currency | Array of strings The currency of the transaction. ?currency=NOK¤cy=SEK. |
amount | integer >= 0 Exact transaction amount, amount authorized. |
amount.gte | integer >= 0 Lower limit for filtering on transaction amount, amount authorized. |
amount.lte | integer Upper limit for filtering on transaction amount, amount authorized. |
created_at.gte | string <isodate> Transaction created after (ISO 8601. We recommend using a localised ISO 8601 datetime like |
created_at.lte | string <isodate> Transaction created before a date (ISO 8601. We recommend using a localised ISO 8601 datetime like |
captured_at.gte | string <isodate> Transaction captured after date (This param is subject to change in the future) (ISO 8601. We recommend using a localised ISO 8601 datetime like |
captured_at.lte | string <isodate> Transaction captured before date (This param is subject to change in the future) (ISO 8601. We recommend using a localised ISO 8601 datetime like |
refunded_at.gte | string <isodate> Transaction refunded after date (This param is subject to change in the future) (ISO 8601. We recommend using a localised ISO 8601 datetime like |
refunded_at.lte | string <isodate> Transaction refunded before date (This param is subject to change in the future) (ISO 8601. We recommend using a localised ISO 8601 datetime like |
search | string Will try to match the search to either transaction_id, session_id or merchant_reference, merchant_reference_2,
phone_number, email or the customer name using the format |
payment_operation | string Example: payment_operation=unscheduled_purchase Filter on |
customer_id | string Filter transactions on the |
[- {
- "id": "P00000000.465UfBENeLpkBvwmqfTC4k",
- "payment_product": "string",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1"
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
]
}
]
scopes:
id required | string <checkout-id> The ID of the transaction |
includes | Array of strings Items Enum: "card.payment_token" "card.recurrence_token" "session" "events.request_headers" "initiating_system_request_headers" Include aditional data that are by default excluded from the transaction details.
|
{- "id": "string",
- "payment_product": "bambora",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1",
- "metadata": {
- "bambora:transaction:status": "string",
- "bambora:transactionoperation:id": "string",
- "bambora:meta:action:source": "string",
- "bambora:meta:action:code": "string",
- "bambora:meta:action:type": "string"
}
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string",
- "gateway:id": "string",
- "bambora:merchant_number": "string",
- "bambora:transaction_id": "string",
- "bambora:reference": "string",
- "bambora:acquirer": "string",
- "bambora:wallet": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "payment_product_type": "bambora.creditcard",
- "card": {
- "brand": "Visa",
- "masked_pan": "476173******0416",
- "expiry_date": "string",
- "type": "Credit Card",
- "eci": "string",
- "country": "string"
}
}
scopes:
id required | string <checkout-id> The ID of the transaction |
merchant_reference_2 | string A reference specified by the merchant to identify the transaction, can be updated after the transaction has been created |
{- "merchant_reference_2": "string"
}
{- "id": "string",
- "payment_product": "bambora",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1",
- "metadata": {
- "bambora:transaction:status": "string",
- "bambora:transactionoperation:id": "string",
- "bambora:meta:action:source": "string",
- "bambora:meta:action:code": "string",
- "bambora:meta:action:type": "string"
}
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string",
- "gateway:id": "string",
- "bambora:merchant_number": "string",
- "bambora:transaction_id": "string",
- "bambora:reference": "string",
- "bambora:acquirer": "string",
- "bambora:wallet": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "payment_product_type": "bambora.creditcard",
- "card": {
- "brand": "Visa",
- "masked_pan": "476173******0416",
- "expiry_date": "string",
- "type": "Credit Card",
- "eci": "string",
- "country": "string"
}
}
Captures a transaction that was created with the Checkout
endpoint with a capture_now
value of false
.
Note that items
is required when capturing a transaction
with payment_product=instabank
. The items must include
the lines to Capture, with line_id
, quantity
and amount
.
scopes:
id required | string <checkout-id> The ID of the transaction |
includes | Array of strings Items Enum: "events.request_headers" "initiating_system_request_headers" Include aditional data in the returned data that are by default excluded from the transaction details.
From 2023-09, |
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
amount required | integer <int32> The amount to be captured |
capture_reference | string A reference specified by the merchant to identify the transaction |
Array of objects Info about the captured order items Instabank
|
{- "amount": 0,
- "capture_reference": "string",
- "items": [
- {
- "id": "item_01",
- "groups": [
- {
- "id": "B234",
- "name": "Stol"
}
], - "line_id": "1",
- "description": "Stablestol",
- "quantity": 1,
- "amount": 29990,
- "vat_amount": 400,
- "vat": 20,
- "unit_volume": 0,
- "unit_weight": 0,
- "unit_dimensional_weight": 0,
- "type": "physical",
- "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
], - "emd": {
- "event": [
- {
- "event_name": "Michael Jackson",
- "event_company": "Diamond Events",
- "genre_of_event": "Pop",
- "arena_name": "Oslo Spektrum",
- "arena_location": {
- "street_address": "Sonja Henies plass 2",
- "postal_code": "0185",
- "city": "Oslo",
- "country": "NO"
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-16T16:00:00Z",
- "access_controlled_venue": true,
- "ticket_delivery_method": "email",
- "ticket_delivery_recipient": "recipient@mail.com",
- "affiliate_name": "Klarna affiliate"
}
], - "subscription": {
- "subscription": {
- "subscription_name": "Contact lenses",
- "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-09-16T15:00:00Z",
- "auto_renewal_of_subscription": true,
- "affiliate_name": "Klarna affiliate"
}, - "customer_account_info": {
- "unique_account_identifier": "Adam Adamsson",
- "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": "2023-10-16T15:00:00Z"
}
}, - "travel": {
- "air_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure": "OSL",
- "departure_city": "Oslo",
- "arrival": "MUC",
- "arrival_city": "Munich",
- "carrier": "LH",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "bus_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Bus Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "train_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Train Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "ferry_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Ferry Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "hotel_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "hotel_name": "Premium Hotel",
- "address": {
- "street_address": "Karl Johans gt. 31",
- "postal_code": "0159",
- "city": "Oslo",
- "country": "NO"
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-20T15:00:00Z",
- "number_of_rooms": 2,
- "passenger_id": [
- 1
], - "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "hotel_price": 200000,
- "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "car_rental_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "rental_company": "Premium Cars",
- "drivers_id": [
- 1
], - "pick_up_location": {
- "street_address": "Karl Johans gt. 31",
- "postal_code": "0159",
- "city": "Oslo",
- "country": "NO"
}, - "drop_off_location": {
- "street_address": "Karl Johans gt. 31",
- "postal_code": "0159",
- "city": "Oslo",
- "country": "NO"
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-20T15:00:00Z",
- "car_price": 500000,
- "class": "Premium Cars Premium Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "drivers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}
}, - "marketplace_order": {
- "seller_info": {
- "unique_account_identifier_seller": {
- "email": "string",
- "phone_number": "97712123",
- "other": "string"
}, - "sub_merchant_id": "Marketbrick Ltd.",
- "product_category": "Phones",
- "product_name": "iPhone 14 Pro Max",
- "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": {
- "password": "2023-08-17T15:00:00Z",
- "email": "2023-08-17T15:00:00Z",
- "listing": "2023-08-17T15:00:00Z",
- "login": "2023-08-17T15:00:00Z",
- "address": "2023-08-17T15:00:00Z"
}, - "seller_rating": 5,
- "number_of_trades": 23,
- "volume_of_trades": 230
}, - "winner_info": {
- "unique_account_identifier_winner": {
- "email": "string",
- "phone_number": "97712123",
- "other": "string"
}, - "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": {
- "password": "2023-08-17T15:00:00Z",
- "email": "2023-08-17T15:00:00Z",
- "listing": "2023-08-17T15:00:00Z",
- "login": "2023-08-17T15:00:00Z",
- "address": "2023-08-17T15:00:00Z"
}, - "number_of_trades": 23,
- "volume_of_trades": 230
}
}
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
]
}
]
}
{- "id": "string",
- "payment_product": "bambora",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1",
- "metadata": {
- "bambora:transaction:status": "string",
- "bambora:transactionoperation:id": "string",
- "bambora:meta:action:source": "string",
- "bambora:meta:action:code": "string",
- "bambora:meta:action:type": "string"
}
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string",
- "gateway:id": "string",
- "bambora:merchant_number": "string",
- "bambora:transaction_id": "string",
- "bambora:reference": "string",
- "bambora:acquirer": "string",
- "bambora:wallet": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "payment_product_type": "bambora.creditcard",
- "card": {
- "brand": "Visa",
- "masked_pan": "476173******0416",
- "expiry_date": "string",
- "type": "Credit Card",
- "eci": "string",
- "country": "string"
}
}
Once a transaction has been successfully captured, a refund operation is available. Like other operations, refund can be partial or total
Note that items
is required when refunding a transaction
with payment_product=instabank
. The items must include the
lines to Refund, with line_id
, quantity
and amount
.
scopes:
id required | string <checkout-id> The ID of the transaction |
includes | Array of strings Items Enum: "events.request_headers" "initiating_system_request_headers" Include aditional data in the returned data that are by default excluded from the transaction details.
From 2023-09, |
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
amount required | integer <int32> The amount to be refunded |
reason | string The reason of the refund |
refund_reference | string A reference specified by the merchant to identify the transaction |
Array of objects Info about the refunded order items Instabank
|
{- "amount": 0,
- "reason": "string",
- "refund_reference": "string",
- "items": [
- {
- "id": "item_01",
- "groups": [
- {
- "id": "B234",
- "name": "Stol"
}
], - "line_id": "1",
- "description": "Stablestol",
- "quantity": 1,
- "amount": 29990,
- "vat_amount": 400,
- "vat": 20,
- "unit_volume": 0,
- "unit_weight": 0,
- "unit_dimensional_weight": 0,
- "type": "physical",
- "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
], - "emd": {
- "event": [
- {
- "event_name": "Michael Jackson",
- "event_company": "Diamond Events",
- "genre_of_event": "Pop",
- "arena_name": "Oslo Spektrum",
- "arena_location": {
- "street_address": "Sonja Henies plass 2",
- "postal_code": "0185",
- "city": "Oslo",
- "country": "NO"
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-16T16:00:00Z",
- "access_controlled_venue": true,
- "ticket_delivery_method": "email",
- "ticket_delivery_recipient": "recipient@mail.com",
- "affiliate_name": "Klarna affiliate"
}
], - "subscription": {
- "subscription": {
- "subscription_name": "Contact lenses",
- "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-09-16T15:00:00Z",
- "auto_renewal_of_subscription": true,
- "affiliate_name": "Klarna affiliate"
}, - "customer_account_info": {
- "unique_account_identifier": "Adam Adamsson",
- "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": "2023-10-16T15:00:00Z"
}
}, - "travel": {
- "air_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure": "OSL",
- "departure_city": "Oslo",
- "arrival": "MUC",
- "arrival_city": "Munich",
- "carrier": "LH",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "bus_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Bus Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "train_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Train Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "ferry_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "departure_city": "Oslo",
- "arrival_city": "Munich",
- "carrier": "Big Ferry Travels Ltd.",
- "segment_price": 200000,
- "departure_date": "2023-08-16T15:00:00Z",
- "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "passenger_id": [
- 1
], - "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "hotel_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "hotel_name": "Premium Hotel",
- "address": {
- "street_address": "Karl Johans gt. 31",
- "postal_code": "0159",
- "city": "Oslo",
- "country": "NO"
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-20T15:00:00Z",
- "number_of_rooms": 2,
- "passenger_id": [
- 1
], - "ticket_delivery_method": "phone",
- "ticket_delivery_recipient": "97712123",
- "hotel_price": 200000,
- "class": "First Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "passengers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}, - "car_rental_reservation_details": {
- "pnr": "VH67899",
- "itinerary": [
- {
- "rental_company": "Premium Cars",
- "drivers_id": [
- 1
], - "pick_up_location": {
- "street_address": "Karl Johans gt. 31",
- "postal_code": "0159",
- "city": "Oslo",
- "country": "NO"
}, - "drop_off_location": {
- "street_address": "Karl Johans gt. 31",
- "postal_code": "0159",
- "city": "Oslo",
- "country": "NO"
}, - "start_time": "2023-08-16T15:00:00Z",
- "end_time": "2023-08-20T15:00:00Z",
- "car_price": 500000,
- "class": "Premium Cars Premium Class"
}
], - "insurance": [
- {
- "insurance_company": "Oopsie Insurance Ltd.",
- "insurance_type": "travel",
- "insurance_price": 50000
}
], - "drivers": [
- {
- "id": 1,
- "title": "mr",
- "first_name": "Paul",
- "last_name": "Lamb"
}
], - "affiliate_name": "Klarna affiliate"
}
}, - "marketplace_order": {
- "seller_info": {
- "unique_account_identifier_seller": {
- "email": "string",
- "phone_number": "97712123",
- "other": "string"
}, - "sub_merchant_id": "Marketbrick Ltd.",
- "product_category": "Phones",
- "product_name": "iPhone 14 Pro Max",
- "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": {
- "password": "2023-08-17T15:00:00Z",
- "email": "2023-08-17T15:00:00Z",
- "listing": "2023-08-17T15:00:00Z",
- "login": "2023-08-17T15:00:00Z",
- "address": "2023-08-17T15:00:00Z"
}, - "seller_rating": 5,
- "number_of_trades": 23,
- "volume_of_trades": 230
}, - "winner_info": {
- "unique_account_identifier_winner": {
- "email": "string",
- "phone_number": "97712123",
- "other": "string"
}, - "account_registration_date": "2023-08-16T15:00:00Z",
- "account_last_modified": {
- "password": "2023-08-17T15:00:00Z",
- "email": "2023-08-17T15:00:00Z",
- "listing": "2023-08-17T15:00:00Z",
- "login": "2023-08-17T15:00:00Z",
- "address": "2023-08-17T15:00:00Z"
}, - "number_of_trades": 23,
- "volume_of_trades": 230
}
}
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
]
}
]
}
{- "id": "string",
- "payment_product": "bambora",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1",
- "metadata": {
- "bambora:transaction:status": "string",
- "bambora:transactionoperation:id": "string",
- "bambora:meta:action:source": "string",
- "bambora:meta:action:code": "string",
- "bambora:meta:action:type": "string"
}
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string",
- "gateway:id": "string",
- "bambora:merchant_number": "string",
- "bambora:transaction_id": "string",
- "bambora:reference": "string",
- "bambora:acquirer": "string",
- "bambora:wallet": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "payment_product_type": "bambora.creditcard",
- "card": {
- "brand": "Visa",
- "masked_pan": "476173******0416",
- "expiry_date": "string",
- "type": "Credit Card",
- "eci": "string",
- "country": "string"
}
}
At any moment before capture of a transaction, it is possible to cancel an authorization. This operation is called voiding and can be performed by doing a POST to this endpoint
Void after a part capture will cancel the difference between the capture amount and the authorization amount.
Void on part capture is only supported on following types:
payex.creditcard
payex.mobilepay
payex.vipps
payex.applepay
payex.clicktopay
payex.googlepay
vipps
klarna.klarna
klarna.billie
scopes:
id required | string <checkout-id> The ID of the transaction |
includes | Array of strings Items Enum: "events.request_headers" "initiating_system_request_headers" Include aditional data in the returned data that are by default excluded from the transaction details.
From 2023-09, |
Dintero-System-Name | string <= 120 characters The name of the ecommerce solution Example: |
Dintero-System-Version | string <= 120 characters The version number of the ecommerce solution Example: |
Dintero-System-Plugin-Name | string <= 120 characters The name of the ecommerce plugin Example: |
Dintero-System-Plugin-Version | string <= 120 characters The version number of the ecommerce plugin Example: |
{- "id": "string",
- "payment_product": "bambora",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1",
- "metadata": {
- "bambora:transaction:status": "string",
- "bambora:transactionoperation:id": "string",
- "bambora:meta:action:source": "string",
- "bambora:meta:action:code": "string",
- "bambora:meta:action:type": "string"
}
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string",
- "gateway:id": "string",
- "bambora:merchant_number": "string",
- "bambora:transaction_id": "string",
- "bambora:reference": "string",
- "bambora:acquirer": "string",
- "bambora:wallet": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "payment_product_type": "bambora.creditcard",
- "card": {
- "brand": "Visa",
- "masked_pan": "476173******0416",
- "expiry_date": "string",
- "type": "Credit Card",
- "eci": "string",
- "country": "string"
}
}
Add settlement events to list of transactions
scopes:
required | Array of objects [ 1 .. 100 ] items Each transaction can have multiple settlements |
null
[- {
- "id": "P00000000.465UfBENeLpkBvwmqfTC4k",
- "payment_product": "string",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1"
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
]
}
]
scopes:
name required | string |
access_token | string <jwt> |
api_key | string^[PT]{1}\d{8}.*$ specify the api-key |
{- "name": "string",
- "access_token": "string",
- "api_key": "string"
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "deleted_by": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "api_key": "string"
}
scopes:
include_deleted | boolean Default: false include deleted api-keys in the response |
limit | integer [ 1 .. 100 ] Default: 10 A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items. |
starting_after | string <checkout-id> cursor for use in pagination. starting_after is an object ID
that defines your place in the list. For instance, if you make
a list request and receive 100 objects, ending with |
[- {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "deleted_by": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
scopes:
api_key_id required | string |
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "deleted_by": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
scopes:
api_key_id required | string |
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "deleted_by": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "api_key": "string"
}
scopes:
required | object Configure merchant and payment options |
{- "configuration": {
- "payout": {
- "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "payment_options": [
- {
- "type": "bambora.creditcard",
- "details": {
- "bambora_token_scope": "string",
- "gateway_api_versions": [
- "payex.v2"
], - "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}, - "currencies": [
- "NOK"
]
}
], - "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}
}
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "gateways": {
- "bambora": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "token_scope": "string",
- "merchant_number": "string"
}, - "instabank": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "organization_number": 12345678911,
- "payment_product_codes": {
- "instabank.finance": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}, - "instabank.invoice": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}, - "instabank.installment": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
], - "instabank.postponement": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "klarna": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "username": "PK27631_9dfg28uy0p43",
- "merchant_id": "PK27631"
}, - "payex": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "versions": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}
}, - "overrides": {
- "property1": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789"
}, - "versions": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}
}
}, - "property2": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789"
}, - "versions": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}
}
}
}
}, - "vipps": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "client_id": "string",
- "merchant_serial_number": "123456",
- "overrides": {
- "property1": {
- "override": {
- "client_id": "string",
- "merchant_serial_number": "123456",
- "ocp_apim_subscription_key_access_token": "string",
- "ocp_apim_subscription_key_ecom": "string"
}
}, - "property2": {
- "override": {
- "client_id": "string",
- "merchant_serial_number": "123456",
- "ocp_apim_subscription_key_access_token": "string",
- "ocp_apim_subscription_key_ecom": "string"
}
}
}
}, - "collector": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "username": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}, - "stores": [
- {
- "store_id": 0,
- "country": "string",
- "currency": "NOK",
- "segment": "B2C"
}
], - "overrides": {
- "property1": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "username": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}, - "stores": [
- {
- "store_id": 0,
- "country": "string",
- "currency": "NOK",
- "segment": "B2C"
}
]
}
}, - "property2": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "username": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}, - "stores": [
- {
- "store_id": 0,
- "country": "string",
- "currency": "NOK",
- "segment": "B2C"
}
]
}
}
}
}, - "santander": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "store_email": "string",
- "branding_name": "Bygger'n",
- "overrides": {
- "property1": {
- "override": {
- "store_email": "string"
}
}, - "property2": {
- "override": {
- "store_email": "string"
}
}
}
}, - "dintero_psp": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "visa_net_client_id": "string",
- "acquirer_merchant_id": "string",
- "vipps_merchant_serial_number": "123456",
- "visa_token_client_app_id": "string",
- "visa_token_relationship_id": "10000000-20000000000"
}, - "netaxept": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "merchant_id": "string",
- "overrides": {
- "property1": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "merchant_id": "string"
}
}, - "property2": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "merchant_id": "string"
}
}
}
}, - "swish": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "swish_number": "string",
- "overrides": {
- "property1": {
- "override": {
- "swish_number": "string"
}
}, - "property2": {
- "override": {
- "swish_number": "string"
}
}
}
}
}, - "credentials": {
- "payex": [
- {
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1,
}
], - "klarna": [
- {
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1,
}
], - "collector": [
- {
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1,
- "data": {
- "username": "string",
- "password": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "customer_client": {
- "customers_client_id": "string",
- "customers_client_secret": "string",
- "customers_client_audience": "string"
}, - "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}
}
}
]
}, - "configuration": {
- "payout": {
- "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "payment_options": [
- {
- "type": "bambora.creditcard",
- "details": {
- "bambora_token_scope": "string",
- "gateway_api_versions": [
- "payex.v2"
], - "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}, - "currencies": [
- "NOK"
]
}
], - "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}
}
}
scopes:
includes | Array of strings Items Value: "credentials" Include aditional data that are by default excluded from the checkout details.
|
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "gateways": {
- "bambora": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "token_scope": "string",
- "merchant_number": "string"
}, - "instabank": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "organization_number": 12345678911,
- "payment_product_codes": {
- "instabank.finance": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}, - "instabank.invoice": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}, - "instabank.installment": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
], - "instabank.postponement": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "klarna": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "username": "PK27631_9dfg28uy0p43",
- "merchant_id": "PK27631"
}, - "payex": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "versions": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}
}, - "overrides": {
- "property1": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789"
}, - "versions": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}
}
}, - "property2": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789"
}, - "versions": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "payee_id": "string",
- "subsite": "12345789",
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}
}
}
}
}, - "vipps": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "client_id": "string",
- "merchant_serial_number": "123456",
- "overrides": {
- "property1": {
- "override": {
- "client_id": "string",
- "merchant_serial_number": "123456",
- "ocp_apim_subscription_key_access_token": "string",
- "ocp_apim_subscription_key_ecom": "string"
}
}, - "property2": {
- "override": {
- "client_id": "string",
- "merchant_serial_number": "123456",
- "ocp_apim_subscription_key_access_token": "string",
- "ocp_apim_subscription_key_ecom": "string"
}
}
}
}, - "collector": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "username": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}, - "stores": [
- {
- "store_id": 0,
- "country": "string",
- "currency": "NOK",
- "segment": "B2C"
}
], - "overrides": {
- "property1": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "username": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}, - "stores": [
- {
- "store_id": 0,
- "country": "string",
- "currency": "NOK",
- "segment": "B2C"
}
]
}
}, - "property2": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "username": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}, - "stores": [
- {
- "store_id": 0,
- "country": "string",
- "currency": "NOK",
- "segment": "B2C"
}
]
}
}
}
}, - "santander": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "store_email": "string",
- "branding_name": "Bygger'n",
- "overrides": {
- "property1": {
- "override": {
- "store_email": "string"
}
}, - "property2": {
- "override": {
- "store_email": "string"
}
}
}
}, - "dintero_psp": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "visa_net_client_id": "string",
- "acquirer_merchant_id": "string",
- "vipps_merchant_serial_number": "123456",
- "visa_token_client_app_id": "string",
- "visa_token_relationship_id": "10000000-20000000000"
}, - "netaxept": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "merchant_id": "string",
- "overrides": {
- "property1": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "merchant_id": "string"
}
}, - "property2": {
- "override": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "merchant_id": "string"
}
}
}
}, - "swish": {
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "swish_number": "string",
- "overrides": {
- "property1": {
- "override": {
- "swish_number": "string"
}
}, - "property2": {
- "override": {
- "swish_number": "string"
}
}
}
}
}, - "credentials": {
- "payex": [
- {
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1,
}
], - "klarna": [
- {
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1,
}
], - "collector": [
- {
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1,
- "data": {
- "username": "string",
- "password": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "customer_client": {
- "customers_client_id": "string",
- "customers_client_secret": "string",
- "customers_client_audience": "string"
}, - "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}
}
}
]
}, - "configuration": {
- "payout": {
- "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "payment_options": [
- {
- "type": "bambora.creditcard",
- "details": {
- "bambora_token_scope": "string",
- "gateway_api_versions": [
- "payex.v2"
], - "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}, - "currencies": [
- "NOK"
]
}
], - "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}
}
}
verify the gateway configuration
scopes:
gateway required | string Enum: "bambora" "collector" "instabank" "netaxept" "payex" "santander" "swish" "vipps" |
override_id | string The id of the override that the status should be checked for. If empty, checks the root gateway config. |
{- "override_id": "STORE_1"
}
{- "status": 0
}
Handle async update of transaction.
scopes:
intent required | string Enum: "cancel_unknown" "retry_auto_capture" "retry_refund" "sync_status" "poll_initiated" retry_auto_capture Retry the capture of a transaction that was created by a session with auto-capture enabled. A success is return if the transaction new state is captured. cancel_unknown Cancel a transaction that failed the athorization check done before the redirect to the merchant. sync_status Sync the status of a transaction that is not in sync with the status in the payment gateway poll_initiated Poll the status of a transaction with status
retry_refund Retry refund of a transaction with status |
id required | string The transaction id |
required | object (Transaction) |
null
{- "id": "string",
- "payment_product": "bambora",
- "amount": 72200,
- "currency": "NOK",
- "payout_destination_id": "string",
- "merchant_reference": "string",
- "merchant_reference_2": "string",
- "dynamic_descriptor": "string",
- "payment_operation": "unscheduled_purchase",
- "settlement_status": "NOT_SETTLED",
- "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999",
- "my_dintero": {
- "actions": [
- "create_user"
],
}
}, - "customer_ip": "127.0.0.1",
- "user_agent": "Mozilla/5.0 ...",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "status": "CAPTURED",
- "gift_cards": [
- {
- "type": "dintero.wallets",
- "card_id": "string",
- "amount": 0,
- "masked_card_token": "string"
}
], - "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "url": {
}, - "events": [
- {
- "event": "INITIATE",
- "transaction_status": "INITIATED",
- "created_at": "2019-01-18T13:13:37.175Z",
- "success": true,
- "request_id": "a3dcc23125bc4363b9dae29ed25a4eb1",
- "metadata": {
- "bambora:transaction:status": "string",
- "bambora:transactionoperation:id": "string",
- "bambora:meta:action:source": "string",
- "bambora:meta:action:code": "string",
- "bambora:meta:action:type": "string"
}
}, - {
- "event": "AUTHORIZE",
- "transaction_status": "AUTHORIZED",
- "created_at": "2019-01-18T13:13:37.540Z",
- "success": true,
- "request_id": "f5f64165e5b3404e9af63586c184c3e9"
}, - {
- "event": "CAPTURE",
- "transaction_status": "PARTIALLY_CAPTURED",
- "created_at": "2019-01-18T15:37:00.879Z",
- "created_by": "99115ac5-2d10-4be4-8594-bbf5e3aa7dfc",
- "amount": 59700,
- "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}, - {
- "payout_destination_id": "P000000002",
- "amount": 30000
}
], - "fee_split": {
- "type": "proportional",
- "destinations": [
- "P000000001"
]
}, - "items": [
- {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3"
}
], - "success": true,
- "request_id": "27c71936004e48649c6dd437d314d90c"
}, - {
- "event": "CAPTURE",
- "transaction_status": "CAPTURED",
- "created_at": "2019-01-18T21:24:31.669Z",
- "created_by": "a33aef94-a17d-447a-a1dd-81055892b59d",
- "amount": 8600,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2"
}
], - "success": true,
- "request_id": "c3e60b98a1d1466c97151318be621cf9"
}
], - "session_id": "P00000000.465U8CUzaPVpneu1wt8Wei",
- "session": {
- "url": {
}, - "customer": {
- "customer_id": "string",
- "email": "john.doe@example.com",
- "phone_number": "+4799999999"
}, - "order": {
- "amount": 72200,
- "currency": "NOK",
- "vat_amount": 13660,
- "merchant_reference_2": "string",
- "shipping_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}, - "partial_payment": false,
- "items": [
- {
- "amount": 2000,
- "quantity": 2,
- "line_id": "1",
- "description": "Forsvinnignspølse",
- "vat": 20,
- "id": "10"
}, - {
- "amount": 6600,
- "quantity": 2,
- "line_id": "2",
- "description": "Vissvossafår på neppebrød",
- "vat": 20,
- "id": "6",
- "eligible_for_discount": true,
- "is_changed": true,
- "gross_amount": 10000,
- "discount_lines": [
- {
- "amount": 4400,
- "discount_type": "customer",
- "discount_id": "ed960ace-eb16-4e2e-ae52-b27647ccae8d",
- "description": "Vossafestpris",
- "line_id": 1
}
]
}, - {
- "amount": 59700,
- "quantity": 3,
- "line_id": "3",
- "description": "Luftboller",
- "vat": 20,
- "id": "1"
}
], - "gross_amount": 0,
- "is_changed": true,
- "shipping_option": {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}, - "fee_split": {
- "type": "proportional",
- "destinations": [
- "string"
]
}, - "splits": [
- {
- "payout_destination_id": "P000000001",
- "amount": 29700
}
]
}, - "store": {
- "id": "sc029",
- "name": "SC Oslo",
- "business_name": "SC Oslo AS",
- "address": {
- "address_line": "Sommerkroveien 34",
- "address_line_2": "PB 123",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO"
}, - "chain": "SuperChain",
- "email": "contact@superchain.com",
- "gln": "5790001398644",
- "organization_number": "123456789MVA",
- "phone_number": "+4738260107",
- "mcc": "5814",
- "bax": "102603",
- "terminal_id": "T0292"
}, - "discount_lines": [
- {
- "amount": 4400,
- "percentage": 44,
- "discount_type": "customer",
- "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
- "description": "string",
- "line_id": 1
}
], - "discount_codes": [
- "SUMMER20"
], - "payout_destination_id": "string",
- "merchant_reference": "string"
}, - "expires_at": "2019-08-24T14:15:22Z",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "express": {
- "shipping_options": [
- {
- "id": "bring-pick-up-00001",
- "line_id": "bring-pick-up-00001-location-0a1f6b",
- "countries": [
- "NO"
], - "amount": 3900,
- "vat_amount": 975,
- "vat": 25,
- "title": "Standard",
- "description": "Pick up at your nearest postal office",
- "delivery_method": "pick_up",
- "operator": "Bring",
- "operator_product_id": "pick-up-00001-location-0a1f6b",
- "eta": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "time_slot": {
- "starts_at": "2020-10-14T19:00:00Z",
- "ends_at": "2020-10-14T20:00:00Z"
}, - "pick_up_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "distance": 0
}, - "metadata": {
- "operator_dest": "XAB1239",
- "number_x": 1921
}, - "environmental_data": {
- "description": "Fossil free",
- "details": [
- {
- "label": "Carbon offset",
- "value": "1KG CO2"
}
]
}
}
], - "shipping_mode": "shipping_required",
- "discount_codes": {
- "max_count": 0,
}, - "customer_types": [
- "b2c",
- "b2b"
]
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer_ip": "string",
- "user_agent": "string",
- "initiating_system_request_headers": {
- "dintero-system-name": "woocommerce",
- "dintero-system-version": "5.0.0",
- "dintero-system-plugin-name": "Dintero.Checkout.WooCommerce",
- "dintero-system-plugin-version": "2021.03.02",
- "user-agent": "Mozilla: Mozilla/5.0"
}, - "payment_operation": "unscheduled_purchase",
- "events": [
- {
- "id": "769952fe-86c9-4185-a1ce-aeb46da3509c",
- "name": "INITIATED",
- "created_at": "2019-05-09T09:13:40.306Z",
- "request_id": "b97b6312-f8b3-11ed-be56-0242ac120002"
}, - {
- "name": "VISITED",
- "created_at": "2019-05-09T09:13:50.548Z"
}, - {
- "name": "PAY_FAILED",
- "created_at": "2019-05-09T09:14:10.548Z",
- "details": {
- "error": "Rejected",
- "payment_product_type": "instabank.finance"
}
}, - {
- "name": "FAILED",
- "created_at": "2019-05-09T09:16:11.786Z"
}
], - "transaction_id": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "metadata": {
- "merchant_name": "string",
- "session:profile_id": "string",
- "payout": "payout_account",
- "payout_correlation_id": "string",
- "gateway:id": "string",
- "bambora:merchant_number": "string",
- "bambora:transaction_id": "string",
- "bambora:reference": "string",
- "bambora:acquirer": "string",
- "bambora:wallet": "string"
}, - "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "payment_product_type": "bambora.creditcard",
- "card": {
- "brand": "Visa",
- "masked_pan": "476173******0416",
- "expiry_date": "string",
- "type": "Credit Card",
- "eci": "string",
- "country": "string"
}
}
scopes:
profile_id required | string |
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "profile_id": "string",
- "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "description": "string",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_by": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
scopes:
profile_id required | string |
required | object (PaymentConfiguration) |
description required | string description of the profile |
object | |
profile_id | string <= 255 characters The profile_id you have defined for the profile. (must not have trailing or leading spaces) An auto-generated profile_id will be created if no profile_id is provided. |
object (Merchant) Configure merchant information used in the checkout. | |
Array of objects (CheckboxConfiguration) <= 2 items Configuration for checkboxes that should be part of the checkout |
{- "profile_id": "string",
- "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable"
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
]
}, - "discounts": {
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "description": "string",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
]
}
{- "profile_id": "string",
- "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "description": "string",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
]
}
scopes:
profile_id required | string |
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "profile_id": "string",
- "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "description": "string",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_by": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
scopes:
required | object (PaymentConfiguration) |
description required | string description of the profile |
object | |
profile_id | string <= 255 characters The profile_id you have defined for the profile. (must not have trailing or leading spaces) An auto-generated profile_id will be created if no profile_id is provided. |
object (Merchant) Configure merchant information used in the checkout. | |
Array of objects (CheckboxConfiguration) <= 2 items Configuration for checkboxes that should be part of the checkout |
{- "profile_id": "string",
- "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable"
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
]
}, - "discounts": {
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "description": "string",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
]
}
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "profile_id": "string",
- "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "description": "string",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_by": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
scopes:
limit | integer [ 1 .. 100 ] Default: 10 A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items. |
starting_after | string <checkout-id> cursor for use in pagination. starting_after is an object ID
that defines your place in the list. For instance, if you make
a list request and receive 100 objects, ending with |
[- {
- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "profile_id": "string",
- "merchant": {
- "name": "string",
- "website": "string",
- "merchant_category_code": "string",
- "country": "string"
}, - "configuration": {
- "auto_capture": true,
- "channel": "in_app",
- "publish": [
- {
- "channel": "sms",
- "type": "checkout-link",
- "id": "string",
- "status": "sent"
}
], - "active_payment_types": {
- "enabled": true
}, - "default_payment_type": "bambora.creditcard",
- "bambora": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false
}, - "mobilepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero": {
- "type": "payment_type",
- "wallets": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "zero": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "dintero_psp": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "instabank": {
- "finance": {
- "enabled": true,
- "payability": "payable",
- "product": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
}, - "invoice": {
- "enabled": true,
- "payability": "payable",
- "require_applicant": true,
- "product": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "monthly_amount": 100000,
- "first_monthly_amount": 109500,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}, - "postponement": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "products": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "effective_annual_interest_rate": "54.69",
- "total_amount": 309400,
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300,
- "effective_annual_interest_rate": "21.38"
}, - "branding_image_url": "string"
}
]
}
}, - "netaxept": {
- "type": "payment_type",
- "creditcard": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "terminal": {
- "terminal": "/Terminal/default.aspx",
- "terminal_design": "string",
- "terminal_single_page": true,
- "terminal_layout": "string"
}
}
}, - "payex": {
- "dynamic_descriptor": "string",
- "swish": {
- "enabled": true,
- "payability": "payable"
}, - "creditcard": {
- "enabled": true,
- "payability": "payable",
- "generate_payment_token": false,
- "generate_recurrence_token": false,
- "no_cvc": true
}, - "mobilepay": {
- "enabled": true,
- "payability": "payable"
}, - "vipps": {
- "enabled": true,
- "payability": "payable"
}, - "applepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "clicktopay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "googlepay": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "vipps": {
- "enabled": true,
- "payability": "payable",
- "dynamic_descriptor": "string"
}, - "collector": {
- "type": "payment_type",
- "dynamic_descriptor": "string",
- "invoice": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}, - "invoice_b2b": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "disable_collector_b2b_address_enforcement": false,
- "enable_on_hold": true
}
}, - "invoice_b2b_preapproved": {
- "type": "payment_product_type",
- "payability": "payable",
- "enabled": true,
- "countries": [
- "string"
], - "accounts": [
- {
- "billing_address": {
- "business_name": "string",
- "organization_number": "stringstr",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "customer_reference": "string",
- "cost_center": "string",
- "first_name": "John",
- "last_name": "Doe",
- "address_id": "address_1"
}, - "company_id": "string"
}
]
}, - "finance": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "payability": "payable"
}, - "installment": {
- "type": "payment_product_type",
- "enabled": true,
- "countries": [
- "string"
], - "options": {
- "enable_on_hold": true
}, - "payability": "payable"
}
}, - "klarna": {
- "type": "payment_type",
- "klarna": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}, - "billie": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "santander": {
- "type": "payment_type",
- "debit_account": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable",
- "branding_name": "string",
- "accounts": [
- {
- "account_number_token": "string",
- "masked_account_number": "string"
}
]
}
}, - "swish": {
- "type": "payment_type",
- "swish": {
- "type": "payment_product_type",
- "enabled": true,
- "payability": "payable"
}
}, - "payout": {
- "dynamic_payout_destination_ids": [
- {
- "type": "order_store_id",
- "order_store_id": "STORE_123",
- "order_payout_destination_id": "PD_123"
}
], - "payment_products": [
- {
- "payment_product": "bambora"
}
]
}, - "discounts": {
- "type": "discounts",
- "express_discount_codes": {
- "payability": "payable",
- "enabled": true
}, - "order": {
- "enabled": false
}
}, - "theme": {
- "backdrop": "string",
- "primary": "string",
- "text": "string",
- "warning": "string",
- "error": "string",
- "font-family": "string"
}, - "countries": {
- "preferred_country": "string",
- "allow_countries": [
- "string"
], - "deny_countries": [
- "string"
]
}
}, - "description": "string",
- "checkboxes": [
- {
- "id": "string",
- "label": "string",
- "checked": true,
- "required": true,
- "link": {
- "url": "string",
- "text": "Terms for checkbox action"
}
}
], - "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_by": "string",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
Dintero can optionally sign all request it sends to your endpoints.
We do so by including a signature in the request Dintero-Signature
header. This allows you to verify that the request was done by
Dintero, not by a third party.
v0-hmac-sha256
<timestamp>\n<account_id>\n<method>\n<hostname>\n<pathname>\n<query>
secret: 123
timestamp: 1582236537
account_id: P00000000
method: GET
url: https://example.com/callback?B=123&A=992
Dintero-Signature: t=1582236537,
v0-hmac-sha256=6bed2ab1b919d460ef7465a20dc6c97260dca73fab6647106ca525f0908df64a
The timestamp (
t
) in the Dintero-Signature, is included in the signature payload to mitigatereplay attach
. If your signature is valid but the timestamp is too old, you can have your application reject the request. We recommend that your application have a tolerance of five minutes between the timestamp and the current time.
NOTE: The query parameters must be sorted.
scopes:
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "signature": {
- "type": "v0-hmac-sha256",
- "secret": "string"
}
}
Get the current signature secret Dintero uses when create the
Dintero-Signature
header included in requests it sends to your
endpoints.
scopes:
{- "id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "signature": {
- "type": "v0-hmac-sha256",
- "secret": "string"
}
}
scopes:
required | object (BamboraGwWrite) configuration for Bambora GW |
{- "bambora": {
- "token_scope": "string",
- "merchant_number": "string",
- "access_token": "string",
- "secret_token": "string",
- "md5_key": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
overwrite | boolean Default: false Overwrite an existing credentials |
validate_credential | boolean Default: true |
name required | string The unique id that identifies the credential (store_id) |
required | object |
description | string |
Array of objects Use the credential to configure gateway and/or gateway overrides Will create new credential from existing gateway / override so existing transactions created with the old configuration can continue to work |
{- "name": "string",
- "description": "string",
- "data": {
- "username": "string",
- "password": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "customer_client": {
- "customers_client_id": "string",
- "customers_client_secret": "string",
- "customers_client_audience": "string"
}, - "enable_on_hold": false,
- "settlement_reference_fields": "account_id"
}
}, - "promote": [
- {
- "type": "default",
- "value": "string",
- "stores": [
- {
- "store_id": 0,
- "country": "string",
- "segment": "B2C"
}
]
}
]
}
{- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1
}
scopes:
store_id required | string |
object or null (CollectorGwStoreOverrideWrite) Override properties for given store. Will delete override if null. |
{- "store_id": "string",
- "override": {
- "username": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "enable_on_hold": false,
- "settlement_reference_fields": "account_id",
- "customer_client": {
- "customers_client_id": "string",
- "customers_client_secret": "string",
- "customers_client_audience": "string"
}
}, - "stores": [
- {
- "store_id": 0,
- "country": "string",
- "currency": "NOK",
- "segment": "B2C"
}
], - "password": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
required | object (CollectorGwWrite) configuration for Collector Bank GW |
{- "collector": {
- "username": "string",
- "store_id": 0,
- "country": "string",
- "options": {
- "enable_on_hold": false,
- "settlement_reference_fields": "account_id",
- "customer_client": {
- "customers_client_id": "string",
- "customers_client_secret": "string",
- "customers_client_audience": "string"
}
}, - "stores": [
- {
- "store_id": 0,
- "country": "string",
- "currency": "NOK",
- "segment": "B2C"
}
], - "password": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
required | object (InstabankGwWrite) configuration for Instabank GW |
{- "instabank": {
- "organization_number": 12345678911,
- "payment_product_codes": {
- "instabank.finance": {
- "product_code": "630",
- "minimum_monthly_balance_rate": "1.67",
- "annual_interest_rate": "0.0",
- "origination_fee": 9500,
- "notification_fee": 3900,
- "minimum_amount": 20000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300
}, - "branding_image_url": "string"
}, - "instabank.invoice": {
- "product_code": "632",
- "due_in_days": 10,
- "minimum_amount": 20000,
- "invoice_fee": 9500,
- "require_applicant_amount": 7500000,
- "branding_image_url": "string"
}, - "instabank.installment": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "credit_time": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300
}, - "branding_image_url": "string"
}
], - "instabank.postponement": [
- {
- "minimum_amount": 20000,
- "product_code": "633",
- "postponement_months": 36,
- "origination_fee": 9500,
- "notification_fee": 3900,
- "annual_interest_rate": "0.0",
- "require_applicant_amount": 2500000,
- "loan_example": {
- "amount": 2500000,
- "years": 1,
- "total_amount": 2772300,
- "cost": 272300
}, - "branding_image_url": "string"
}
]
}
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
store_id required | string |
object or null (NetaxeptGwStoreOverride) Override properties for given store. Will delete override if null. |
{- "store_id": "string",
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
required | object (NetaxeptGwWrite) configuration for Netaxept GW |
{
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
overwrite | boolean Default: false Overwrite an existing credential |
validate_credential | boolean Default: true |
name required | string The unique id that identifies the credential (payee_id) |
required | object (PayExGwWrite) configuration for PayEx GW |
description | string |
Array of objects (PromoteCredential) Use the credential to configure gateway and/or gateway overrides Will create new credential from existing gateway / override so existing transactions created with the old configuration can continue to work |
{- "name": "string",
- "description": "string",
- "data": {
- "payee_id": "string",
- "subsite": "12345789",
- "token": "string"
}, - "promote": [
- {
- "type": "default",
- "value": "string"
}
]
}
{- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1
}
scopes:
keep_versions | boolean Default: true keep existing override versions when updating the overridej |
store_id required | string |
object or null (PayExGwStoreOverride) Override properties for given store. Will delete override if null. |
{- "store_id": "string",
- "override": {
- "payee_id": "string",
- "subsite": "12345789",
- "token": "string",
- "version": {
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
keep_overrides | boolean Default: true keep existing overrides when updating the gateway |
keep_versions | boolean Default: true keep existing overrides when updating the gateway |
required | object (PayExGwWrite) configuration for PayEx GW |
{- "payex": {
- "payee_id": "string",
- "subsite": "12345789",
- "token": "string",
- "version": {
- "valid_after": "2019-08-24T14:15:22Z",
- "valid_before": "2019-08-24T14:15:22Z"
}
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
store_id required | string |
object or null (SantanderGwStoreOverrideWrite) Override properties for given store. Will delete override if null. |
{- "store_id": "string",
- "override": {
- "store_email": "string",
- "store_token": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
required | object (SantanderGwWrite) configuration for Santander GW |
{- "santander": {
- "store_email": "string",
- "branding_name": "Bygger'n",
- "store_token": "string",
- "cert": "string",
- "cert_password": "string",
- "customers_client_id": "string",
- "customers_client_secret": "string",
- "customers_client_audience": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
store_id required | string |
object or null (SwishGwStoreOverrideWrite) Override properties for given store. Will delete override if null. |
{- "store_id": "string",
- "override": {
- "swish_number": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
keep_overrides | boolean Default: true keep existing overrides when updating the gateway |
required | object (SwishGwWrite) configuration for Swish GW |
{- "swish": {
- "swish_number": "string",
- "cert": "string",
- "key": "string",
- "passphrase": "string",
- "ca": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
store_id required | string |
object or null (VippsGwStoreOverrideWrite) Override properties for given store. Will delete override if null. |
{- "store_id": "string",
- "override": {
- "client_id": "string",
- "merchant_serial_number": "123456",
- "ocp_apim_subscription_key_access_token": "string",
- "ocp_apim_subscription_key_ecom": "string",
- "client_secret": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
required | object (VippsGwWrite) configuration for Vipps GW |
{- "vipps": {
- "client_id": "string",
- "merchant_serial_number": "123456",
- "client_secret": "string",
- "ocp_apim_subscription_key_access_token": "string",
- "ocp_apim_subscription_key_ecom": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
overwrite | boolean Default: false Overwrite an existing credential |
validate_credential | boolean Default: true |
name required | string The unique id that identifies the credential (username) |
required | object (KlarnaGwWrite) configuration for Klarna GW |
description | string |
Array of objects Use the credential to configure gateway Will create new credential from existing gateway so existing transactions created with the old configuration can continue to work |
{- "name": "string",
- "description": "string",
- "data": {
- "username": "PK27631_9dfg28uy0p43",
- "merchant_id": "PK27631",
- "password": "string"
}, - "promote": [
- {
- "type": "default",
- "value": ""
}
]
}
{- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "version": 1
}
scopes:
required | object (KlarnaGwWrite) configuration for Klarna GW |
{- "klarna": {
- "username": "PK27631_9dfg28uy0p43",
- "merchant_id": "PK27631",
- "password": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
scopes:
required | object configuration for Dintero PSP GW |
{- "dintero_psp": {
- "visa_net_client_id": "string",
- "acquirer_merchant_id": "string",
- "vipps_merchant_serial_number": "123456",
- "visa_token_client_app_id": "string",
- "visa_token_relationship_id": "10000000-20000000000"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
Endpoint that returns an svg that can be used to show the world your payment options. Go to the documentation for the checkout branding endpoints.
logos required | string logos for payment types separated by underscore eg. |
variant required | string Enum: "colors" "mono" Image variant, multi-colors or mono-colored. |
color required | string rgb hex color without the # character or an rbg() or rgba() color code. |
width required | string^[0-9]*$ width of image |
template required | string Enum: "dintero_top_frame.svg" "logos.svg" Template for branding image |
Endpoint that returns an svg that can be used to show the world your payment options. Go to the documentation for the checkout branding endpoints.
profile_id required | string Profile Id like |
variant required | string Enum: "colors" "mono" Image variant, multi-colors or mono-colored. |
color required | string rgb hex color without the # character or an rbg() or rgba() color code |
width required | string^[0-9]*$ width of image |
template required | string Enum: "dintero_top_frame.svg" "logos.svg" Template for branding image |
session_id required | string <checkout-id> The session ID |
callback_ref required | string |
txnid | string |
orderid | string |
reference | string |
amount | string |
currency | string |
date | string |
time | string |
feeid | string |
txnfee | string |
paymenttype | string |
walletname | string |
cardno | string |
expmonth | string |
expyear | string |
subscriptionid | string |
tokenid | string |
eci | string |
issuercountry | string |
hash | string |
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
redirect_ref required | string |
action | string Enum: "accept" "cancel" "decline" |
txnid | string |
orderid | string |
reference | string |
amount | string |
currency | string |
date | string |
time | string |
feeid | string |
txnfee | string |
paymenttype | string |
walletname | string |
cardno | string |
expmonth | string |
expyear | string |
subscriptionid | string |
tokenid | string |
eci | string |
issuercountry | string |
hash | string |
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
redirect_ref required | string Example: dintero.zero.complete.fe4f9c... Signed redirect reference prefixed by the payment product type |
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
redirect_ref required | string Example: dintero_psp.creditcard.complete.fe4f9c... Signed redirect reference prefixed by the payment product type |
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
language | string Default: "no_NO" Enum: "no_NO" "sv_SE" "da_DK" "fi_FI" "en_GB" "de_DE" "fr_FR" "ru_RU" "pl_PL" "nl_NL" "es_ES" "it_IT" "pt_PT" "et_EE" "lv_LV" "lt_LT" Indicates which language is used in the Netaxept hosted payment window |
Content of webhook event
TransactionId | string |
{- "TransactionId": "string"
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
redirect_ref required | string |
transactionId | string |
responseCode | string |
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
payment_id required | string |
query_gateway | boolean Default: false Resolve payment status from PayEx |
{- "keep_polling": true,
- "redirect_url": "string",
- "poll_url": "string"
}
Creates a transaction from the session with status determined by the payment status provided by Payex.
session_id required | string <checkout-id> The session ID |
payment_product_type required | string Enum: "payex.creditcard" "payex.mobilepay" "payex.swish" "payex.vipps" |
token | string |
required | object |
object | |
object |
{- "paymentOrder": {
- "id": "/psp/paymentorders/11111111-1111-1111-1111-111111111111",
- "instrument": "swish"
}, - "payment": {
- "id": "/psp/<payment instrument>/payments/22222222-2222-2222-2222-22222222222",
- "number": 222222222
}, - "transaction": {
- "id": "/psp/<payment instrument>/payments/22222222-2222-2222-2222-222222222222/<transaction type>/33333333-3333-3333-3333-333333333333",
- "number": 333333333
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
action required | string Enum: "complete" "cancel" |
payment_product_type required | string Enum: "payex.creditcard" "payex.mobilepay" "payex.swish" "payex.vipps" |
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
Creates a transaction from the session with status determined by the payment status provided by Payex.
session_id required | string <checkout-id> The session ID |
callback_ref required | string Example: payex.creditcard.ef9f0c... Signed callback reference prefixed by the payment product type |
required | object |
object | |
object |
{- "paymentOrder": {
- "id": "/psp/paymentorders/11111111-1111-1111-1111-111111111111",
- "instrument": "swish"
}, - "payment": {
- "id": "/psp/<payment instrument>/payments/22222222-2222-2222-2222-22222222222",
- "number": 222222222
}, - "transaction": {
- "id": "/psp/<payment instrument>/payments/22222222-2222-2222-2222-222222222222/<transaction type>/33333333-3333-3333-3333-333333333333",
- "number": 333333333
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
redirect_ref required | string Example: payex.creditcard.complete.fe4f9c... Signed redirect reference prefixed by the payment product type |
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
Get status about the Swish session. Will check if the session contains a transaction_id, and if the transaction is paid with the given Swish payment_request_id.
session_id required | string <checkout-id> The session ID |
payment_request_id required | string |
{- "keep_polling": true,
- "redirect_url": "string",
- "poll_url": "string"
}
session_id required | string <checkout-id> The session ID |
callback_ref required | string |
Content of payment callback
id required | string Payment request id |
status required | string Enum: "CREATED" "PAID" "DECLINED" "ERROR" |
payeePaymentReference | string |
paymentReference | string or null |
string or number | |
datePaid | string or null |
{- "id": "string",
- "payeePaymentReference": "string",
- "paymentReference": "string",
- "amount": "string",
- "datePaid": "string",
- "status": "CREATED"
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
id required | string <checkout-id> The ID of the transaction |
callback_ref required | string |
Content of refund callback
id required | string Refund id |
status required | string Enum: "VALIDATED" "DEBITED" "PAID" "ERROR" |
originalPaymentReference required | string Used to identify the payment |
string or number | |
datePaid | string or null |
{- "id": "string",
- "originalPaymentReference": "string",
- "amount": "string",
- "datePaid": "string",
- "status": "VALIDATED"
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
order_id required | string |
required | string or number |
orderId required | string |
required | object |
{- "merchantSerialNumber": "string",
- "orderId": "string",
- "transactionInfo": {
- "amount": 0,
- "status": "RESERVED",
- "timeStamp": "2019-08-24T14:15:22Z",
- "transactionId": "string"
}
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
session_id required | string <checkout-id> The session ID |
redirect_ref required | string Example: klarna.klarna.complete.fe4f9c... Signed redirect reference prefixed by the payment product type |
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
Handle authorization callback received from Klarna
session_id required | string <checkout-id> The session ID |
callback_ref required | string Example: klarna.klarna.fe4f9cfre... Signed callback reference prefixed by the payment product type |
authorization_token required | string |
session_id required | string |
{- "authorization_token": "string",
- "session_id": "string"
}
{- "error": {
- "code": "string",
- "errors": [
- { }
], - "message": "string"
}
}
Perform a credit check
scopes:
credit_providers required | Array of strings Items Value: "collector" |
amount required | integer reward amount for the the ref used, monetary amount in smallest unit for the currency |
currency required | string <iso4217-code> The three-character ISO-4217 currency. https://en.wikipedia.org/wiki/ISO_4217 |
required | object |
object | |
check_type | string Value: "synchronous"
|
{- "store": {
- "id": "string"
}, - "check_type": "synchronous",
- "credit_providers": [
- "collector"
], - "amount": 10000,
- "currency": "NOK",
- "applicant": {
- "billing_address": {
- "first_name": "John",
- "last_name": "Doe",
- "address_line": "string",
- "address_line_2": "string",
- "co_address": "Land Lord",
- "business_name": "string",
- "postal_code": "0349",
- "postal_place": "Oslo",
- "country": "NO",
- "phone_number": "string",
- "email": "string",
- "latitude": 0,
- "longitude": 0,
- "comment": "string",
- "organization_number": "string",
- "organization_type": "string",
- "customer_reference": "string",
- "cost_center": "string"
}
}
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24",
- "amount": 0,
- "results": [
- {
- "credit_provider": "collector",
- "status": "approved"
}
]
}