📘
"displayedPaymentMethods": "UPI

Payment Method Features

Feature	Description
Country	India
Processing Currencies	INR - Indian Rupees
Payments	Yes
Disbursements	No
-- Min per transaction amount	1 INR
-- Max per transaction amount	100,000 INR
Refunds	Yes
Chargebacks	No

Workflow: Payment & Refund

Download in high resolution

Possible Payment Scenarios:

Our API will provide you with all the necessary information to execute on of the following scenarios:

Name	Steps
Displaying a QR Code in a Web Browser	The client initiates a payment. The system returns a link to the checkout page on the platform. The client is redirected to the checkout page on the platform. The user enters the required payment details and clicks the payment button. The system displays a QR code for scanning by the UPI app. The end user scans the QR code with a mobile device and is redirected to the mobile app for payment. The payment status is returned via a callback.
Payment via Mobile Application	The client initiates a payment. The system returns a link to the checkout page on the platform. The client is redirected to the checkout page on the platform. The user enters the required payment information and clicks the payment button. The system displays a list of apps for the user to navigate to. The user completes the payment in their app. The payment status is returned via a callback.

Name

Steps

Displaying a QR Code in a Web Browser

The client initiates a payment.
The system returns a link to the checkout page on the platform.
The client is redirected to the checkout page on the platform.
The user enters the required payment details and clicks the payment button.
The system displays a QR code for scanning by the UPI app.
The end user scans the QR code with a mobile device and is redirected to the mobile app for payment.
The payment status is returned via a callback.

Payment via Mobile Application

The client initiates a payment.
The system returns a link to the checkout page on the platform.
The client is redirected to the checkout page on the platform.
The user enters the required payment information and clicks the payment button.
The system displays a list of apps for the user to navigate to.
The user completes the payment in their app.
The payment status is returned via a callback.

List of used API Requests:

Request	Endpoint	Description
Intent Creation	`POST /processing/api/v1/intents`	Creates a new Intent and returns the URL for redirection to the platform checkout

Intent Creation Request/Response

📘
Request specifics

Endpoint: POST /processing/api/v1/intents

Purpose: Creates an Intentfor the selected payment method.

Structure: A unified request structure is used for all supported payment methods.

For this method:

The paymentIntent object is populated

paymentIntent is populated with true

The paymentIntent.formDetails.displayedPaymentMethods array contains the UPI

The following optional fields are recommended for populating:

paymentIntent.description

paymentIntent.payer.firstname

paymentIntent.payer.lastname

paymentIntent.payer.taxIdentification

Request Description

{
  "clientReferenceId": "1234",
  "useCheckoutForm": true,
  "paymentIntent": {
    "formDetails": {
      "template": "string",
      "displayedPaymentMethods": ["UPI"],
      "backToStoreRedirectUrl": "string"
    },
    "submittedAmount": {
      "value": 100.05,
      "currency": "INR"
    },
    "description": "INTENT 1234",
    "webhookUrl": "webhookUrl",
    "payer": {
      "firstname": "Jake",
      "lastname": "Yellow",
      "taxIdentification": "AAAPZ1234C"
    },
    "payee": {}
  },
  "description": "INTENT 1234",
  "merchant": {
    "name": "Mustermann",
    "website": "website.io"
  }
}

Top-Level Request Parameters

Parameter	Type	Required	Description
`clientReferenceId`	String	`Required`	Order number in the merchant system.
`useCheckoutForm`	Boolean	`Conditional`	Optional in general. Must be set to `true` when using the Checkout Form integration.
`paymentIntent`	Object	`Conditional`	Optional in general. Must be provided when using the Checkout Form integration.
`description`	String	`Optional`	Order description. Displayed if `paymentIntent.description` is not provided.
`merchant`	Object	`Optional`	Merchant information. Required if the store name must be displayed on the checkout form.

paymentIntent

Parameter	Type	Required	Description
`formDetails`	Object	`Optional`	Checkout parameters
`submittedAmount`	Object	`Required`	Order amount and currency
`description`	String	`Optional`	Order Description that can be displayed on the Checkout Form.
`webhookUrl`	String	`Required`	URL to which we will send webhooks related to payments created within the Intent and their status changes
`payer`	Object	`Optional`	Payer (consumer) details. May be used to pre-fill the checkout form and for compliance/risk purposes.
`payee`	Object	`Optional`	Payee (recipient/beneficiary) details. Used for compliance and reporting purposes when applicable.

formDetails

Parameter	Type	Required	Description
`template`	String	`Optional`	The name of the checkout template to be used. Multiple templates can be configured and selected for different use cases
`displayedPaymentMethods`	Array of Strings	`Optional`	List of payment methods to be made available to the payer. If only one payment method is provided, no selection screen is shown and the payer is taken directly to that payment method
`backToStoreRedirectUrl`	String	`Optional`	URL to which the payer is redirected if they leave the Checkout Form or after payment completion. Must start with "https://".

