Rimit : Developer Doc
  • GETTING STARTED
    • Introduction
    • Common Codes
    • Development Kit
  • APIs
    • Definitions
    • Account
      • Account Fetch
      • Add Account
      • Account Statement
    • Debit
      • Debit/Withdraw Amount
      • Confirm Debit
    • Credit
      • Credit/Deposit Amount
      • Confirm Credit
    • Status
      • Status Check
Powered by GitBook
On this page
  • Request
  • Parameters
  • Request format
  • Response
  • Parameters
  • Response format
  1. APIs
  2. Status

Status Check

PreviousStatus

Last updated 1 year ago

This API is used to retrieve the latest status of the transaction.

MANDATORY

Method: POST

API URL: /transaction/statusCheck

Request

Parameters

Parameter
Type
Description

auth

Object

API_ID

String

Unique ID generated from the dashboard. Eg: 1a21as51a351f1155f

API_KEY

String

Unique KEY generated from the dashboard. Eg: AAD5451FS654SD6F5SD46F3S1D5S

data

Object

txn_number

String

txn_urn

String

Eg: LJOTHD1668143656985ZBSVPV

txn_reference

String

Unique transaction reference ID generated by the entity for debitConfirm/ creditConfirm. Eg: 123456789ghhg08nxv

txn_amount

String

Transaction amount. Eg: 1200.99

txn_type

String

Eg: DEBIT

txn_nature

String

Eg: INTERPE

Request format

{
    "head": {
        "api": "statusCheck",
        "apiVersion": "V1",
        "timeStamp": "2023-01-13 11:31:10 AM",
        "auth": {
            "API_ID": "6360b30096066b82e9697996",
            "API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
        }
    },
    "encrypted_data": {
        "cipher_text": "UwPs6LVTqba06TCHxdGljYOfDvQ6qwnO1kcyYPxC7JwAXG6XO3Hj4irME3uwzuguVAwLHmRVhgBj4/4o6ODVUxJo2zRgF8k8erCaF1y5BpYWLtLgn024vm+Mi3z2QLhuXoD99SjVxcg658EtMM8a8+mPT/vUa9O4cKlI0vUM8MB1/xhC6M2izTh9f7slh+nSQjmUpJWwBXF0UCYIGNKR9RJdc0626ILADXz542w9V2h5L1pJL5wEpssktAzXZaqY47uylMYUZ9UYersTfAw96zk2x2YPopwghQwrr7bvJvY=",
        "iv": "51a193a5e6a4ea1c",
        "hash": "bc028ea5947ea5fb4ef7cf1e0100399b87a284baff518f69de2dbff39d59dd85"
    }
}
{
    "head": {
        "api": "statusCheck",
        "apiVersion": "V1",
        "timeStamp": "2023-01-13 11:31:10 AM",
        "auth": {
            "API_ID": "6360b30096066b82e9697996",
            "API_KEY": "b54996b0-59a8-11ed-911b-87fca52fd2dc"
        }
    },
    "content": {
        "result": {},
        "data": {
            "txn_number": "01167358944567292159569",
            "txn_urn": "RJGPQS1673589445706XHTXWE",
            "txn_reference": "CIMI3924646928709",
            "txn_amount": "200",
            "txn_type": "DEBIT",
            "txn_nature": "INTERPE"
        }
    }
}

Response

Parameters

Parameter
Type
Description

head

Object

HTTP_CODE

Integer

result

Object

code

Integer

Result code for the response. Find result codes

status

String

The status against the request. Allowed values: SUCCESS, FAILED, HOLD

transaction

Object

txn_number

String

txn_status

String

txn_nature

String

Eg: INTERPE

txn_mode

String

Eg: UPI

txn_note

String

The user added note for reference. Eg: gggggggg

txn_amount

String

Transaction amount. Eg: 1200.99

txn_charge

String

The amount charged by the bank/service provider for facilitating the transaction. Default value: 0 (Zero). Eg: 18

txn_fee

String

Fees charged by Rimit to Customer for any Services. Default value: 0 (Zero). Eg: 25

transaction_data

Array of Objects

result_code

String

Status code of transaction confirmation.

result_status

String

Status of transaction confirmation.

result_message

String

Status message of transaction confirmation.

txn_number

String

txn_urn

String

Eg: LJOTHD1668143656985ZBSVPV

txn_type

String

Eg: CREDIT

txn_reference

String

A unique transaction reference id created by the entity. Eg: 123456789ghhg08nxv

txn_date

String

