Rest API for Oracle Banking Cash Management

Fetches the payment transactions by given parameters

get

/service/v1/paymentSearch

This endpoint fetch the Payment transaction on the basis of given parameters.

Request

Supported Media Types

application/json
application/xml

Query Parameters

S: string

S
accOwner: string

accOwner
accountNumber: string

accountNumber
actionPerformed: string

actionPerformed
allocStatus: string

App Id
allocationRequired: string

allocationRequired
amountFrom: number

amountFrom
amountReferenceBasis: string

amountReferenceBasis
amountTo: number

amountTo
autoReconcile: string

autoReconcile
bankCode: string

bankCode
beneficiaryCode: string

beneficiaryCode
beneficiaryId: string

beneficiaryId
beneficiaryName: string

beneficiaryName
counterpartyCode: string

counterpartyCode
counterpartyId: string

counterpartyId
counterpartyName: string

counterpartyName
creditAccNo: string

creditAccNo
creditNoteRefNo: string

creditNoteRefNo
dateFrom: string

dateFrom
dateReferenceBasis: string

dateReferenceBasis
dateTo: string

dateTo
dcIndicator: string

dcIndicator
entityRefNo: string

entityRefNo
fileName: string

fileName
filler1: string

filler1
filler10: string

filler10
filler2: string

filler2
filler3: string

filler3
filler4: string

filler4
filler5: string

filler5
filler6: string

filler6
filler7: string

filler7
filler8: string

filler8
filler9: string

filler9
flag: string

flag
forInquiry: boolean

forInquiry
forRecon: boolean

forRecon
includeInternalPayments: boolean

includeInternalPayments
instrumentBank: string

instrumentBank
instrumentBranch: string

instrumentBranch
instrumentCleared: string

instrumentCleared
instrumentDate: string

instrumentDate
isIndirectPayment: string

isIndirectPayment
limit: integer

limit is maximum no of records to be fetched
mandateRefNo: string

mandateRefNo
matchedAmount: number

matchedAmount
offset: integer

offset is starting no of records to be fetched
partyPaymentCode: string

partyPaymentCode
paymentAction: string

paymentAction
paymentAmountFrom: number

paymentAmountFrom
paymentAmountTo: number

paymentAmountTo
paymentCcy: string

paymentCcy
paymentDateFrom: string

paymentDateFrom
paymentDateTo: string

paymentDateTo
paymentMode: string

paymentMode
paymentNumber: string

paymentNumber
paymentParty: string

paymentParty
paymentPartyName: string

paymentPartyName
paymentRefNo: string

paymentRefNo
paymentStatus: array[string]

Collection Format: multi

paymentStatus
paymentType: string

Payment Type
programCode: string

programCode
reconStatus: string

reconStatus
relationshipCode: string

relationshipCode
remarks: string

remarks
remitterAccNo: string

remitterAccNo
specificAppropriation: string

specificAppropriation
transactionReferenceNo: string

transactionReferenceNo
transactionStatus: string

transactionStatus
virtualAcFlag: string

virtualAcFlag

Header Parameters

appId(required): string

App Id
branchCode(required): string

branchCode
userId(required): string

userId

Response

Supported Media Types

application/json
application/xml

200 Response

Successful performs the operation

Root Schema : PaymentCollectionDto

Type: object

ScfPaymentDTO Collection

Show Source

action: string

Action
data: array data

ScfPaymentDTO
paging: object paging

paging
refundTxnModel: object RefundTxnModel

{
    "description":"ScfPaymentDTO Collection",
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"Action"
        },
        "data":{
            "description":"ScfPaymentDTO",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfPaymentDTO"
            }
        },
        "refundTxnModel":{
            "$ref":"#/definitions/RefundTxnModel"
        },
        "paging":{
            "description":"paging",
            "type":"object"
        }
    }
}

Nested Schema : data

Type: array

ScfPaymentDTO

Show Source

Array of: object ScfPaymentDTO

Payment details for Payments Model

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

Nested Schema : paging

Type: object

paging

Nested Schema : RefundTxnModel

Type: object

Show Source