submittedAmount

Parameter	Type	Required	Description
`value`	Number	`Required`	Submitted order amount. May differ from the authorised amount if FX conversion is applied.
`currency`	String	`Required`	Submitted order currency. May differ from the authorised amount if FX conversion is applied.

payer

Parameter	Type	Required	Description
`firstname`	String	`Optional`	Payer's first name. Example: `Jake`
`lastname`	String	`Optional`	Payer's last name. Example: `Yellow`
`phone`	String	`Optional`	Payer's phone number, including country code. Example: `+62285128011`
`email`	String	`Optional`	Payer's email address. Example: `[email protected]`
`countryIsoCode`	String	`Optional`	Payer's country of residence in ISO 3166-1 alpha-2 format. Example: `PH`
`locale`	String	`Optional`	The locale describing the preferred language of the consumer. Used to localise the checkout form when supported. Example: `de-DE`
`taxIdentification`	String	`Optional`	The consumer tax identification number (e.g., social security identification). Required by some payment methods or jurisdictions. Example: `798154336790`
`merchantPayerReference`	String	`Optional`	The merchant-provided payer reference. Allows linking the payer to an internal customer record on the merchant side. Example: `12345`

payee

Parameter	Type	Required	Description
`firstNameLocal`	String	`Optional`	Payee's first name in the local language. Example: `Иван`
`lastNameLocal`	String	`Optional`	Payee's last name in the local language. Example: `Иванов`
`firstNameEng`	String	`Optional`	Payee's first name in English. Example: `Ivan`
`lastNameEng`	String	`Optional`	Payee's last name in English. Example: `Ivanov`
`dateOfBirth`	String	`Optional`	Payee's date of birth in `YYYY-MM-DD` format. Example: `1985-02-14`
`placeOfBirth`	String	`Optional`	Payee's place of birth. Example: `Smolensk`
`nationality`	String	`Optional`	Payee's nationality in ISO 3166-1 alpha-2 format. Example: `RU`
`occupation`	String	`Optional`	Payee's occupation. Example: `Software Engineer`
`idType`	String	`Optional`	Type of identification document presented by the payee (e.g., `PASSPORT`, `ID_CARD`). Example: `PASSPORT`
`idNumber`	String	`Optional`	Identification document number that matches the `idType`. Example: `AA1234567`
`taxId`	String	`Optional`	Payee's personal tax identification number. Example: `123456789`
`currentAddress`	Object	`Optional`	Payee's current residential address. See the currentAddress table below for the field structure.
`email`	String	`Optional`	Payee's email address.
`phone`	String	`Optional`	Payee's phone number.
`companyName`	String	`Optional`	Name of the company the payee represents (when the payee is a legal entity). Example: `ABC Ltd.`
`companyRegistrationNumber`	String	`Optional`	Registration number of the payee's company. Example: `987654321`
`companyTaxId`	String	`Optional`	Tax identification number of the payee's company. Example: `321654987`
`companyRegisteredAddress`	String	`Optional`	Registered legal address of the payee's company.
`merchantPayeeReference`	String	`Optional`	The merchant-provided payee reference. Allows linking the payee to an internal record on the merchant side. Example: `12345`
`additionalData`	Object	`Optional`	Free-form key/value object for any additional payee details required by specific payment methods or compliance rules.

payee.currentAddress

Parameter	Type	Required	Description
`country`	String	`Optional`	Country of the address in ISO 3166-1 alpha-2 format. Example: `RU`
`city`	String	`Optional`	City. Example: `Smolensk`
`addressLine`	String	`Optional`	Street address line. Example: `Minusinskaya st., 6, 10`
`postCode`	String	`Optional`	Postal / ZIP code. Example: `720001`

merchant

Parameter	Type	Required	Description
`name`	String	`Optional`	The name of store, that might be displayed on the checkout form if configured
`website`	String	`Optional`	The website of the store

Refunds

📘
Refunds cannot exceed the total value of confirmed transactions for the current day.

To initiate the refund (full or partial) to the payer's original payment instrument, you must send a separate Refund request.

Use the following endpoint: Create Refund and specify the following parameters:

{
  "paymentId": 204264682781298700,
  "partial": false,
  "reason": "Customer requested a refund",
  "webhookUrl": "webhookUrl"
}

{
  "paymentId": 204264682781298700,
  "partial": true,
	"paymentAuthAmount": {
    "value": 100.05,
    "currency": "INR"
  },

  "reason": "Customer requested a refund",
  "webhookUrl": "webhookUrl"
}

Refund amount rules

Rule	Description
Full refund	Send `paymentId` and set `partial` to `false`, or omit `partial` entirely. The full refundable amount will be refunded.
Partial refund	Set `partial` to `true` and provide exactly one of the following objects: `paymentSubmittedAmount` or `paymentAuthAmount`.
Mutually exclusive amount objects	Do not send `paymentSubmittedAmount` and `paymentAuthAmount` in the same request.
FX payments	If the original payment involved FX conversion, the refund is calculated using the same exchange rate as the original payment.
Currency choice	Use `paymentSubmittedAmount` if you want to define the refund in the original submitted currency. Use `paymentAuthAmount` if you want to define the refund in the authorised or settlement currency.

