Checkout

This API initiates the payment process and redirects the customer to the selected payment channel.

Checkout - Request Example

Endpoint:

{{base-url}}/upg/checkout

Method: POST

Request Headers:

Content-Type: multipart/form-data

Request Body (multipart/form-data):

  --form 'merchantId="7"' \
  --form 'orderId="teett"' \
  --form 'merchantName="Test Company"' \
  --form 'amount="89.99"' \
  --form 'paymentMethod="test"' \
  --form 'description="Payment for order #123"' \
  --form 'merchantCustomerName="Dummy user"' \
  --form 'merchantCustomerPhoneNumber="9800000000"' \
  --form 'signature="9d53e20329bc7........bc1812addfa5cdc1c6c584f5"'

Example Fields Summary:

Key	Value
merchantId	7
orderId	teett
merchantName	Test Company
amount	89.99
paymentMethod	test
description	Payment for order #123
merchantCustomerName	Dummy user
merchantCustomerPhoneNumber	9800000000 (Must be 10 digits)
signature	9d53e20329bc7........bc1812addfa5cdc1c6c584f5

Checkout - Response Example

This endpoint does not return a JSON response body in the usual REST sense. Instead, the server responds with an HTML page that starts the payment flow and redirects the customer to the selected payment channel as follows:

Service Parameters

Parameter Name	Type	Required	Description
merchantId	Integer	Yes	Unique identifier assigned to the merchant.
orderId	String	Yes	Unique order identifier for the transaction.
merchantName	String	Yes	Merchant’s registered business name.
amount	String	Yes	Payment amount in NPR. Example: 89.99
paymentMethod	String	Yes	Selected payment method or provider.
description	String	Yes	Brief description of the payment purpose.
merchantCustomerName	String	Yes	Customer name associated with the order.
merchantCustomerPhoneNumber	String	Yes	Customer phone number (Must be 10 digits).
signature	String	Yes	HMAC-SHA256 signature generated for this checkout request.

Notes

note

• After successful checkout, customer is redirected to the payment interface after the payment is completed through selected channel.
• transaction_id is returned through callback URL which can be used to check the transaction status.