amount: number

Excess Payment Reconciled/Refunded Amount
beneAccNo: string

Beneficiary Account Number
beneIfscCode: string

Beneficiary IFSC Code
beneName: string

Beneficiary Name
currency: string

Excess Payment Currency
status: string

Payment Status
txnRefNo: string

Reconciled Transaction Reference Number
utrRefNo: 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"
        }
    }
}

Nested Schema : ScfPaymentDTO

Type: object

Payment details for Payments Model

Show Source

accOwner: string

accOwner
addlText: string

Additional Text
allocatedAmt: number

allocatedAmt
allocationRequired: string

allocationRequired
allocStatus: string

allocStatus
autoReconcile: string

Auto Reconcile
bankChargeAmt: number

bankChargeAmt
bankCode: string

Bank Code
beneficiaryCode: string

Beneficiary Code
beneficiaryId: string

Beneficiary Id
beneficiaryName: string

Beneficiary Id
beneficiaryRole: string

beneficiaryRole
consAllocStatus: string

Consolidate alloc status
consPaymentStatus: string

Consolidate payment status
counterpartyCode: string

Counterparty Code
counterpartyId: string

Counterparty Id
counterpartyName: string

counterpartyName
counterpartyRole: string

counterpartyRole
creditAccNo: string

Credit Account Number
creditNoteRefNo: string

Credit Note Reference Number
dcIndicator: string

Dc Indicator
deducAmt: number

deducAmt
derivedFlag: string

derivedFlag
eftRefNo: string

Eft Reference Number
entityRefNo: string

Entity Reference Number
errorDesc: string

errorDesc
excessHandling: string

excessHandling
excessRefundParty: string

excessRefundParty
excessRefundPartyId: string

excessRefundPartyId
excessRefundPaymentMode: string

excessRefundPaymentMode
fileName: string

File Name
filler1: string

Filler 1
filler10: string

Filler 10
filler2: string

Filler 2
filler3: string

Filler 3
filler4: string

Filler 4
filler5: string

Filler 5
filler6: string

Filler 6
filler7: string

Filler 7
filler8: string

Filler 8
filler9: string

Filler 9
financeReferenceNo: string

financeReferenceNo
flag: string

Flag
genericAppropriation: string

Generic Appropriation
indicator: string

Indicator
instrumentBank: string

Instrument Bank
instrumentBranch: string

Instrument Branch
instrumentCleared: string

instrumentCleared
instrumentDate: string

Instrument Date
isAutoAuth: string

isAutoAuth
isIndirectPayment: string

isIndirectPayment
isPUA: string

isPUA
isRecon: string

isRecon
lastActionPerformed: string

Last Action Performed
mandateRefNo: string

Mandate Reference Number
matchedAmount: number

matchedAmount
outputStatus: string

Output status
parentPaymentNo: string

Parent Payment Number
parentPaymentRefNo: string

parentPaymentRefNo
partyPaymentCode: string

Party Payment Code
paymentAmount: number

Payment Amount
paymentBusinessDate: string

paymentBusinessDate
paymentCurrency: string

Payment Currency
paymentDate: string

Payment Date
paymentMode: string

Payment Mode
paymentNumber: string

Payment Number
paymentPartyCategory: string

paymentPartyCategory
paymentPartyId: string

Payment Party id
paymentPartyName: string
paymentPartyRole: string

paymentPartyRole
paymentProcessStatus: string

Payment Process Status
paymentRefNo: string

Payment Reference Number
paymentStatus: string

Payment Status
portalReference: string

Portal Reference
procBranchCode: string

procBranchCode
procBranchDate: string

procBranchDate
programCode: string

Program Code
reasonCode: string

Reason Code
reconciledPmtAmt: number

reconciledPmtAmt
reconTxnStatus: string

reconTxnStatus
refundAmount: number

refundAmount
relationshipCode: string

relationshipCode
remarks: string

Remarks
remitterAccNo: string

Remitter Account Number
seqNo: integer(int64)

seqNo
sourceTxnId: string

Recon Txn Number
specificAppropriation: string

