Payment - Storefront GraphQL API

mutation

initialisePayment

Initiate the payment procedure for an order. Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order, polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID.

Arguments

paymentInitializationRequestInput

PaymentInitializationRequestInput

Payment Initialization Request.

Response

aggregator

String!

Required

Payment gateway name.

aggregator_order_id

String

Payment order id.

amount

Int

Payable amount.

bqr_image

String

Bharat qr image url.

currency

String

Currency code.

customer_id

String

Payment gateway customer id.

device_id

String

EDC machine Unique Identifier.

merchant_order_id

String!

Required

Order id.

method

String!

Required

Payment method.

polling_url

String!

Required

Polling url.

razorpay_payment_id

String

Payment id.

status

String

Status of payment.

success

Boolean!

Required

Response is successful or not.

timeout

Int

Timeout.

upi_poll_url

String

UPI poll url.

virtual_id

String

Payment virtual address.

vpa

String

Customer vpa address.

Mutation

1mutation initialisePayment(
2  $paymentInitializationRequestInput: PaymentInitializationRequestInput
3) {
4  initialisePayment(
5    paymentInitializationRequestInput: $paymentInitializationRequestInput
6  ) {
7    aggregator
8    aggregator_order_id
9    amount
10    bqr_image
11    currency
12    customer_id
13    device_id
14    merchant_order_id
15    method
16    polling_url
17    razorpay_payment_id
18    status
19    success
20    timeout
21    upi_poll_url
22    virtual_id
23    vpa
24  }
25}

Try it

Input Variables

1{
2  "paymentInitializationRequestInput": {
3    "aggregator": "aggregator",
4    "amount": 42,
5    "contact": "contact",
6    "currency": "currency",
7    "customer_id": "customer_id",
8    "device_id": "device_id",
9    "email": "test-email@yourcompany.com",
10    "merchant_order_id": "merchant_order_id",
11    "method": "method",
12    "order_id": "order_id",
13    "razorpay_payment_id": "razorpay_payment_id",
14    "timeout": 42,
15    "vpa": "vpa"
16  }
17}

Response

1{
2  "initialisePayment": {
3    "aggregator": "aggregator",
4    "aggregator_order_id": "aggregator_order_id",
5    "amount": 42,
6    "bqr_image": "bqr_image",
7    "currency": "currency",
8    "customer_id": "customer_id",
9    "device_id": "device_id",
10    "merchant_order_id": "merchant_order_id",
11    "method": "method",
12    "polling_url": "polling_url",
13    "razorpay_payment_id": "razorpay_payment_id",
14    "status": "status",
15    "success": true,
16    "timeout": 42,
17    "upi_poll_url": "upi_poll_url",
18    "virtual_id": "virtual_id",
19    "vpa": "vpa"
20  }
21}

Was this section helpful?

« VerifyOtpResponse

aggregatorsConfig »