Transaction date Format: YYYY-MM-DD Eg: 2020-11-20

txn_time

String

The time of transaction.

Format: hh:mm A Eg: 07:47 PM

txn_ts

String

The timestamp of the transaction. Eg: 1667367750

txn_attempt_status

String

txn_attempt_count

String

The number of attempts to send the request to the entity's server. Eg: 2

txn_attempt_completed_ts

String

Timestamp of the request received for Debit / Credit Confirm. Eg: 1667367750

txn_pay_name

String

Name of Party; Payee, or Beneficiary. Eg: Sreejith

txn_pay_ref

String

Payment reference of the Party; Account Number/ User Virtual Address etc. Eg: sreejith

account_number

String

Account number of the user's respective entity. Eg: 0386780199100

account_branch

String

Code of the branch to which the account number belongs. Eg: BR001

account_branch_name

String

Name of the branch to which the account number belongs. Eg: KANNUR

sp_txn_status

String

sp_txn_reference

String

Transaction reference received from SP. Eg: DHMA8307441998434

sp_txn_date

String

Date of transaction made by the SP. Eg: 2023-01-05

sp_txn_note

String

Transaction note issued by SP. Eg: Test NEFT Txn.

sa_txn_type

String

Eg: DEBIT

sa_txn_amount

String

Transaction amount. Eg: 1200.99

sa_txn_charge

String

The amount charged by the bank/service provider for facilitating the transaction. Default value: 0 (Zero). Eg: 18

sa_txn_fee

String

Fees charged by Rimit to Customer for any Services. Default value: 0 (Zero). Eg: 25

sa_service_charge

String

Any additional service fees imposed on entities for SA services. Eg: 0

sa_opening

String

Opening balance in the SA. Eg: 197512.67

sa_debit

String

The amount debited (txn_amount) for the transaction. Eg: 665

sa_credit

String

The amount credited (txn_amount) for the transaction. Eg: 0

sa_balance

String

The final settlement account balance. Eg: 196847.67

INFO

Service provider information may be blank in transaction details. These values are used for reference only and are offered by service providers.

Response format

