Creates the payment transactions
post
/service/v1/payments
This endpoint create the Payment transactions.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
App Id
-
branchCode(required): string
branchCode
-
userId(required): string
user id for SMS
Request Body that contains data required for creating a new Payment.
Root Schema : schema
Type:
Show Source
array-
Array of:
object ScfPaymentDTO
Payment details for Payments Model
Nested Schema : ScfPaymentDTO
Type:
objectPayment 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
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns the the newly created payment.
Root Schema : CreatePaymentsResponseCollection
Type:
objectList of Create Payment Service Response
Show Source
-
paymentList:
array paymentList
paymentList
Nested Schema : CreatePaymentsResponse
Type:
Show Source
object-
errorDesc:
string
errorDesc
-
paymentNumber:
string
paymentNumber
-
paymentRefNo:
string
paymentRefNo
400 Response
Bad Request
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error