Jump to

• Request
• Response

Fetch the Excess Payment transaction details

get

/service/v1/excessPaymentInq

This endpoint is used to fetch the Excess Payment transaction details basis of Payment Reference Number.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• paymentRefNo: string

Header Parameters

• appId: string
• branchCode: string
• userId: string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ExcessPaymentInqResponseModel

Type: object

Show Source

• currency(optional): string
  Excess Payment Currency
• excessPaymentAmt(optional): number
  Excess Payment Amount
• excessPaymentRefNo(optional): string
  Excess Payment Reference Number
• paymentRefNo(optional): string
  Payment Reference No
• reconciledTxnDet(optional): array reconciledTxnDet
• valueDate(optional): string
  Value Date

{
    "type":"object",
    "properties":{
        "paymentRefNo":{
            "type":"string",
            "description":"Payment Reference No"
        },
        "excessPaymentRefNo":{
            "type":"string",
            "description":"Excess Payment Reference Number"
        },
        "excessPaymentAmt":{
            "type":"number",
            "description":"Excess Payment Amount"
        },
        "valueDate":{
            "type":"string",
            "description":"Value Date"
        },
        "currency":{
            "type":"string",
            "description":"Excess Payment Currency"
        },
        "reconciledTxnDet":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconciledTxnModel"
            }
        }
    }
}

Nested Schema : reconciledTxnDet

Type: array

Show Source

• Array of: object ReconciledTxnModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReconciledTxnModel"
    }
}

Nested Schema : ReconciledTxnModel

Type: object

Show Source

• amount(optional): number
  Excess Payment Reconciled/Refunded Amount
• beneAccNo(optional): string
  Beneficiary Account Number
• beneIfscCode(optional): string
  Beneficiary IFSC Code
• beneName(optional): string
  Beneficiary Name
• currency(optional): string
  Excess Payment Currency
• status(optional): string
  Payment Status
• txnRefNo(optional): string
  Reconciled Transaction Reference Number
• utrRefNo(optional): string
  UTR Reference Number

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Payment Status"
        },
        "txnRefNo":{
            "type":"string",
            "description":"Reconciled Transaction Reference Number"
        },
        "amount":{
            "type":"number",
            "description":"Excess Payment Reconciled/Refunded Amount"
        },
        "currency":{
            "type":"string",
            "description":"Excess Payment Currency"
        },
        "beneName":{
            "type":"string",
            "description":"Beneficiary Name"
        },
        "beneAccNo":{
            "type":"string",
            "description":"Beneficiary Account Number"
        },
        "beneIfscCode":{
            "type":"string",
            "description":"Beneficiary IFSC Code"
        },
        "utrRefNo":{
            "type":"string",
            "description":"UTR Reference Number"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top