Save payment data received through events
post
/service/v1/savePaymentData
This endpoint is used to save payment data received through events.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
Application id
-
branchCode: string
Branch Code
-
userId: string
user id
Payment DTO
Root Schema : PaymentDto
Type:
object
Payment DTO
Show Source
-
accOwner(optional):
string
Account Owner
-
allocatedAmt(optional):
number
Allocated Payment Amount
-
allocationRequired(optional):
string
Allocation Required
-
allocStatus(optional):
string
Allocation Status
-
autoReconcile(optional):
string
Auto Reconcile
-
bankCode(optional):
string
Bank Code
-
beneficiaryCode(optional):
string
Beneficiary Code
-
beneficiaryId(optional):
string
Beneficiary Id
-
beneficiaryName(optional):
string
Beneficiary Name
-
beneficiaryRole(optional):
string
Beneficiary Role
-
counterpartyCode(optional):
string
Counterparty Code
-
counterpartyId(optional):
string
Counterparty Id
-
counterpartyName(optional):
string
Counterparty Name
-
counterpartyRole(optional):
string
Counterparty Role
-
creditAccNo(optional):
string
Credit Account Number
-
creditNoteRefNo(optional):
string
Credit Note Reference Number
-
dcIndicator(optional):
string
Dc Indicator
-
derivedFlag(optional):
string
Derived Flag
-
eftRefNo(optional):
string
Eft Reference Number
-
entityRefNo(optional):
string
Entity Reference Number
-
errorDesc(optional):
string
Error Description
-
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
Matched Amount
-
parentPaymentRefNo(optional):
string
-
partyPaymentCode(optional):
string
Party Payment Code
-
paymentAmount(optional):
number
Payment Amount
-
paymentBusinessDate(optional):
string
Payment Business Date
-
paymentCurrency(optional):
string
Payment Currency
-
paymentDate(optional):
string
Payment Date
-
paymentMode(optional):
string
Payment Mode
-
paymentNumber(optional):
string
Payment Number
-
paymentPartyCategory(optional):
string
Payment Party Category
-
paymentPartyId(optional):
string
Payment Party Id
-
paymentPartyName(optional):
string
Payment Party Name
-
paymentPartyRole(optional):
string
Payment Party Role
-
paymentProcessStatus(optional):
string
Payment Process Status
-
paymentRefNo(optional):
string
Payment Reference Number
-
paymentStatus(optional):
string
Payment Status
-
procBranchCode(optional):
string
Proc Branch Code
-
procBranchDate(optional):
string
Proc Branch Date
-
programCode(optional):
string
Program Code
-
reasonCode(optional):
string
Reason Code
-
reconciledPmtAmt(optional):
number
-
reconTxnStatus(optional):
string
Recon Transaction Status
-
refundAmount(optional):
number
-
relationshipCode(optional):
string
Relationship Code
-
remarks(optional):
string
Remarks
-
remitterAccNo(optional):
string
Remitter Account Number
-
seqNo(optional):
integer(int64)
Sequence Number
-
sourceTxnId(optional):
string
Recon Txn Number
-
specificAppropriation(optional):
string
Specific Appropriation
-
totalAllocatedAmt(optional):
number
-
transactionRefNo(optional):
string
Transaction Reference Number
-
transactionStatus(optional):
string
-
unallocatedAmt(optional):
number
Unallocated Payment Amount
-
unmatchedAmount(optional):
number
Unmatched Amount
-
virtualAcFlag(optional):
string
Virtual Account Flag
Response
Supported Media Types
- application/json
- application/xml
201 Response
Successfully received payment details
Root Schema : schema
Type:
boolean
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error