Create Checkout Object

Create a Checkout Object

POST /api/merchants/checkout

Example request body

{
    "chekout_object":"",
    "amounts": {
        "total": 15,
        "subtotal": 15,
        "tax": 5,
        "shipping": 3,
        "discount_total": null,
        "currency": "USD"
    },
    "billing": {
        "name": "Alice Jones",
        "address_1": "123 East St.",
        "address_2": "Apt. D",
        "city": "New York",
        "area": null,
        "zone_code": "NY",
        "country_code": "US",
        "postal_code": "90210",
        "phone_number": "[phone]"
    },
    "shipping": {
        "name": "Alice Jones",
        "address_1": "123 East St.",
        "address_2": "Apt. D",
        "city": "New York",
        "area": null,
        "zone_code": "NY",
        "country_code": "US",
        "postal_code": "90210",
        "phone_number": "[phone]"
    },
    "platform": {
        "platform_type": "magento",
        "platform_version": "1.3"
    },
    "items": [
        {
            "price": {
                "amount": 15019,
                "currency": "USD"
            },
            "name": "straight_leg_jean",
            "sku": "4db3ifnl",
            "quantity": 2,
            "image": "https://pixabay.com/images/id-1772243/",
            "category": [
                [
                    "clothing",
                    "jeans"
                ]
            ]
        },
        {
            "price": {
                "amount": 19472,
                "currency": "USD"
            },
            "name": "wide_leg_jean",
            "sku": "syt9r0ub",
            "quantity": 3,
            "image": "https://pixabay.com/images/id-1772243/",
            "category": [
                [
                    "clothing",
                    "jeans"
                ]
            ]
        },
        {
            "price": {
                "amount": 15,
                "currency": "USD"
            },
            "name": "cropped_jean",
            "sku": "r84qlsok",
            "quantity": 2,
            "image": "https://pixabay.com/images/id-1772243/",
            "category": [
                [
                    "clothing",
                    "jeans"
                ],
                [
                    "sale"
                ]
            ]
        }
    ],
    "created_at": "2023-02-16T13:35:15.586091Z",
    "updated_at": "2023-02-16T13:35:15.586109Z",
    "shipping_method": "overnight",
    "merchant_checkout_id": "4b718371-a466-4270-bc97-ece09d256443",
    "merchant_user_id": "1234",
    "redirect_cancel_url": "https://merchant.com/cancel",
    "redirect_confirm_url": "https://merchant.com/redirect",
    "subscription_status": "",
    "plan_type": "MO",
    "is_subscription": true,
    "user_cohorts": [
        "platinum",
        "newsletter",
        "club_membe"
    ]
}

Response

{
    "id": "ch-b402978c257143b6970b478a566c808f"
}

header

api-key · string

You will get this API key in the response of ‘generate api key button’ on merchant object.

Body

checkout_data · Decimal · required

Use checkout dictionary as input, refer example request for input data.

Show Top level parameters

amount · Decimal · required

The order total inclusive of tax, shipping, and merchant discounts.

billing · Decimal · required

The subtotal that should be displayed to the consumer.

shipping · Decimal · required

The amount of tax on the order.

platform · Decimal · required

The amount of shipping cost on the order.

item · Decimal

The discount total that should be displayed to the consumer.

created_at · DateTime · required

This is used to store create time of checkout object.

updated_at · DateTime · required

This is used to store update time of checkout object.

shipping_method · String

This is used to store shipping method.

merchant_checkout_id · String · required

The ID of this checkout in the merchant’s system which magic will store for shared identification purposes. This ID should be unique per checkout.

merchant_user_id · String · required

The ID of the consumer in the merchant’s system which magic will store for shared identification purposes.

redirect_cancel_url · UrlField · required

The URL to direct the customer’s browser to in the event that they don’t successfully confirm their checkout with Magic.

redirect_confirm_url · UrlField · required

The URL to direct the customer’s browser to in the event that they successfully confirm their checkout with Magic.

plan_type · String

This is used to store update object time.

is_subscription · Boolean · required

This is used to indicate subscription status.

user_cohorts · ArrayField · required

The array of cohortts inputs.

Show Amount

total · Decimal · required

The order total inclusive of tax, shipping, and merchant discounts.

subtotal · Decimal · required

The subtotal that should be displayed to the consumer.

tax · Decimal · required

The amount of tax on the order.

shipping · Decimal · required

The amount of shipping cost on the order.

discount_total · Decimal

The discount total that should be displayed to the consumer.

currency · String · required

The currency in which the amounts are represented.

Show Billing

name · String · required