{
    "head": {
        "api": "statusCheck",
        "apiVersion": "V1",
        "timeStamp": "2023-01-13 11:52:59 AM",
        "HTTP_CODE": 200
    },
    "encrypted_data": {
        "cipher_text": "8X4ER2qgoEtvqONfS7T6XiDP64iUMm0xFVeBTF0KcbIGMP5aopu4Ob1F47hnJfBds33rcyeGSaYUSyc9h1YyB7w87qkTUnqaLFpe/rekLC+TyFZgvZRgW9L4R9fPvRhIra8dYgdLlITFB+jhpXFrXXOsVcelZ3R2I8CYydbSUZMdynemaa7GJXZLwJVVWfsGoGpc60rYIAed50++aR28vjfOEoMaOpWwWcRz2VYT56s7ujS5vlxWjfnhYpP/s3i597f8wTSbG0SGeOosvNvFuopUdGw3G+H/7oIXISc86Fn/1XUBrHu2l6t3IlZE30ybesbaqgkWP4d8LzQzmK4KCla5+ucewL5zTshRI5n/pzH427/bqJIjONan1nt2tAmp1RCXI5m4w90H1/N0OcObXmAwTnSGUaB4Vu/prkDR01mjILz/T7dfG5YOPwWQ9SQxcG/cIY1qqoTQIn4Cc3t70c72rsG67qCsgA1Gl2VSZfG1OsIwhlopERSKB6VgfTMjT7zj5RojMkLLrF70fthvEeiyzEkKKG+62OeEbblXiF/0YE69T+QdVeU6pT4TInISo5AqhPZxgdsZcj8U0qcC8MlwkF/2cLsgHC2Pu2zZoSLlF+DruDXeF1N2fO5X3OWONtJzBgLjV8vbiGcZrIa+F9niyqu0IjSzAN0md5FYvkuAzMPd7JMNVoR4lvhLK37wxDyHovPSWnw9CXfRohdvMI07jboXPUffQD9mNczR7EUWRkYkhs0pxnqZOuAFj71lpPSGlhV0oobXZrcIodE+en+lA8eRKqeFxefEp2/dM8PX7mQTPFhqaC5u66Wf2gX9Y/hPzjgCdwPbgp1vWoN4xtqicodpTW6dlG2woCgCWVy6KrltjxBsZbpe0RHrUKxPmGgb+W6e5t3BPo95d1i1b/5yWfp7jbjfGEwNGkwZ7xnJCT2vPYcBdsgR50jSle3XlDE1CZ8FmDFVrYNl7zofmlTG6j1SuyWNcNVEYbhCrnF5T9//T62grYDjjONddbf9BD2I9e0kqRSM1g7mdteG2xb68UiE/WIq9k2/uoogZV6Q+2Wk5TELzovZjOxG3Y9FiP0pYGh3L9nM0b5guMg8yha1snq1HNr9CTR4a2HQsWFIGVlk7rcuF5t/GLtlrn8E4Zq/lT1wTJuEw/2/WWW1GYECuKqJ3NzXNZf47AKJAzmc+2jWqAgyx0fxh6jt/8fbKwFBgJu5diVylCT002cpM4d9/koVc66SHiJLyH8YBMRZf7xlm4aDSrDwpfhYCSJ/UIM4dFj4FYRfxd0ehIPtHxVleAHw8yg4cw7963z3PwjmJ6tIBco4E4PKG45Pb7iUvZ0lf9Xn6EAxY3cRHT6BWYzBDyJFUV7r99AVqi2fFIgkL6b2lzMNL6w8uCVS6pUQXy2rcgS52bmDAHbjSG06vCw32L1u+VFR3z/MxFK46nUTxZH0oGl1QSJHyjIMiZA5xTNzPSloHslCkLfdGju9Kh+lxrHVNh6szllXHTzV+BjykuGifJdRHzwQFgyGqiguafuH2qZo5CaveER6mr/lKsmdiqsxZ4NCuVGmthWah7VGEZms6fAcbQwab8YXFF1ySq65NOZ6/wHR0vaF8HPajJGvfccKo+JXw9GndiLai/mNzzyC1hF6S9NRtc24srFxr7YB7KClJDGsvpmI1P0VA+9/dmcBfsyRu0SzM38ScSyl9bR0y5rMMf+OTwkcm+Be3G1ba2MqWlkB/W52Wd4cHGKZJsDvqphTOybZZQmm/RS6gALGbAgQSBeMwNZFsjvwgmTvjn8s+ZTKZV1TRYmVkFT7SsV7UkWSaBYO5qfK72NyCr+7gLrQz0AAgySMpiLoZxb3xQx27frfX+jOfIhMMgPRIM7TEzhCS8aAuZineWfiRscEn787knoPpMsxsuaCzp62Tl27wS0D0wmCkSxA/0KXZLqV6pNIQvvqg81kTvDM8CS0vuwz85E16FDxoPfOMJ23zNeVPzk2fAazUIZVeIvOHNVvJ3Bp1Q79ekiYVzp2BUsW/fDyWAAqKMFrSUrI3RIQRuUrSAmBDIf0WFXMwjyHV6Mo6VZXm9flJbA+Subb4KV0rFxcEP6tILIaU37cmg3X+P12JjGGrpzXrzX/l44Spf0JmaEV8r0PGSF0Jcv6FZr3P6p2O5JJ98zw0dRNT/CAdpj7+Qz9FZZcAl4u+NyqLs3X6DrGxkCEPDtyfcIPoqWoNH3m+BdZnYvonEPNBbl02XMX4tXTABvR/qUcv7keudrTt8L5gvUyvfryNHlAHb5l/G5fdyXhyx96TgqDB9wGuNQJdNWCVSTG4OGGupO/LONx3L+r46fcXZdSfVEOFXeVauPHGm80QKSuak1J469LMP4RworJox45q6e4+tC7I4Y2ICEFWJDN7des1Wl1ABgV1gAUgOPdTxscOXEcl7ylSB9fpiPilUX2P8OhYmDR2lwLmrZTIqs/qrd6BE3Apc4VcfseJki//sbMxa8nyt4OBN+gyVQ7Ikw3P7/3G6383hO/rpVBFo6dgDLFOsHsZEL78kF2clQisgc0dwxGv/ICYilaMJ4XC27SrgdKkuIywGHhAmPZores9hohZnynP1pTOE9OtoxwHchfqWIt3SdC3CuSxhGf+gh8T2iehSvEuSeL3xflo1Zc4LLqfp4=",
        "iv": "42a55f9f75a7b948",
        "hash": "34a8242b8c11a808f91a1ba892003db5f2a6f15d9818569503e3055d7385324f"
    }
}
{
    "head": {
        "api": "statusCheck",
        "apiVersion": "V1",
        "timeStamp": "2023-01-13 11:52:59 AM",
        "HTTP_CODE": 200
    },
    "content": {
        "result": {
            "code": 1001,
            "status": "SUCCESS",
            "message": "Latest transaction status found"
        },
        "data": {
            "transaction": {
                "txn_number": "01167358944567292159569",
                "txn_status": "REFUND",
                "txn_nature": "INTERPE",
                "txn_mode": "P2P",
                "txn_note": "testing-2",
                "txn_amount": "200",
                "txn_charge": "3",
                "txn_fee": "25"
            },
            "transaction_data": [
                {
                    "txn_result_code": "1001",
                    "txn_result_status": "SUCCESS",
                    "txn_result_message": "The request is successfully processed",
                    "txn_number": "01167358944567292159569",
                    "txn_urn": "RJGPQS1673589445706XHTXWE",
                    "txn_type": "DEBIT",
                    "txn_reference": "CKVO3617910528841",
                    "txn_date": "2023-01-13",
                    "txn_time": "11:27:25 AM",
                    "txn_ts": "1673589445",
                    "txn_attempt_status": "SUCCESS",
                    "txn_attempt_count": "1",
                    "txn_attempt_completed_ts": "1673589445",
                    "txn_pay_name": "SREEJITH",
                    "txn_pay_ref": "sreejith",
                    "account_number": "PBCI0386780199100",
                    "account_branch": "BR001",
                    "account_branch_name": "KANNUR",
                    "sp_txn_status": "UNDEFINED",
                    "sp_txn_reference": "",
                    "sp_txn_date": "",
                    "sp_txn_note": "",
                    "sa_txn_type": "DEBIT",
                    "sa_txn_amount": "200",
                    "sa_txn_charge": "3",
                    "sa_txn_fee": "25",
                    "sa_service_charge": "0",
                    "sa_opening": "197040.67",
                    "sa_debit": "228",
                    "sa_credit": "0",
                    "sa_balance": "196812.67"
                },
                {
                    "txn_result_code": "1001",
                    "txn_result_status": "SUCCESS",
                    "txn_result_message": "The request is successfully processed",
                    "txn_number": "01167358944567292159569",
                    "txn_urn": "SQMVRN1673589525308CICNHC",
                    "txn_type": "RF_CREDIT",
                    "txn_reference": "HEHK9052241012590",
                    "txn_date": "2023-01-13",
                    "txn_time": "11:28:45 AM",
                    "txn_ts": "1673589525",
                    "txn_attempt_status": "SUCCESS",
                    "txn_attempt_count": "1",
                    "txn_attempt_completed_ts": "1673589525",
                    "txn_pay_name": "SREEJITH",
                    "txn_pay_ref": "sreejith",
                    "account_number": "PBCI0386780199100",
                    "account_branch": "BR001",
                    "account_branch_name": "KANNUR",
                    "sp_txn_status": "UNDEFINED",
                    "sp_txn_reference": "",
                    "sp_txn_date": "",
                    "sp_txn_note": "",
                    "sa_txn_type": "RF_CREDIT",
                    "sa_txn_amount": "200",
                    "sa_txn_charge": "3",
                    "sa_txn_fee": "25",
                    "sa_service_charge": "0",
                    "sa_opening": "196584.67",
                    "sa_debit": "0",
                    "sa_credit": "228",
                    "sa_balance": "196812.67"
                }
            ]
        }
    }
}
{
    "head": {
        "api": "statusCheck",
        "apiVersion": "V1",
        "timeStamp": "2023-01-05 09:09:45 AM",
        "HTTP_CODE": 406
    },
    "content": {
        "result": {
            "code": 2091,
            "status": "ERROR",
            "message": "We found a mismatch in the details you provided"
        },
        "data": {}
    }
}

The Unique Transaction Number. Eg: 02166814365694072422429

The Unique Transaction Reference Id.

The type of transaction.

The nature of the transaction.

HTTP response status codes.

The Unique Transaction Number. Eg: 02166814365694072422429

Status of transaction. Eg: PROCESSING

The nature of the transaction.

The mode of the transaction.

The Unique Transaction Number. Eg: 02166814365694072422429

A Unique Transaction Reference Id.

The type of transaction.

Status of Debit Confirm/ Credit Confirm. Eg: SUCCESS

This is the transaction status received from the Service Provider (SP). SP can be a bank or any vendor providing utility services. Eg: PROCESSING

Type of Settlement Account (SA) transaction.

BASE_URL
Refer
Refer
Find transaction types
Find transaction nature
Refer
Refer
Find transaction nature
Refer
Refer
Refer
Find transaction types
Refer
Refer
Find transaction types
Refer