Fetch the payment transactions from main table on the basis of Payment Reference Number
get
/service/v1/getPaymentByPayRefNo
This endpoint fetches the payment transactions from main table on the basis of Payment Reference Number.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
paymentRefNo: string
paymentRefNo
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:
objectNested Schema : PaymentModel
Type:
objectPayment 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:
objectNested 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:
4Maximum Length:10 -
processRefNo:
string
-
sourceRefNo(optional):
string
-
taskCreationDate(optional):
string(date-time)
-
taskOutcome:
string
-
taskPrioirty(optional):
string
-
tenantId(optional):
string
Nested Schema : Error
Type:
objectError 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