TRANXACT.AI Help

India statutory · Services and actions

Upi

The upi service of India statutory: 7 operation(s).

Type REST7 operationsBase path /api/india/upi

Download specification (OpenAPI 3.1)

Overview

PackageIndia statutory
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold India statutory › Upi on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

POST/api/india/upi/requestsRequests

Request body

The keys this action reads (* = required; "one of" lists the only values):

amount, engineCode, note, sourceModule, sourceResource, sourceRecordId, flow, payerVpa, sourceNo; flow one of intent|collect|qr|mandate

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/upi/requests" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount":"value","engineCode":"value","note":"value","sourceModule":"value","sourceResource":"value","sourceRecordId":"value"}'
POST/api/india/upi/callback/{txnRef}Callback

Path parameters

NameTypeDescription
txnRefstring (uuid)The record's txnRef, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

status*, rrn, amount, upiTxnId, payerVpa, payerName, responseCode, reason; status one of created|pending|success|failed|expired|cancelled|refunded|disputed

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/upi/callback/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"value","rrn":"value","amount":"value","upiTxnId":"value","payerVpa":"value","payerName":"value"}'
GET/api/india/upi/enginesEngines

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/india/upi/engines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/india/upi/transactions/{id}/apply-receiptTransactions apply receipt

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

receiptDate

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/upi/transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/apply-receipt" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"receiptDate":"value"}'
POST/api/india/upi/transactions/{id}/refundTransactions refund

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

amount, reason

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/upi/transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refund" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount":"value","reason":"value"}'
POST/api/india/upi/engines/{id}/secretEngines secret

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

secret

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/upi/engines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secret" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"secret":"value"}'
POST/api/india/upi/settlements/reconcileSettlements reconcile

Request body

The keys this action reads (* = required; "one of" lists the only values):

csv, fileName, settlementDate, bankStatementId; rows: [{ rrn, transactionRef, transaction_ref, reference, amount, valueDate, value_date, date, utr }]

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/upi/settlements/reconcile" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"csv":"value","fileName":"value","settlementDate":"value","bankStatementId;":"value","transactionRef":"value","transaction_ref":"value"}'

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold India statutory › Upi for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.