Fetch the payment transactions
get
/service/v1/paymentSearch
This endpoint fetches the payment transactions on the basis of given parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
S(optional): string
S
-
accOwner(optional): string
accOwner
-
accountNumber(optional): string
accountNumber
-
actionPerformed(optional): string
actionPerformed
-
allocStatus(optional): string
App Id
-
allocationRequired(optional): string
allocationRequired
-
amountFrom(optional): number
amountFrom
-
amountReferenceBasis(optional): string
amountReferenceBasis
-
amountTo(optional): number
amountTo
-
autoReconcile(optional): string
autoReconcile
-
bankCode(optional): string
bankCode
-
beneficiaryCode(optional): string
beneficiaryCode
-
beneficiaryId(optional): string
beneficiaryId
-
beneficiaryName(optional): string
beneficiaryName
-
counterpartyCode(optional): string
counterpartyCode
-
counterpartyId(optional): string
counterpartyId
-
counterpartyName(optional): string
counterpartyName
-
creditAccNo(optional): string
creditAccNo
-
creditNoteRefNo(optional): string
creditNoteRefNo
-
dateFrom(optional): string
dateFrom
-
dateReferenceBasis(optional): string
dateReferenceBasis
-
dateTo(optional): string
dateTo
-
dcIndicator(optional): string
dcIndicator
-
entityRefNo(optional): string
entityRefNo
-
fileName(optional): string
fileName
-
filler1(optional): string
filler1
-
filler10(optional): string
filler10
-
filler2(optional): string
filler2
-
filler3(optional): string
filler3
-
filler4(optional): string
filler4
-
filler5(optional): string
filler5
-
filler6(optional): string
filler6
-
filler7(optional): string
filler7
-
filler8(optional): string
filler8
-
filler9(optional): string
filler9
-
flag(optional): string
flag
-
forInquiry(optional): boolean
forInquiry
-
forRecon(optional): boolean
forRecon
-
includeInternalPayments(optional): boolean
includeInternalPayments
-
instrumentBank(optional): string
instrumentBank
-
instrumentBranch(optional): string
instrumentBranch
-
instrumentDate(optional): string
instrumentDate
-
limit(optional): integer
limit is maximum no of records to be fetched
-
mandateRefNo(optional): string
mandateRefNo
-
matchedAmount(optional): number
matchedAmount
-
offset(optional): integer
offset is starting no of records to be fetched
-
partyPaymentCode(optional): string
partyPaymentCode
-
paymentAction(optional): string
paymentAction
-
paymentAmountFrom(optional): number
paymentAmountFrom
-
paymentAmountTo(optional): number
paymentAmountTo
-
paymentCcy(optional): string
paymentCcy
-
paymentDateFrom(optional): string
paymentDateFrom
-
paymentDateTo(optional): string
paymentDateTo
-
paymentMode(optional): string
paymentMode
-
paymentNumber(optional): string
paymentNumber
-
paymentParty(optional): string
paymentParty
-
paymentPartyName(optional): string
paymentPartyName
-
paymentRefNo(optional): string
paymentRefNo
-
paymentStatus(optional): array[string]
Collection Format:
multi
paymentStatus -
paymentType(optional): string
Payment Type
-
programCode(optional): string
programCode
-
reconStatus(optional): string
reconStatus
-
relationshipCode(optional): string
relationshipCode
-
remarks(optional): string
remarks
-
remitterAccNo(optional): string
remitterAccNo
-
specificAppropriation(optional): string
specificAppropriation
-
transactionReferenceNo(optional): string
transactionReferenceNo
-
transactionStatus(optional): string
transactionStatus
-
virtualAcFlag(optional): string
virtualAcFlag
Header Parameters
-
appId: string
App Id
-
branchCode: string
branchCode
-
userId: string
userId
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Nested Schema : data
Type:
Show Source
array
-
Array of:
object PaymentModel
Payment details for Payments Model
Nested Schema : paging
Type:
object
Nested Schema : PaymentModel
Type:
object
Payment details for Payments Model
Show Source
-
accOwner(optional):
string
-
action(optional):
string
-
allocatedAmt(optional):
number
-
allocationRequired(optional):
string
-
allocStatus(optional):
string
-
autoReconcile(optional):
string
Auto Reconcile
-
bankCode(optional):
string
Bank Code
-
beneficiaryCode(optional):
string
Beneficiary Code
-
beneficiaryId(optional):
string
Beneficiary Id
-
beneficiaryName(optional):
string
-
beneficiaryRole(optional):
string
-
counterpartyCode(optional):
string
Counterparty Code
-
counterpartyId(optional):
string
Counterparty Id
-
counterpartyName(optional):
string
-
counterpartyRole(optional):
string
-
creditAccNo(optional):
string
Credit Account Number
-
creditNoteRefNo(optional):
string
Credit Note Reference Number
-
dcIndicator(optional):
string
Dc Indicator
-
derivedFlag(optional):
string
-
eftRefNo(optional):
string
Eft Reference Number
-
entityRefNo(optional):
string
Entity Reference Number
-
errorDesc(optional):
string
-
excessHandling(optional):
string
-
excessRefundParty(optional):
string
-
excessRefundPartyId(optional):
string
-
excessRefundPaymentMode(optional):
string
-
fileName(optional):
string
File Name
-
filler1(optional):
string
Filler 1
-
filler10(optional):
string
Filler 10
-
filler2(optional):
string
Filler 2
-
filler3(optional):
string
Filler 3
-
filler4(optional):
string
Filler 4
-
filler5(optional):
string
Filler 5
-
filler6(optional):
string
Filler 6
-
filler7(optional):
string
Filler 7
-
filler8(optional):
string
Filler 8
-
filler9(optional):
string
Filler 9
-
financeReferenceNo(optional):
string
-
flag(optional):
string
Flag
-
genericAppropriation(optional):
string
Generic Appropriation
-
indicator(optional):
string
Indicator
-
instrumentBank(optional):
string
Instrument Bank
-
instrumentBranch(optional):
string
Instrument Branch
-
instrumentDate(optional):
string
Instrument Date
-
isAutoAuth(optional):
string
-
isIndirectPayment(optional):
string
-
isPUA(optional):
string
-
isRecon(optional):
string
-
lastActionPerformed(optional):
string
Last Action Performed
-
mandateRefNo(optional):
string
Mandate Reference Number
-
matchedAmount(optional):
number
-
parentPaymentRefNo(optional):
string
-
partyPaymentCode(optional):
string
Party Payment Code
-
paymentAmount(optional):
number
Payment Amount
-
paymentBusinessDate(optional):
string
-
paymentCurrency(optional):
string
Payment Currency
-
paymentDate(optional):
string
Payment Date
-
paymentMode(optional):
string
Payment Mode
-
paymentNumber(optional):
string
Payment Number
-
paymentPartyCategory(optional):
string
-
paymentPartyId(optional):
string
Payment Party id
-
paymentPartyName(optional):
string
-
paymentPartyRole(optional):
string
-
paymentProcessStatus(optional):
string
Payment Process Status
-
paymentRefNo(optional):
string
Payment Reference Number
-
paymentStatus(optional):
string
Payment Status
-
procBranchCode(optional):
string
-
procBranchDate(optional):
string
-
programCode(optional):
string
Program Code
-
reasonCode(optional):
string
Reason Code
-
reconciledPmtAmt(optional):
number
-
reconTxnStatus(optional):
string
-
refundAmount(optional):
number
-
relationshipCode(optional):
string
-
remarks(optional):
string
Remarks
-
remitterAccNo(optional):
string
Remitter Account Number
-
seqNo(optional):
integer(int64)
-
sourceTxnId(optional):
string
Recon Txn Number
-
specificAppropriation(optional):
string
Specific Appropriation
-
stageId(optional):
string
-
totalAllocatedAmt(optional):
number
-
transactionRefNo(optional):
string
-
transactionStatus(optional):
string
-
unallocatedAmt(optional):
number
-
unmatchedAmount(optional):
number
-
virtualAcFlag(optional):
string
Match All
Show Source
-
object
transaction
Title:
transaction
-
object
PaymentModel-allOf[1]
Nested Schema : PaymentModel-allOf[1]
Type:
object
Nested Schema : TxnIdentification
Type:
Show Source
object
-
appId(optional):
string
-
appKey(optional):
string
-
branchCode:
string
-
currentStage:
string
-
currentUser:
string
-
externalSource(optional):
string
-
instanceId(optional):
string
-
key1:
string
-
key2(optional):
string
-
key3(optional):
string
-
key4(optional):
string
-
key5(optional):
string
-
moduleCode(optional):
string
-
outcome(optional):
string
-
processName:
string
Minimum Length:
4
Maximum Length:10
-
processRefNo:
string
-
sourceRefNo(optional):
string
-
taskCreationDate(optional):
string(date-time)
-
taskOutcome:
string
-
taskPrioirty(optional):
string
-
tenantId(optional):
string
Nested Schema : Error
Type:
object
Error Model
Show Source
-
ecode(optional):
string
Error Code
-
edesc(optional):
string
Error Description
-
etype(optional):
string
Error Type
Nested Schema : ModuleData
Type:
Show Source
object
-
accEntriesPostingReqd(optional):
string
-
alertsAndNotificationReqd(optional):
string
-
amount(optional):
number
-
anchorId(optional):
string
-
branch(optional):
string
-
branchCode(optional):
string
-
buyer(optional):
string
-
currency(optional):
string
-
currentStage(optional):
string
-
debtorId(optional):
string
-
financeRefNo(optional):
string
-
financeRefNoSeqNo(optional):
string
-
financeSeqNo(optional):
integer(int64)
-
instrumentUpdateReqd(optional):
string
-
isAuthReqd(optional):
string
-
isAutoFinanced(optional):
string
-
limitBlockReqd(optional):
string
-
limitPostAuthUpdateReqd(optional):
string
-
obclTxnUpdateReqd(optional):
string
-
operationCode(optional):
string
-
previousStage(optional):
string
-
priority(optional):
string
-
processName(optional):
string
-
productCode(optional):
string
-
programCode(optional):
string
-
sourceChannel(optional):
string
-
spokeId(optional):
string
-
stage(optional):
string
-
supplier(optional):
string
-
taskId(optional):
string
-
taskName(optional):
string
-
txnAmount(optional):
number
-
txnCurrency(optional):
string
-
updateFinanceMasterReqd(optional):
string
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error