Checkout request including cart/payment details, addresses, callbacks, order type, and metadata. Use either address_id/billing_address_id or pass delivery_address/billing_address.
Fields
address_id
StringDelivery address ID. Example: 'addr_001'
aggregator
StringPayment aggregator (e.g., Fynd, Razorpay, Juspay). Example: 'Razorpay'
billing_address
JSONBilling address JSON (address, phone, email, pincode, landmark, name). Example: { address: '221B Baker St', phone: '9876543210' }
billing_address_id
StringBilling address ID. Example: 'addr_bill_01'
callback_url
StringCallback URL after payment success/failure. Example: 'https://example.com/pay/callback'
cart_id
StringCart ID. Example: '5bb521cfdc83215e1889b346'
custom_meta
JSONCustom order metadata. Example: { source: 'app' }
customer_details
CustomerDetailsInputCustomer details.
delivery_address
JSONDelivery address JSON (address, phone, email, pincode, landmark, name). Example: { address: '221B Baker St', phone: '9876543210' }
extra_meta
JSONExtra metadata for checkout. Example: { campaign: 'SUMMER' }
id
StringCart ID (alias). Example: '5bb521cfdc83215e1889b346'
iin
StringCard IIN (first six digits) for card payments (e.g., 123456). Example: '411111'
merchant_code
StringMerchant code (e.g., ICICI, AXIS). Example: 'ICICI'
meta
JSONCheckout metadata. Example: { experiment: 'A' }
network
StringCard network (e.g., VISA, MASTERCARD, RUPAY). Example: 'VISA'
order_type
StringOrder type of the shipment (e.g., 'PickAtStore', 'HomeDelivery','Digital). Example: 'HomeDelivery'
ordering_store
IntOrdering store ID. Example: 1234
payment_auto_confirm
BooleanAuto-confirm payment without user action. Example: false
payment_identifier
StringPayment identifier. Example: 'pay_abc123'
payment_methods
[PaymentMethodInput]Payment methods list. Example: [{ amount: 499.0, mode: 'CARD', name: 'Visa', payment_meta: { merchant_code: 'ICICI', payment_gateway: 'Razorpay', payment_identifier: 'pay_abc123' } }]
payment_mode
String!Required
Payment mode (e.g., COD, CARD, NB). Example: 'CARD'
payment_params
JSONPayment params (identifier, merchant code). Example: { payment_identifier: 'pay_abc123', merchant_code: 'ICICI' }
order_tags
[OrderTagInput]List of order tags used to classify and visually enhance order cards.
staff
StaffCheckoutInputStaff details if checkout is on behalf of a customer.
type
StringCard type for card payments (e.g., DEBIT, CREDIT). Example: 'CREDIT'
success_callback_url
StringSuccess callback URL. Example: 'https://example.com/pay/success'
failure_callback_url
StringFailure callback URL. Example: 'https://example.com/pay/failure'
Was this section helpful?