Top-Level Refund Request Parameters

Parameter	Type	Required	Description
`paymentId`	int64	`Required`	Identifier of the original payment transaction to which this refund applies. Use the `paymentId` returned in the original payment or Intent creation response.
`partial`	Boolean	`Optional`	Indicates whether the refund is partial or full. `true` - partial refund. `false` - full refund. If omitted, the platform treats the request as a full refund.
`paymentSubmittedAmount`	Object	`Conditional`	Refund amount in the original submitted currency. Required when `partial = true` and the refund amount is defined in the submitted currency. Do not send together with `paymentAuthAmount`.
`paymentAuthAmount`	Object	`Conditional`	Refund amount in the authorised or settlement currency. Required when `partial = true` and the refund amount is defined in the authorised currency. Do not send together with `paymentSubmittedAmount`.
`reason`	String	`Optional`	Free-form refund reason. Used for informational and audit purposes.
`webhookUrl`	String	`Optional`	URL to which refund status change webhooks will be sent.

paymentSubmittedAmount

Parameter	Type	Required	Description
`value`	Number	`Required`	Refund amount value in the original submitted currency.
`currency`	String	`Required`	Refund currency in ISO 4217 alpha-3 format. Must match the original submitted currency.

paymentAuthAmount

Parameter	Type	Required	Description
`value`	Number	`Required`	Refund amount value in the authorised or settlement currency.
`currency`	String	`Required`	Refund currency in ISO 4217 alpha-3 format. Must match the original authorised or settlement currency.

After the creation of the refund request you must wait for the callback, that will provide you with the latest transaction status

Webhooks

🔗
This section summarises the webhook events triggered for UPI payment.
For payload structure, examples, retry policy and delivery conditions, see the dedicated pages: Webhooks: Overview and Webhooks: Example.

When Webhooks Are Sent

A webhook is dispatched to your webhookUrl when the payment reaches a final status:

Status	Trigger
`CAPTURED`	The payment has been successfully completed.
`DECLINED`	The payment was rejected by the issuing bank / processor.
`ERROR`	A processing error prevented the payment from being completed.

Delivery & Retries

📘

Webhooks are delivered as HTTPS POST requests with a JSON payload to the webhookUrl provided in the original disbursement request.

A delivery is considered successful if your endpoint responds with HTTP 2xx.

If the delivery fails (non-2xx, network error, timeout), the platform retries up to 10 times following a fixed schedule (immediate → 1 min → 5 min → 15 min → 1 h → 3 h → 6 h → 12 h → 24 h → 48 h).

After the 10th attempt, delivery stops permanently.

Full details: Webhooks: Overview.

Payload Example

📓
The webhook payload structure is shared across all transaction types and may evolve over time.
For the up-to-date payload example, see the Webhooks: Example page.

Testing in Sandbox

📘
Our test environment allows us to simulate the full payment cycle and run all possible final status options without the involvement of a real bank and payment application. To force a specific outcome, set the intent.description field to one of the trigger values below.

List of Test Scenarios

Scenario	intent.description Value	Final Status
Successful payment	CapturedPaymentShort	CAPTURED
Declined. payment	DeclinedPaymentShort	DECLINED
Processing error	ErrorPaymentShort	ERROR

End-to-End Test Flow

Download in high resolution

Step-by-Step Scenario Description

Scenario	Steps
Successful payment	Create an paymentIntent via POST /processing/api/v1/intents with intent.description = "CapturedPaymentShort". Receive a synchronous response with intentStatus = CREATEDand with a URL to redirect to the checkout page in paymentIntent.additionalData.details.url parameter Our platform simulates the successful creation of a payment. Receive a webhook with status = AUTHORIZATION_REQUESTED. Our platform simulates the successful completion of a payment. Receive a final webhook with status = CAPTURED.
Declined. payment	Create an paymentIntent via POST /processing/api/v1/intents with intent.description = "DeclinedPaymentShort". Receive a synchronous response with intentStatus = CREATEDand with a URL to redirect to the checkout page in paymentIntent.additionalData.details.url parameter Our platform simulates the successful creation of a payment. Receive a webhook with status = AUTHORIZATION_REQUESTED. Our platform simulates a payment refusal. Receive a final webhook with status = DECLINED.
Processing error	Create an paymentIntent via POST /processing/api/v1/intents with intent.description = "ErrorPaymentShort". Receive a synchronous response with intentStatus = CREATEDand with a URL to redirect to the checkout page in paymentIntent.additionalData.details.url parameter Our platform simulates an error when creating a payment. Receive a final webhook with status = ERROR.