Skip to main content
PUT
https://checkout.dintero.com/v1
/
view
/
{session_id}
/
session
/
order
/
shipping_option
checkout_sid_json_order_items_shipping_option_put
curl --request PUT \
  --url https://checkout.dintero.com/v1/view/{session_id}/session/order/shipping_option \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "bring-pick-up-00001",
  "line_id": "bring-pick-up-00001-location-0a1f6b",
  "amount": 3900,
  "title": "Standard",
  "operator": "Bring",
  "description": "Pick up at your nearest postal office"
}
'
{
  "url": {
    "return_url": "https://example.com/accept",
    "callback_url": "https://example.com/callback?method=GET",
    "merchant_terms_url": "https://example.com/terms.html"
  },
  "order": {
    "amount": 72200,
    "currency": "NOK",
    "merchant_reference": "<string>",
    "vat_amount": 13660,
    "merchant_reference_2": "<string>",
    "event_reference": "<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": 123,
      "longitude": 123,
      "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": 123,
      "longitude": 123,
      "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": 123,
    "is_changed": true,
    "shipping_option": {
      "id": "bring-pick-up-00001",
      "line_id": "bring-pick-up-00001-location-0a1f6b",
      "amount": 3900,
      "title": "Standard",
      "operator": "Bring",
      "countries": [
        "NO"
      ],
      "vat_amount": 975,
      "vat": 25,
      "description": "Pick up at your nearest postal office",
      "delivery_method": "pick_up",
      "operator_product_id": "pick-up-00001-location-0a1f6b",
      "eta": {
        "working_days": [
          1,
          2
        ],
        "shipping_day_of_week": 3,
        "arrival_day_of_week": 3,
        "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": 123,
        "longitude": 123,
        "comment": "<string>",
        "organization_number": "<string>",
        "organization_type": "<string>",
        "customer_reference": "<string>",
        "cost_center": "<string>",
        "website_url": "<string>",
        "opening_hours": {
          "open_now": true,
          "periods": [
            {
              "opens_at": "08:00",
              "closes_at": "16:00",
              "day_of_week": 1
            }
          ],
          "timezone": "Europe/Oslo"
        },
        "distance": 123
      },
      "metadata": {
        "operator_dest": "XAB1239",
        "number_x": 1921
      },
      "environmental_data": {
        "description": "Fossil free",
        "details": [
          {
            "label": "Carbon offset",
            "value": "1KG CO2"
          }
        ]
      },
      "thumbnail_url": "<string>",
      "pay_in_store": {},
      "fee_split": {
        "destinations": [
          "<string>"
        ]
      },
      "splits": [
        {
          "payout_destination_id": "seller-1",
          "amount": 29700
        }
      ],
      "shipments": [
        {
          "id": "bring-pick-up-00001",
          "line_id": "bring-pick-up-00001-location-0a1f6b",
          "amount": 3900,
          "title": "Standard",
          "operator": "Bring",
          "countries": [
            "NO"
          ],
          "vat_amount": 975,
          "vat": 25,
          "description": "Pick up at your nearest postal office",
          "delivery_method": "pick_up",
          "operator_product_id": "pick-up-00001-location-0a1f6b",
          "eta": {
            "working_days": [
              1,
              2
            ],
            "shipping_day_of_week": 3,
            "arrival_day_of_week": 3,
            "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": 123,
            "longitude": 123,
            "comment": "<string>",
            "organization_number": "<string>",
            "organization_type": "<string>",
            "customer_reference": "<string>",
            "cost_center": "<string>",
            "website_url": "<string>",
            "opening_hours": {
              "open_now": true,
              "periods": [
                {
                  "opens_at": "08:00",
                  "closes_at": "16:00",
                  "day_of_week": 1
                }
              ],
              "timezone": "Europe/Oslo"
            },
            "distance": 123
          },
          "metadata": {
            "operator_dest": "XAB1239",
            "number_x": 1921
          },
          "environmental_data": {
            "description": "Fossil free",
            "details": [
              {
                "label": "Carbon offset",
                "value": "1KG CO2"
              }
            ]
          },
          "thumbnail_url": "<string>",
          "pay_in_store": {},
          "fee_split": {
            "destinations": [
              "<string>"
            ]
          },
          "splits": [
            {
              "payout_destination_id": "seller-1",
              "amount": 29700
            }
          ],
          "shipment_id": "<string>",
          "shipment_items": [
            {
              "line_id": "line-id-1",
              "quantity": 123
            }
          ]
        }
      ]
    },
    "store": {
      "id": "sc029",
      "name": "SC Oslo",
      "business_name": "SC Oslo AS",
      "address": {
        "address_line": "Sommerkroveien 34",
        "postal_place": "Oslo",
        "country": "NO",
        "address_line_2": "PB 123",
        "postal_code": "0349"
      },
      "chain": "SuperChain",
      "email": "contact@superchain.com",
      "gln": "5790001398644",
      "organization_number": "123456789MVA",
      "phone_number": "+4738260107",
      "mcc": "5814",
      "bax": "102603",
      "terminal_id": "T0292",
      "payout_destination_id": "seller-1"
    },
    "discount_lines": [
      {
        "amount": 4400,
        "percentage": 44,
        "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
        "description": "<string>",
        "line_id": 1
      }
    ],
    "discount_codes": [
      "SUMMER20"
    ],
    "gift_cards": [
      {
        "card_id": "<string>",
        "amount": 123,
        "masked_card_token": "<string>"
      }
    ],
    "payout_destination_id": "<string>"
  },
  "configuration": {
    "auto_capture": true,
    "channel": "ecommerce",
    "publish": [
      {
        "id": "<string>"
      }
    ],
    "active_payment_types": {
      "enabled": true
    },
    "bambora": {
      "applepay": {
        "enabled": true
      },
      "creditcard": {
        "enabled": true,
        "generate_payment_token": false
      },
      "googlepay": {
        "enabled": true
      },
      "mobilepay": {
        "enabled": true
      },
      "vipps": {
        "enabled": true
      }
    },
    "dintero": {
      "wallets": {
        "enabled": true
      },
      "zero": {
        "enabled": true
      },
      "external": {
        "enabled": true,
        "display": {
          "payment_method_label": "<string>",
          "button_label": "<string>",
          "content": {
            "title": "<string>",
            "description": "<string>"
          },
          "terms": [
            {
              "ref": "<string>",
              "label": "<string>",
              "href": "<string>"
            }
          ]
        }
      }
    },
    "dintero_psp": {
      "creditcard": {
        "enabled": true,
        "generate_payment_token": false,
        "token_supported_auth_methods": [
          "PASSKEY",
          "3DS"
        ],
        "sca_policy": {
          "network_exemptions": {
            "low_value": true,
            "low_risk": true
          },
          "liability_rules": [
            {
              "limit": [
                {
                  "amount": 50000,
                  "currency": "NOK"
                }
              ],
              "issuer_countries": [
                "NO",
                "SE",
                "DK"
              ],
              "enabled": true
            }
          ]
        },
        "generate_payment_token_config": {}
      },
      "vipps": {
        "enabled": true,
        "sca_policy": {
          "network_exemptions": {
            "low_value": true,
            "low_risk": true
          },
          "liability_rules": [
            {
              "limit": [
                {
                  "amount": 50000,
                  "currency": "NOK"
                }
              ],
              "issuer_countries": [
                "NO",
                "SE",
                "DK"
              ],
              "enabled": true
            }
          ]
        }
      },
      "applepay": {
        "enabled": true,
        "sca_policy": {
          "network_exemptions": {
            "low_value": true,
            "low_risk": true
          },
          "liability_rules": [
            {
              "limit": [
                {
                  "amount": 50000,
                  "currency": "NOK"
                }
              ],
              "issuer_countries": [
                "NO",
                "SE",
                "DK"
              ],
              "enabled": true
            }
          ]
        },
        "details": {
          "domain_names": [
            "example.dintero.com"
          ],
          "token_event_notification_url": "<string>"
        }
      },
      "googlepay": {
        "enabled": true,
        "sca_policy": {
          "network_exemptions": {
            "low_value": true,
            "low_risk": true
          },
          "liability_rules": [
            {
              "limit": [
                {
                  "amount": 50000,
                  "currency": "NOK"
                }
              ],
              "issuer_countries": [
                "NO",
                "SE",
                "DK"
              ],
              "enabled": true
            }
          ]
        },
        "generate_payment_token": false
      },
      "clicktopay": {
        "enabled": true,
        "generate_payment_token": false,
        "sca_policy": {
          "network_exemptions": {
            "low_value": true,
            "low_risk": true
          },
          "liability_rules": [
            {
              "limit": [
                {
                  "amount": 50000,
                  "currency": "NOK"
                }
              ],
              "issuer_countries": [
                "NO",
                "SE",
                "DK"
              ],
              "enabled": true
            }
          ]
        }
      }
    },
    "instabank": {
      "finance": {
        "enabled": true,
        "product": {
          "product_code": "630",
          "minimum_monthly_balance_rate": "1.67",
          "origination_fee": 9500,
          "notification_fee": 3900,
          "loan_example": {
            "amount": 2500000,
            "years": 1,
            "total_amount": 2772300,
            "cost": 272300,
            "effective_annual_interest_rate": "21.38"
          },
          "annual_interest_rate": "0.0",
          "effective_annual_interest_rate": "0.0",
          "minimum_amount": 20000,
          "branding_image_url": "<string>"
        }
      },
      "invoice": {
        "enabled": true,
        "require_applicant": true,
        "product": {
          "product_code": "632",
          "due_in_days": 10,
          "invoice_fee": 9500,
          "require_applicant_amount": 7500000,
          "minimum_amount": 20000,
          "branding_image_url": "<string>"
        }
      },
      "installment": {
        "enabled": true,
        "type": "payment_product_type",
        "products": [
          {
            "product_code": "633",
            "credit_time": 36,
            "origination_fee": 9500,
            "notification_fee": 3900,
            "annual_interest_rate": "0.0",
            "minimum_amount": 20000,
            "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": {
        "enabled": true,
        "type": "payment_product_type",
        "products": [
          {
            "product_code": "633",
            "postponement_months": 36,
            "origination_fee": 9500,
            "annual_interest_rate": "0.0",
            "minimum_amount": 20000,
            "notification_fee": 3900,
            "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": {
      "creditcard": {
        "enabled": true,
        "terminal": {
          "terminal_single_page": true,
          "terminal_design": "<string>",
          "terminal_layout": "<string>"
        }
      }
    },
    "payex": {
      "dynamic_descriptor": "<string>",
      "swish": {
        "enabled": true
      },
      "creditcard": {
        "enabled": true,
        "generate_payment_token": false,
        "generate_recurrence_token": false,
        "no_cvc": true
      },
      "mobilepay": {
        "enabled": true
      },
      "vipps": {
        "enabled": true
      },
      "applepay": {
        "enabled": true
      },
      "clicktopay": {
        "enabled": true
      },
      "googlepay": {
        "enabled": true
      }
    },
    "vipps": {
      "enabled": true,
      "dynamic_descriptor": "<string>"
    },
    "collector": {
      "dynamic_descriptor": "<string>",
      "invoice": {
        "enabled": true,
        "type": "payment_product_type",
        "countries": [
          "<string>"
        ],
        "options": {
          "enable_on_hold": true
        }
      },
      "invoice_b2b": {
        "enabled": true,
        "type": "payment_product_type",
        "countries": [
          "<string>"
        ],
        "options": {
          "disable_collector_b2b_address_enforcement": false,
          "enable_on_hold": true
        }
      },
      "invoice_b2b_preapproved": {
        "enabled": true,
        "type": "payment_product_type",
        "countries": [
          "<string>"
        ],
        "accounts": [
          {
            "billing_address": {
              "business_name": "<string>",
              "organization_number": "<string>",
              "address_line": "<string>",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO",
              "phone_number": "<string>",
              "email": "<string>",
              "address_line_2": "<string>",
              "co_address": "<string>",
              "customer_reference": "<string>",
              "cost_center": "<string>",
              "first_name": "John",
              "last_name": "Doe",
              "address_id": "address_1"
            },
            "company_id": "<string>"
          }
        ]
      },
      "finance": {
        "enabled": true,
        "type": "payment_product_type",
        "countries": [
          "<string>"
        ]
      },
      "installment": {
        "enabled": true,
        "type": "payment_product_type",
        "countries": [
          "<string>"
        ],
        "options": {
          "enable_on_hold": true
        }
      }
    },
    "klarna": {
      "klarna": {
        "enabled": true
      },
      "billie": {
        "enabled": true
      }
    },
    "kravia": {
      "invoice_b2b": {
        "enabled": true,
        "days_until_due": 182,
        "require_identity_verification": true,
        "invoice_channel": "kravia"
      },
      "invoice_b2b_grouped": {
        "enabled": true,
        "invoice_schedule": {},
        "days_until_due": 182.5,
        "require_identity_verification": true,
        "invoice_channel": "kravia"
      },
      "invoice_b2c": {
        "enabled": true,
        "days_until_due": 182,
        "invoice_channel": "kravia",
        "require_identity_verification": true
      }
    },
    "two": {
      "invoice_b2b": {
        "enabled": true
      }
    },
    "santander": {
      "debit_account": {
        "enabled": true,
        "branding_name": "<string>",
        "accounts": [
          {
            "account_number_token": "<string>",
            "masked_account_number": "<string>"
          }
        ]
      }
    },
    "seitatech": {
      "in_person": {
        "enabled": true
      }
    },
    "swish": {
      "swish": {
        "enabled": true,
        "payout_enabled": true
      }
    },
    "payout": {
      "dynamic_payout_destination_ids": [
        {
          "order_store_id": "STORE_123",
          "order_payout_destination_id": "PD_123",
          "overwrite_payout_destination_id": false
        }
      ],
      "payment_products": [
        {}
      ]
    },
    "allow_express_wallet_payment": false,
    "age_verification": {
      "enabled": true,
      "minimum_age_required": 18
    },
    "discounts": {
      "express_discount_codes": {
        "enabled": true
      },
      "order": {
        "enabled": false
      }
    },
    "theme": {
      "backdrop": "<string>",
      "primary": "<string>",
      "cardRadius": "<string>",
      "buttonRadius": "<string>"
    },
    "countries": {
      "preferred_country": "<string>",
      "allow_countries": [
        "<string>"
      ],
      "deny_countries": [
        "<string>"
      ]
    },
    "allow_different_billing_shipping_address": [],
    "merchant": {
      "id": null,
      "logo_url": "<string>",
      "name": "TKP tech AS",
      "country": "NO"
    }
  },
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "customer": {
    "customer_id": "<string>",
    "email": "john.doe@example.com",
    "phone_number": "+4799999999",
    "my_dintero": {
      "actions": [],
      "terms": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "https://example.com/toc"
      }
    },
    "gift_cards": {
      "dintero.wallets": [
        {
          "card_id": "<string>",
          "masked_card_token": "<string>"
        }
      ]
    },
    "tokens": {
      "payex.creditcard": {
        "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
      },
      "bambora.creditcard": {
        "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
      },
      "dintero_psp.creditcard": {
        "payment_token_id": "2134a260d196b1d65e59b259dc43f619d7f0f3c6"
      }
    }
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "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",
        "amount": 3900,
        "title": "Standard",
        "operator": "Bring",
        "countries": [
          "NO"
        ],
        "vat_amount": 975,
        "vat": 25,
        "description": "Pick up at your nearest postal office",
        "delivery_method": "pick_up",
        "operator_product_id": "pick-up-00001-location-0a1f6b",
        "eta": {
          "working_days": [
            1,
            2
          ],
          "shipping_day_of_week": 3,
          "arrival_day_of_week": 3,
          "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": 123,
          "longitude": 123,
          "comment": "<string>",
          "organization_number": "<string>",
          "organization_type": "<string>",
          "customer_reference": "<string>",
          "cost_center": "<string>",
          "website_url": "<string>",
          "opening_hours": {
            "open_now": true,
            "periods": [
              {
                "opens_at": "08:00",
                "closes_at": "16:00",
                "day_of_week": 1
              }
            ],
            "timezone": "Europe/Oslo"
          },
          "distance": 123
        },
        "metadata": {
          "operator_dest": "XAB1239",
          "number_x": 1921
        },
        "environmental_data": {
          "description": "Fossil free",
          "details": [
            {
              "label": "Carbon offset",
              "value": "1KG CO2"
            }
          ]
        },
        "thumbnail_url": "<string>",
        "pay_in_store": {},
        "fee_split": {
          "destinations": [
            "<string>"
          ]
        },
        "splits": [
          {
            "payout_destination_id": "seller-1",
            "amount": 29700
          }
        ],
        "shipment_id": "<string>",
        "shipment_items": [
          {
            "line_id": "line-id-1",
            "quantity": 123
          }
        ]
      }
    ],
    "shipping_mode": "shipping_required",
    "discount_codes": {
      "max_count": 123,
      "callback_url": "https://example.com/order/00128110/discount_codes_updated"
    },
    "shipping_address_callback_url": "https://example.com/order/00128110/address_updated",
    "customer_types": [
      "b2c",
      "b2b"
    ],
    "default_different_billing_shipping_address": []
  },
  "metadata": {
    "session:profile_id": "<string>"
  },
  "operations": [
    {
      "method": "POST",
      "href": "https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/payex.creditcard",
      "rel": "view-payex-creditcard",
      "content_type": "application/json"
    },
    {
      "method": "POST",
      "href": "https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/collector.installment",
      "rel": "view-collector-installment",
      "content_type": "application/json"
    }
  ],
  "version": "22596363b3de40b06f981fb85d82312e8c0ed511"
}

Documentation Index

Fetch the complete documentation index at: https://docs.dintero.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
If-Unmodified-Since
string

Optional header. The put request is discarded and a 412 is returned if the header does not match the updated_at property of the session.

Path Parameters

​
session_id
string<checkout-id>
required

The session ID

Body

application/json

A shipping option

​
id
string
required

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.

Example:

"bring-pick-up-00001"

​
line_id
string
required

Unique id of the specific configuration of this shipping product

Example:

"bring-pick-up-00001-location-0a1f6b"

​
amount
integer
required

The monetary amount of the shipping option, including VAT and discounts.

In smallest unit for the currency, e.g. cents

Example:

3900

​
title
string
required

A shipping option title. Eg. "Standard"

Example:

"Standard"

​
operator
string
required

Name of company that provides shipping service

Example:

"Bring"

​
countries
string<iso3166-alpha2>[]

Countries where this shipping option can be used

​
vat_amount
integer

The VAT of the amount parameter. Only used for display purposes.

Example:

975

​
vat
number

The VAT percentage. Supports up to 2 decimal places. If the vat is 20% the number should be 20, not 0.2.

Example:

25

​
description
string

A short description of the shipping option product

Example:

"Pick up at your nearest postal office"

​
delivery_method
enum<string>
Available options:
delivery,
pick_up,
unspecified,
none
Example:

"pick_up"

​
operator_product_id
string

The operators own id for this shipping product

Example:

"pick-up-00001-location-0a1f6b"

​
eta
object

Estimated time of arrival

​
time_slot
object

A specified time for delivery to customer

​
pick_up_address
object

Additional information about the shipping address

​
metadata
object

Additional metadata about the shipping_option

Example:
{
  "operator_dest": "XAB1239",
  "number_x": 1921
}
​
environmental_data
object

Environmental data about the shipping option

​
thumbnail_url
string<uri>

URL to a thumbnail of the shipping option. Will be displayed when redirecting to the session. Recommended limitations for the image:

  • all images should preferrably have the same dimensions
  • max file size should be less than 2MB
​
pay_in_store
object

Enable pay in-store during pick-up. The amount to be paid will be zero. Requires that the payment method dintero.zero is enabled

​
fee_split
object

Specify how fees are handled with splits. The default behaviour is to share the fees proportional with all splits destinations

​
splits
object[]

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. auto_capture cannot be enabled when splits are defined as empty array.

​
shipments
object[]

For multiple shipments we have a single top-level shipping object that contains the shipments for the order. The shipping options defined in shipments must contain shipment_items that define what items belong to what shipment.

For multiple shipments:

  • do not define splits on the toplevel shipping option
  • do not define fee_split on the toplevel shipping option
  • the pay_in_store option is not compatible with shipments
  • empty shipments array is not allowed
  • single item multi shipping option is not allowed
Minimum array length: 2

Response

checkout session

​
url
object
required
​
order
object
required
​
configuration
object
required
​
id
string

An ID that uniquely identifies the resource

​
created_at
string<date-time>

The date-time when the resource was created

​
customer
object
​
expires_at
string<date-time>
​
checkboxes
object[]

Configuration for checkboxes that should be part of the checkout

Maximum array length: 2
​
express
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.

  1. Set shipping address
  2. Set shipping option
​
metadata
object

metadata about the session

​
operations
object[]

Set of operation available, which operation available will depend on the current state of the session.

Example:
[
  {
    "method": "POST",
    "href": "https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/payex.creditcard",
    "rel": "view-payex-creditcard",
    "content_type": "application/json"
  },
  {
    "method": "POST",
    "href": "https://checkout.api.dintero.com/v1/view/P00000000.465UfBENeLpkBvwmqfTC4k/payment/collector.installment",
    "rel": "view-collector-installment",
    "content_type": "application/json"
  }
]
​
version
string

String that represents the state of the session.

Example:

"22596363b3de40b06f981fb85d82312e8c0ed511"

​
data_visibility
enum<string>
Available options:
full,
masked
Last modified on May 26, 2026