Checkout request schema which includes custom meta, merchant code, cart id, payment methods, address id, callback url, order type, billing address and card details.
Fields
address_id
StringAddress id of the user where the order to be delivered.
aggregator
StringAggregator of payment mode to do the payment.
billing_address
JSONBilling address json which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
billing_address_id
StringBilling address id selected by user on which shipment bill to be generated.
callback_url
StringCallback url after payment received/failed.
cart_id
StringCart id of the user cart.
custom_meta
JSONCustom meta data to be added in order.
customer_details
CustomerDetailsInputCustomer details to be added in order.
delivery_address
JSONDelivery address data which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
extra_meta
JSONExtra meta to be added while checkout in order.
id
StringCart id of the user cart.
iin
StringIssuer Identification Number' number of card if payment mode is card to do the payment.
merchant_code
StringMerchant code of the payment mode selected to do the payment.
meta
JSONMeta data sent while checkout.
network
StringNetwork of card if payment mode is card to do the payment.
order_type
StringOrder type of the order being placed like pickAtStore or HomeDelivery.
ordering_store
IntOrdering store id of the store from which the order is getting placed.
payment_auto_confirm
BooleanPayment auto confirm flag if payment need not to be collected from user.
payment_identifier
StringPayment identifier of the payment mode selected to do the payment.
payment_methods
[PaymentMethodInput]!Required
Payment methods list used to make the payment.
payment_mode
String!Required
Payment mode of the payment selected to do the payment.
payment_params
JSONPayment params which includes payment identifier and merchant code.
staff
StaffCheckoutInputStaff details which can be added while checkout if staff member is doing check on behalf of customer which incluedes empployee code, user, last name, first name and staff user id.
type
StringType of cart if payment mode is card to do the payment.
Was this section helpful?