Specific Appropriation
stageId: string

stageId
totalAllocatedAmt: number

totalAllocatedAmt
transactionRefNo: string

transactionRefNo
transactionStatus: string

transactionStatus
unallocatedAmt: number

unallocatedAmt
unmatchedAmount: number

unmatchedAmount
virtualAcFlag: string

virtualAcFlag

{
    "description":"Payment details for Payments Model",
    "type":"object",
    "properties":{
        "autoReconcile":{
            "type":"string",
            "description":"Auto Reconcile"
        },
        "bankCode":{
            "type":"string",
            "description":"Bank Code"
        },
        "beneficiaryCode":{
            "type":"string",
            "description":"Beneficiary Code"
        },
        "beneficiaryId":{
            "type":"string",
            "description":"Beneficiary Id"
        },
        "beneficiaryName":{
            "type":"string",
            "description":"Beneficiary Id"
        },
        "counterpartyId":{
            "type":"string",
            "description":"Counterparty Id"
        },
        "counterpartyName":{
            "type":"string",
            "description":"counterpartyName"
        },
        "counterpartyCode":{
            "type":"string",
            "description":"Counterparty Code"
        },
        "creditAccNo":{
            "type":"string",
            "description":"Credit Account Number"
        },
        "creditNoteRefNo":{
            "type":"string",
            "description":"Credit Note Reference Number"
        },
        "dcIndicator":{
            "type":"string",
            "description":"Dc Indicator"
        },
        "eftRefNo":{
            "type":"string",
            "description":"Eft Reference Number"
        },
        "entityRefNo":{
            "type":"string",
            "description":"Entity Reference Number"
        },
        "filler1":{
            "type":"string",
            "description":"Filler 1"
        },
        "filler2":{
            "type":"string",
            "description":"Filler 2"
        },
        "filler3":{
            "type":"string",
            "description":"Filler 3"
        },
        "filler4":{
            "type":"string",
            "description":"Filler 4"
        },
        "filler5":{
            "type":"string",
            "description":"Filler 5"
        },
        "filler6":{
            "type":"string",
            "description":"Filler 6"
        },
        "filler7":{
            "type":"string",
            "description":"Filler 7"
        },
        "filler8":{
            "type":"string",
            "description":"Filler 8"
        },
        "filler9":{
            "type":"string",
            "description":"Filler 9"
        },
        "filler10":{
            "type":"string",
            "description":"Filler 10"
        },
        "flag":{
            "type":"string",
            "description":"Flag"
        },
        "genericAppropriation":{
            "type":"string",
            "description":"Generic Appropriation"
        },
        "specificAppropriation":{
            "type":"string",
            "description":"Specific Appropriation"
        },
        "indicator":{
            "type":"string",
            "description":"Indicator"
        },
        "instrumentBank":{
            "type":"string",
            "description":"Instrument Bank"
        },
        "instrumentBranch":{
            "type":"string",
            "description":"Instrument Branch"
        },
        "instrumentDate":{
            "type":"string",
            "description":"Instrument Date"
        },
        "mandateRefNo":{
            "type":"string",
            "description":"Mandate Reference Number"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount"
        },
        "paymentCurrency":{
            "type":"string",
            "description":"Payment Currency"
        },
        "paymentDate":{
            "type":"string",
            "description":"Payment Date"
        },
        "paymentMode":{
            "type":"string",
            "description":"Payment Mode"
        },
        "paymentNumber":{
            "type":"string",
            "description":"Payment Number"
        },
        "partyPaymentCode":{
            "type":"string",
            "description":"Party Payment Code"
        },
        "paymentPartyId":{
            "type":"string",
            "description":"Payment Party id"
        },
        "paymentPartyName":{
            "type":"string"
        },
        "paymentProcessStatus":{
            "type":"string",
            "description":"Payment Process Status"
        },
        "paymentRefNo":{
            "type":"string",
            "description":"Payment Reference Number"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Payment Status"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "remitterAccNo":{
            "type":"string",
            "description":"Remitter Account Number"
        },
        "fileName":{
            "type":"string",
            "description":"File Name"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason Code"
        },
        "lastActionPerformed":{
            "type":"string",
            "description":"Last Action Performed"
        },
        "matchedAmount":{
            "type":"number",
            "description":"matchedAmount"
        },
        "unmatchedAmount":{
            "type":"number",
            "description":"unmatchedAmount"
        },
        "reconTxnStatus":{
            "type":"string",
            "description":"reconTxnStatus"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"isAutoAuth"
        },
        "virtualAcFlag":{
            "type":"string",
            "description":"virtualAcFlag"
        },
        "paymentBusinessDate":{
            "type":"string",
            "description":"paymentBusinessDate"
        },
        "counterpartyRole":{
            "type":"string",
            "description":"counterpartyRole"
        },
        "beneficiaryRole":{
            "type":"string",
            "description":"beneficiaryRole"
        },
        "paymentPartyRole":{
            "type":"string",
            "description":"paymentPartyRole"
        },
        "relationshipCode":{
            "type":"string",
            "description":"relationshipCode"
        },
        "errorDesc":{
            "type":"string",
            "description":"errorDesc"
        },
        "paymentPartyCategory":{
            "type":"string",
            "description":"paymentPartyCategory"
        },
        "derivedFlag":{
            "type":"string",
            "description":"derivedFlag"
        },
        "allocationRequired":{
            "type":"string",
            "description":"allocationRequired"
        },
        "allocStatus":{
            "type":"string",
            "description":"allocStatus"
        },
        "allocatedAmt":{
            "type":"number",
            "description":"allocatedAmt"
        },
        "unallocatedAmt":{
            "type":"number",
            "description":"unallocatedAmt"
        },
        "accOwner":{
            "type":"string",
            "description":"accOwner"
        },
        "procBranchCode":{
            "type":"string",
            "description":"procBranchCode"
        },
        "procBranchDate":{
            "type":"string",
            "description":"procBranchDate"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"transactionRefNo"
        },
        "transactionStatus":{
            "type":"string",
            "description":"transactionStatus"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "isPUA":{
            "type":"string",
            "description":"isPUA"
        },
        "isIndirectPayment":{
            "type":"string",
            "description":"isIndirectPayment"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"Recon Txn Number"
        },
        "reconciledPmtAmt":{
            "type":"number",
            "description":"reconciledPmtAmt"
        },
        "totalAllocatedAmt":{
            "type":"number",
            "description":"totalAllocatedAmt"
        },
        "isRecon":{
            "type":"string",
            "description":"isRecon"
        },
        "financeReferenceNo":{
            "type":"string",
            "description":"financeReferenceNo"
        },
        "excessHandling":{
            "type":"string",
            "description":"excessHandling"
        },
        "excessRefundParty":{
            "type":"string",
            "description":"excessRefundParty"
        },
        "excessRefundPartyId":{
            "type":"string",
            "description":"excessRefundPartyId"
        },
        "excessRefundPaymentMode":{
            "type":"string",
            "description":"excessRefundPaymentMode"
        },
        "parentPaymentRefNo":{
            "type":"string",
            "description":"parentPaymentRefNo"
        },
        "parentPaymentNo":{
            "type":"string",
            "description":"Parent Payment Number"
        },
        "refundAmount":{
            "type":"number",
            "description":"refundAmount"
        },
        "stageId":{
            "type":"string",
            "description":"stageId"
        },
        "instrumentCleared":{
            "type":"string",
            "description":"instrumentCleared"
        },
        "bankChargeAmt":{
            "type":"number",
            "description":"bankChargeAmt"
        },
        "deducAmt":{
            "type":"number",
            "description":"deducAmt"
        },
        "outputStatus":{
            "type":"string",
            "description":"Output status"
        },
        "consAllocStatus":{
            "type":"string",
            "description":"Consolidate alloc status"
        },
        "consPaymentStatus":{
            "type":"string",
            "description":"Consolidate payment status"
        },
        "addlText":{
            "type":"string",
            "description":"Additional Text"
        },
        "portalReference":{
            "type":"string",
            "description":"Portal Reference"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error