INR APM using host-to-host

The host-to-host communication allows a merchant to send all the data needed for a payment in the background without using XGateway checkout pages. This flow has the best conversion rate because it allows the customer to stay withim merchant domain.

Payment Flow

The host-to-host flow for INR payment includes the following 3 steps:

  1. Create an invoice

  2. Get payment details

  3. Confirm the payment

circle-exclamation

Create an invoice

Use the following body against extended invoice creation API

chevron-rightRequest bodyhashtag
{
    "amount":"501",
    "baseCurrency":"INR",
    "customerId":"some-customer-uuid",
    "orderId":"some-order-id",
    "paymentCurrency":"INR",
    "paymentMethod":"basic_h2h",
    "paymentSystem":"UPI"
}

Take the invoice ID from the response body

chevron-rightResponse examplehashtag

Get payment details

Get the payment details for a UPI transaction using this API and the invoide ID

Get deposit recipient details (Merchant API).

get

Retrieves recipient details for a deposit transaction for a merchant. Returns bank account information where the customer should send their payment. Requires merchant authentication via API key.

Authorizations
x-api-keystringRequired
Path parameters
invoiceIdstringRequired
  • Unique identifier of the invoice.
Responses
chevron-right
200

A successful response containing recipient details.

application/json

The AppSuccessResponse object contains general information about the success execution.

successbooleanRequiredDefault: true
get
/gateway9/deposit/{invoiceId}/recipient-details

Confirm the payment

Use the following API to submit the UTR.

Confirm deposit payment (Merchant API).

post

Confirms a deposit payment for a merchant This endpoint validates and confirms a customer's payment when they provide the UTR (Unique Transaction Reference). Requires merchant authentication via API key.

Authorizations
x-api-keystringRequired
Body
  • Request body containing payment confirmation details.
invoiceIdstringRequired
utrstringRequired
receipt_filestringOptional
receipt_file_extensionstringOptional
receipt_file_namestringOptional
Responses
chevron-right
200

A successful response with confirmation message.

application/json

The AppSuccessResponse object contains general information about the success execution.

successbooleanRequiredDefault: true
datastringRequired
post
/gateway9/deposit/confirm

Confirming a transaction

triangle-exclamation

To confirm the received deposit callback is valid, please use the API endpoint.

Testing Demo environment

Check this page for ways to test the integration.

Last updated