DIGIT-API's
  1. transactions-api-controller
DIGIT-API's
  • Using DIGIT-PLAYGROUND
  • User
    • Manage
      • Create User
      • Search All Users
      • Search Active Users
      • Create User Without OTP Validation
      • Update User Without OTP Validation
      • Get User
      • Update Profile
    • Authenticate
      • Logout
      • Reset Password
      • Login
  • Master Data V1
    • List
      POST
    • Search
      POST
  • Master Data V2
    • Create Schema
      • Create Schema
    • Search Schema
      • Seach Schema
    • Add Data
      • Create
    • Seach Data
      • Seach Data
    • Update data
      • Updata
  • Access-control
    • Action
      • Authorize User
      • Get the list of actions based on either roles or features.
      • Create a new action.
      • Update existing action(s).
      • getAllMDMSActions
      • Validate a particular action for a given tenant and roles of the tenant
    • Role
      • Get the list of roles based on role codes.
      • Create a new role.
      • Update existing role(s).
    • Role-Action
      • Create mapping for role and action(s).
  • Workflow-v2
    • WorkFlow
      • Create new workflow entry for a given application number(businessId).
      • Process search of the applicaition
      • Get the list of workflow applications defined in the system.
      • Get the count of applications satisfying the given criteria
      • Get the nearing sla count of workflow applications defined in the system.
      • Get the list of status count workflow applications defined in the system.
    • Escalate
      • Get the list of escalate workflow applications defined in the system.
      • Get the list of workflow applications defined in the system.
    • BusinessServiceV2
      • Create new v2 BuinessService.
      • Updates a existing v2 BuinessService.
      • Get the list of v2 BusinessServices defined in the system.
    • BusinessService
      • Create new BuinessService.
      • Updates a existing BuinessService.
      • Get the list of BusinessServices defined in the system.
  • Filestore
    • Upload File
      • Uploads different kinds of files to server.
    • Search
      • Search file url based on tenantid and filestoreid.
      • Search file url based on tenantid and tag name.
      • Get metadata of file based on tenantId and filestoreId.
      • Search file url based on tenantid and filestoreid.
  • Idgen
    • IdGeneration Controller
    • Create new id.
  • Location
    • Boundary
      • Search Location
      • It Will provide the List of boundaries based on search criteria Like "Srikakulam Municipality","Zone-1","Zone-2" etc.
    • Geography
      • Handles all requests related to Geographical boundaries by providing appropriate GeoJson and other associated data
    • Tenant
      • Resolves a given latitude / longitude to the corresponding tenant Id
  • Enc-Service
    • Crypto
      • Encrypts the given input value/s OR values of the object.
      • Decrypts the given input value/s OR values of the object.
      • Provide signature for a given value.
      • Check if the signature is correct for the provided value.
      • Deactivate the keys for the given tenant and generate new keys. It will deactivate both symmetric and asymmetric keys for the provided tenant.
      • cryptoRotateAllKeys
  • PG-Service
    • transactions-api-controller
      • transactionsV1AvailableGatewaysPost
        POST
      • transactionsV1CreatePost
        POST
      • transactionsV1SearchPost
        POST
      • transactionsV1UpdatePost
        POST
  • URL-Shortening
    • egov-url-shortening service endpoints
      • shorten given url
      • redirects user to orignal url identified by id
  • Indexer
    • egov-indexer service
      • This endpoint is used to start legacy index job to reindex records from DB. The data is fetched from DB by calling api mentioned in request in batches. The is useful when some record is present in DB but missing on index.
      • This endpoint is used to start indexing job to reindex records from one index to another index.
      • This endpoint is used to index one record on a index. The information to pick correct config is provided with the data to be indexed.
      • Index data in row
  • PDF-Service
    • PDF-Service endpoints
      • Generate PDF and store output pdfs to filestore and return their filestoreids. The information is also saved into DB so that using _search endpoint we can retrieve already generated pdfs.
      • Generates pdf without storing any information on filestore or in DB. The generated pdf would be returned as binary response
      • Get filestoreids and other information about already generated pdf by searching on jobid or entityid with other optional search parameters
  • Report
    • Report Meta
      • createv1
      • getReportDatav1
      • Metadata API for report definition
    • Report
      • Search API for report data
  • eGov-OTP
    • OTPConfig
      • create OTP Configuration entry
      • validate OTP Configuration entry
      • search OTP Configuration entry using uuid
  • User-OTP
    • user otp send
  • Localization
    • Create Message
      • create massage
    • Fetch Message
      • fetch message
    • Update message
      • update message
    • Delete message
      • delete mesage
    • Upsert message
      • upsert message
  • Service Request
    • Service Defination Create
      • Create service defination
    • Service Defination search
      • Search service defination
    • Service create
      • service create
    • Service Search
      • Service search
  • Audit Service
  1. transactions-api-controller