The name of the person receiving the shipment of the order.

address_1 · Decimal · required

The street address where the order will be shipped.

address_2 · Decimal

The optional apartment, suite, unit, etc. where the order will be shipped.

city · Decimal · required

The city of the shipping address.

area · Decimal

The area of the shipping address.

zone_code · String · required

The state or province abbreviation for the shipping contact, such as ‘NY’ or ‘CA’.

country_code · String · required

The country code for the shipping address, such as ‘US’.

postal_code · String · required

The postal code of the shipping address.

phone_number · String

The phone number associated with the shipment. Format: “[phone]”

Show Shipping

name · String · required

The name of the person receiving the shipment of the order.

address_1 · Decimal · required

The street address where the order will be shipped.

address_2 · Decimal

The optional apartment, suite, unit, etc. where the order will be shipped.

city · Decimal · required

The city of the shipping address.

area · Decimal

The area of the shipping address.

zone_code · String · required

The state or province abbreviation for the shipping contact, such as ‘NY’ or ‘CA’.

country_code · String · required

The country code for the shipping address, such as ‘US’.

postal_code · String · required

The postal code of the shipping address.

phone_number · String

The phone number associated with the shipment. Format: “[phone]”

Show Platform

platform_type · String

Name of the platform the merchant is on.

platform_version · String

Version of the platform the merchant is on.

Show Item

Item is accept list of items as input, you have to create list of your items and and give that list in the itme’s value in the checkout object dictionary.

name · String · required

The name of the item.

sku · Decimal · required

The SKU of the item.

price · Decimal

The price of the item.

quantity · Decimal · required

The quantity of the item.

category · Decimal

Array of arrays containing category strings.

image · String · required

The image of ordered item.

checkout_object · String · required

Current chekout object id.

Example request body

{
    "chekout_object":"",
    "amounts": {
        "total": 15,
        "subtotal": 15,
        "tax": 5,
        "shipping": 3,
        "discount_total": null,
        "currency": "USD"
    },
    "billing": {
        "name": "Alice Jones",
        "address_1": "123 East St.",
        "address_2": "Apt. D",
        "city": "New York",
        "area": null,
        "zone_code": "NY",
        "country_code": "US",
        "postal_code": "90210",
        "phone_number": "[phone]"
    },
    "shipping": {
        "name": "Alice Jones",
        "address_1": "123 East St.",
        "address_2": "Apt. D",
        "city": "New York",
        "area": null,
        "zone_code": "NY",
        "country_code": "US",
        "postal_code": "90210",
        "phone_number": "[phone]"
    },
    "platform": {
        "platform_type": "magento",
        "platform_version": "1.3"
    },
    "items": [
        {
            "price": {
                "amount": 15019,
                "currency": "USD"
            },
            "name": "straight_leg_jean",
            "sku": "4db3ifnl",
            "quantity": 2,
            "image": "https://pixabay.com/images/id-1772243/",
            "category": [
                [
                    "clothing",
                    "jeans"
                ]
            ]
        },
        {
            "price": {
                "amount": 19472,
                "currency": "USD"
            },
            "name": "wide_leg_jean",
            "sku": "syt9r0ub",
            "quantity": 3,
            "image": "https://pixabay.com/images/id-1772243/",
            "category": [
                [
                    "clothing",
                    "jeans"
                ]
            ]
        },
        {
            "price": {
                "amount": 15,
                "currency": "USD"
            },
            "name": "cropped_jean",
            "sku": "r84qlsok",
            "quantity": 2,
            "image": "https://pixabay.com/images/id-1772243/",
            "category": [
                [
                    "clothing",
                    "jeans"
                ],
                [
                    "sale"
                ]
            ]
        }
    ],
    "created_at": "2023-02-16T13:35:15.586091Z",
    "updated_at": "2023-02-16T13:35:15.586109Z",
    "shipping_method": "overnight",
    "merchant_checkout_id": "4b718371-a466-4270-bc97-ece09d256443",
    "merchant_user_id": "1234",
    "redirect_cancel_url": "https://merchant.com/cancel",
    "redirect_confirm_url": "https://merchant.com/redirect",
    "subscription_status": "",
    "plan_type": "MO",
    "is_subscription": true,
    "user_cohorts": [
        "platinum",
        "newsletter",
        "club_membe"
    ]
}

Response

success · number

This Response field will return unique ‘checkout_id’ and status code 200 if the transaction succeeds.

Example Request

curl --location --request POST 'http://127.0.0.1:8000/api/merchants/checkout' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \

Response

{
    "id": "ch-b402978c257143b6970b478a566c808f"
}