transactionsV1UpdatePost

POST
/pg-service/transaction/v1/_update
Last modified:2024-04-19 09:50:11

Request

Body Params application/json
Wrapper for Request Info
requestInfo
object 
optional
Example
{
    "requestInfo": {}
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://unified-dev.digit.org/pg-service/transaction/v1/_update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestInfo": {}
}'

Responses

🟢200OK
application/json
Body
The payment seatch response object, representing the status of the payment
responseInfo
object 
optional
Transaction
array[object (Transaction) {21}] 
optional
tenantId
string 
required
The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required
>= 2 characters<= 50 characters
txnAmount
string 
required
Transaction Amount, preferably rounded off to two decimal places
>= 1 characters
billId
string 
required
Unique bill ID associated with the transaction
>= 1 characters
module
string 
optional
Module business code for which the transaction is being initiated, ex PT, WS, PGR etc
>= 1 characters
consumerCode
string 
required
Unique identifier for consumer code
>= 1 characters<= 128 characters
taxAndPayments
array[object (TaxAndPayment) {3}] 
required
productInfo
string 
required
Brief description for which the transaction is being carried out.
>= 1 characters<= 512 characters
gateway
string 
required
Gateway to be used, from the available list, such as PAYTM, PHONEPE.
>= 2 characters
callbackUrl
string 
required
URL to which control has to be redirected to from the gateway
>= 2 characters
txnId
string 
read-onlyoptional
Transaction ID of the payment, generated by the gateway service
user
object 
required
redirectUrl
string 
read-onlyoptional
redirectUrl of the payment
txnStatus
enum<string> 
read-onlyoptional
Current status of the transaction
Allowed values:
SUCCESSFAILUREPENDING
txnStatusMsg
string 
read-onlyoptional
Brief status message for the transaction
gatewayTxnId
string 
read-onlyoptional
Transaction ID returned by the gateway, for reference
gatewayPaymentMode
string 
read-onlyoptional
Mode of payment used at the gateway
gatewayStatusCode
string 
read-onlyoptional
Payment Gateway Specific RAW status code
gatewayStatusMsg
string 
read-onlyoptional
Payment Gateway Specific RAW status message
receipt
string 
read-onlyoptional
Receipt ID generated for this payment
auditDetails
object 
optional
additionalDetails
object 
optional
Example
{
    "responseInfo": {},
    "Transaction": [
        {
            "tenantId": "string",
            "txnAmount": "string",
            "billId": "string",
            "module": "string",
            "consumerCode": "string",
            "taxAndPayments": [
                {
                    "billId": "string",
                    "taxAmount": 0,
                    "amountPaid": 0
                }
            ],
            "productInfo": "string",
            "gateway": "string",
            "callbackUrl": "string",
            "txnId": "string",
            "user": {},
            "redirectUrl": "string",
            "txnStatus": "SUCCESS",
            "txnStatusMsg": "string",
            "gatewayTxnId": "string",
            "gatewayPaymentMode": "string",
            "gatewayStatusCode": "string",
            "gatewayStatusMsg": "string",
            "receipt": "string",
            "auditDetails": {},
            "additionalDetails": {}
        }
    ]
}
🟠400Invalid input.
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Modified at 2024-04-19 09:50:11
Previous
transactionsV1SearchPost
Next
shorten given url
Built with