6.6 Consumer Services - Oracle Banking Payments
This topic describes about the consumer services required for Oracle Banking Payments Implementation.
The below endpoints must be configured under Consumer Services in Oracle Banking Routing Hub:
- CreatePMSinglePayOut
- CreateExternalConsumerLoan
- SwiftMessageAdopt
CreatePMSinglePayOut
This API enables the user to get the incoming payment details which is used for Invoice Payment Reconciliation during Auto and Manual reconciliation. This API is called from finance service and instruments.
SERVICE-CONSUMER = “OBSCFCM_OBPM”
SERVICE-CONSUMER-SERVICE= “CreatePMSinglePayOut”
Request:
{
"serviceConsumerServiceName" : "CreatePMSinglePayOut",
"body" : {
"externalBankName" : "BANK123123",
"obpmBranchCode" : "240",
"seqNo" : 2,
"programCode" : "RFPRG",
"processingDate" : "2022-11-02",
"drAcType" : 10,
"mmbId" : "IFSC123123",
"branchCode" : "004",
"sourceCode" : "EXTSYS",
"externalBranchName" : "BRANCH123123",
"financeRefNo" : "004160324PAY20961",
"userRef" : "2022-11-0217876",
"beneName" : "RFPDBUYER",
"accPartyId" : "202295",
"networkCode" : "NEFT",
"ccyOfTrf" : "USD",
"externalAccount" : "123123",
"hostCode" : "INDIA",
"drAcNo" : "988623101",
"sourceRef" : "2022-11-0217876",
"remittanceInfo" : "004160324PAY20961",
"accountingTransaction" : {
"1" : {
"seqNo" : 1,
"accountingEntryCode" : "EXREFUND_RFND_API",
"errorCode" : null,
"accRoleCode" : "CR-RFPD",
"externalBranchName" : null,
"financeRefNo" : null,
"exchangeRate" : 1,
"accountNo" : "US18979797854",
"accPartyType" : "BENEFICIARY",
"id" : "1218566755892604928",
"accType" : "C",
"accEntryDesc" : "EXREFUND_RFND_API",
"amountType" : "EXCESS_REFUND_AMOUNT",
"externalBankName" : null,
"amount" : 200,
"errorDesc" : null,
"eventSrNo" : 1,
"paymentMode" : null,
"drCrIndicator" : "D",
"ecaRefNo" : null,
"accSettMethod" : "CUST_A/C",
"amountCcy" : "USD",
"eventCode" : "EXCESS_REFUND",
"accountCcy" : "USD",
"accPartyId" : "202296",
"externalAccountCcy" : null,
"externalAccount" : null,
"accEntrySeq" : 1,
"accRoleDesc" : "CR-RFPD",
"externalBankId" : null,
"amountAccCcy" : 200,
"externalBranchCode" : null,
"routingCode" : null,
"status" : "SUCCESS"
},
"2" : {
"seqNo" : 1,
"accountingEntryCode" : "EXREFUND_RFND_API",
"errorCode" : null,
"accRoleCode" : "CR-RFPD",
"externalBranchName" : "BRANCH123123",
"financeRefNo" : null,
"exchangeRate" : 1,
"accountNo" : "988623101",
"accPartyType" : "PAYMENT_PARTY",
"id" : "1218566755913576448",
"accType" : "C",
"accEntryDesc" : "EXREFUND_RFND_API",
"amountType" : "EXCESS_REFUND_AMOUNT",
"externalBankName" : "BANK123123",
"amount" : 200,
"errorDesc" : null,
"eventSrNo" : 1,
"paymentMode" : "EFT",
"drCrIndicator" : "C",
"ecaRefNo" : null,
"accSettMethod" : "NEFT",
"amountCcy" : "USD",
"eventCode" : "EXCESS_REFUND",
"accountCcy" : "USD",
"accPartyId" : "202295",
"externalAccountCcy" : "USD",
"externalAccount" : "123123",
"accEntrySeq" : 1,
"accRoleDesc" : "CR-RFPD",
"externalBankId" : "bankId",
"amountAccCcy" : 200,
"externalBranchCode" : null,
"routingCode" : "IFSC123123",
"status" : "SUCCESS"
}
},
"instdAmt" : 200,
"startDate" : "2022-11-02"
},
"serviceConsumerName" : "OBSCFCM_OBPM"
}
Response:
{
"headers": {},
"body": {
"data": {
"sourceCode": "999",
"txnRefNo": "999",
"status": "SUCCESS"
},
"messages": {
"keyId": null,
"status": "SUCCESS",
"codes": [],
"requestId": null,
"httpStatusCode": "OK",
"overrideAuthLevelsReqd": null
}
}
}
CreateExternalConsumerLoan
This API enables the user to transfer the finance data to payments. This API is called from finance service and instruments.
SERVICE-CONSUMER = “OBSCFCM_OBPM”
SERVICE-CONSUMER-SERVICE= “CreateExternalConsumerLoan”
Request
{
"serviceConsumerServiceName" : "CreateExternalConsumerLoan",
"body" : {
"branchCode" : "004",
"accountStatus" : "A",
"accountCcy" : "USD",
"sourAccBrn" : "240",
"sourceSystem" : "OBSCF",
"loanAccNum" : "INV0645",
"custId" : "000380",
"loanBrn" : "004",
"hostCode" : "INDIA",
"sourcCustAcc" : "INV0645",
"paymentRequest" : {
"invoiceId" : "2022040400000000000000000000000000000404",
"amount" : 3026626,
"totalInvoiceAmount" : 3026626,
"buyerId" : "000380",
"buyerName" : "Carrefour",
"buyerDivCode" : null,
"buyerDivName" : null,
"currency" : "USD",
"invoiceDate" : "2022-04-04",
"dueDate" : "2022-07-30",
"invoiceNumber" : "ETVTS/NOV22/0128",
"repaymentAccNo" : null,
"refNo" : "INV0645",
"invAcceptanceDate" : "2022-04-04",
"status" : "UNPAID",
"programCode" : null,
"programName" : null,
"paymentTerms" : null,
"supplierId" : "000381",
"supplierName" : "Danone",
"supplierDivCode" : null,
"supplierDivName" : null,
"relationCode" : "REL701",
"supplierCode" : null,
"buyerCode" : null,
"virtualAcFlag" : null,
"branchCode" : "004",
"debtor" : null,
"debtorName" : null,
"customerId" : "000380"
}
},
"serviceConsumerName" : "OBSCFCM_OBPM"
}
Response:
{
"headers": {},
"body": {
"data": {
"sourceCode": "999",
"loanAccNumber": "10101",
"status": "SUCCESS"
},
"messages": {
"keyId": null,
"status": "SUCCESS",
"codes": [],
"requestId": null,
"httpStatusCode": "OK",
"overrideAuthLevelsReqd": null
}
}
SwiftMessageAdopt
When payment mode is selected as Cross Border Transfer, this API will be used for external payment.
SERVICE-CONSUMER = “OBSCFCM_OBPM”
SERVICE-CONSUMER-SERVICE= “SwiftMessageAdopt”
Request:
{
"obpmBranchCode" : "xxx",
"seqNo" : 1,
"settlementCcy" : null,
"paymentParty" : null,
"financePCT" : 80,
"minReFinPCT" : null,
"sourceCode" : "EXTSYS",
"financeRefNo" : "004300823PR02792",
"minFinPCT" : null,
"staleStatus" : "N",
"programName" : "This is PROGRAM1",
"id" : "1341360754855919616",
"interestRefundHandling" : null,
"productDescription" : "This is PRD1",
"holidayTreatment" : "NCH",
"creditAccount" : null,
"partRepaymentAllowed" : null,
"interestPaidUpfront" : 0.12,
"financeAmt" : 80,
"branchCode" : "004",
"pmtToPrncplOS" : null,
"totalInstrumentAmt" : 100,
"financeAmtCcy" : "USD",
"valueDtdIntOSAmt" : null,
"appropPaymentAmt" : null,
"pmtToIntOS" : null,
"interestRefundAmt" : null,
"settlementAmtAllocation" : null,
"startDate" : "2023-08-30",
"settlementProcessingDate" : null,
"totalOSAmountSettlementCcy" : null,
"refund" : null,
"maxFinanciableAmt" : 80,
"pmtToPenOnIntOS" : null,
"errorDescription" : null,
"settleFinExcRate" : null,
"appropriationSequence" : null,
"msgId" : "2023-08-3086045",
"manualAllocation" : null,
"interestBearingPartyRole" : "S",
"tenor" : 9,
"requestId" : "R3008231135",
"interestRefundPmtMode" : null,
"debitAccCcy" : "USD",
"totalOSAmount" : 80,
"preferredDisbursementMode" : "CBT",
"withRecourse" : "Y",
"stageId" : "ExternalPaymentException",
"interestOSAmount" : 0,
"debtorName" : "DanoneTest",
"buyerName" : "XXXXXXXXXXXXX",
"transactionFlow" : null,
"productCode" : "PRD1",
"pastDueDate" : "2023-09-08",
"remittanceInfo" : "004300823PR02792",
"valueDtdOverdueIntOSAmt" : null,
"supplierDivCode" : null,
"maxTenorAllowed" : 99,
"supplierDivName" : null,
"settlementAmtAllocated" : null,
"graceDays" : 0,
"operationCode" : "DISBURSEMENT",
"errorCode" : null,
"buyerId" : "000380",
"debitAccNo" :"988623101",
"principalOSAmount" : 80,
"exchangeRate" : 1,
"maxFinPCT" : 80,
"isFromRecon" : null,
"maturityDate" : "2023-09-08",
"totalSettlementAmt" : null,
"valueDtdPenIntOSAmt" : null,
"buyerDivCode" : null,
"interestAmortized" : null,
"programCode" : "PROGRAM1",
"minFinanciableAmt" : null,
"totalMarginAmount" : null,
"minTenorAllowed" : 1,
"accountType" : null,
"drAcType" : 10,
"creditReceived" : null,
"authDateStamp" : "2023-08-30",
"settlementExchangeRate" : null,
"pmtToOverdueIntOS" : null,
"hostCode" : "INDIA",
"sourceRef" : "2023-08-3086045",
"paymentAmt" : null,
"totalOSPostAllocation" : null,
"financeStatus" : null,
"supplierId" : "000381",
"balanceAmtToBeAllocated" : null,
"maxReFinPCT" : null,
"totalInstrumentAmtCcy" : "USD",
"processingDate" : "2023-08-30",
"interestType" : "F",
"clRefNo" : "902DES5232420776",
"settlementMethod" : null,
"authId" : "VIRENDRA123",
"productCategory" : "INV",
"overdueIntOSAmt" : 0,
"debtor" : "000381",
"hostBankAddress1" : null,
"hostBankAddress3" : null,
"hostBankAddress2" : null,
"hostBankAddress4" : null,
"productType" : "S",
"makerId" : "VIRENDRA123",
"supplierName" : "XXXXXXXXXX",
"makerDateStamp" : "2023-08-30",
"penIntOSAmt" : 0,
"valueDate" : null,
"buyerDivName" : null,
"userRef" : "2023-08-3086045",
"accountingTransactionModel": {
"id" :"1341683593303703552",
"financeRefNo" : null,
"refNo" : "004300823PR02792",
"seqNo" : 1,
"accountingEntryCode" : "EFT_ENTRY_CODE",
"drCrIndicator" : "C",
"amountCcy" : "USD",
"amount" : 80,
"amountType" : "FINANCE_AMT",
"accountCcy" : "USD",
"amountAccCcy" : 80,
"accountNo" : "988623101",
"exchangeRate" : 1,
"status" : null,
"errorCode" : null,
"errorDesc" : null,
"accRoleCode" : "SUSP_ACC",
"accPartyType" : "SUPP",
"accPartyId" : "000381",
"accSettMethod" : "CBT",
"accEntrySeq" : 1,
"accRoleDesc" : "Suspense GL",
"accEntryDesc" : "EFT Account Entry Code",
"accType" : "C",
"eventSrNo" : 1,
"ecaRefNo" : null,
"eventCode" : "DISBURSEMENT",
"externalAccount" :"123456",
"paymentMode" : "CBT",
"externalAccountCcy" : "USD",
"externalBankId" : "bankId",
"externalBankName" : "DEUTSCHE BANK",
"externalBranchCode" : null,
"externalBranchName" : null,
"externalBranchRoutingCode" : null,
"stage" : null,
"additionalField1" : null,
"additionalField2" : null,
"additionalField3" : null,
"additionalField4" : null,
"additionalField5" : null,
"additionalField6" : null,
"additionalField7" : null,
"additionalField8" : null,
"additionalField9" : null,
"additionalField10" : null,
"applicationCode" : "OBSCF",
"valueDate" : "2023-08-30",
"processingDate" : "2023-08-30",
"txnBranchCode" : "004",
"productCode" : "PRD1",
"vaFlagYN" : null,
"accountName" : "Account 1",
"bicUltimate" : "CITIHRADXXX",
"addressLine1Ultimate" : "Frankfurt",
"addressLine2Ultimate" : null,
"addressLine3Ultimate" : null,
"addressLine4Ultimate" : "Address4",
"country" : "United States",
"phoneNumber" : null,
"emailId" : "abc@example.com",
"bicIntermediary" : null,
"bankNameIntermediary" : null,
"addressLine1Intermediary" : null,
"addressLine2Intermediary" : null,
"addressLine3Intermediary" : null,
"addressLine4Intermediary" : null,
"creditIntAcntList" : null,
"debitIntAcntList" : null,
"accEntryAttributeList" : null,
"creditInternalAttributeList" : null,
"debitInternalAttributeList" : null,
"creditExternalAttributeList" : null,
"debitExternalAttributeList" : null,
"correspondingDebtAcc" : null
},
"accountingTransactionModelList" : [ {
"id" : "1341683593165291520",
"financeRefNo" : null,
"refNo" : "004300823PR02792",
"seqNo" : 1,
"accountingEntryCode" : "EFT_ENTRY_CODE",
"drCrIndicator" : "D",
"amountCcy" : "USD",
"amount" : 80,
"amountType" : "FINANCE_AMT",
"accountCcy" : "USD",
"amountAccCcy" : 80,
"accountNo" : "988623101",
"exchangeRate" : 1,
"status" : null,
"errorCode" : null,
"errorDesc" : null,
"accRoleCode" : "BRIDGE_ACC",
"accPartyType" : "BUY",
"accPartyId" : "000380",
"accSettMethod" : "INTERNAL_GL",
"accEntrySeq" : 1,
"accRoleDesc" : "Bridge GL",
"accEntryDesc" : "EFT Account Entry Code",
"accType" : "G",
"eventSrNo" : 1,
"ecaRefNo" : null,
"eventCode" : "DISBURSEMENT",
"externalAccount" : null,
"paymentMode" : null,
"externalAccountCcy" : null,
"externalBankId" : null,
"externalBankName" : null,
"externalBranchCode" : null,
"externalBranchName" : null,
"externalBranchRoutingCode" : null,
"stage" : null,
"additionalField1" : null,
"additionalField2" : null,
"additionalField3" : null,
"additionalField4" : null,
"additionalField5" : null,
"additionalField6" : null,
"additionalField7" : null,
"additionalField8" : null,
"additionalField9" : null,
"additionalField10" : null,
"applicationCode" : "OBSCF",
"valueDate" : "2023-08-30",
"processingDate" : "2023-08-30",
"txnBranchCode" : "004",
"productCode" : "PRD1",
"vaFlagYN" : null,
"accountName" : null,
"bicUltimate" : null,
"addressLine1Ultimate" : null,
"addressLine2Ultimate" : null,
"addressLine3Ultimate" : null,
"addressLine4Ultimate" : null,
"country" : null,
"phoneNumber" : null,
"emailId" : null,
"bicIntermediary" : null,
"bankNameIntermediary" : null,
"addressLine1Intermediary" : null,
"addressLine2Intermediary" : null,
"addressLine3Intermediary" : null,
"addressLine4Intermediary" : null,
"creditIntAcntList" : null,
"debitIntAcntList" : null,
"accEntryAttributeList" : null,
"creditInternalAttributeList" : null,
"debitInternalAttributeList" : null,
"creditExternalAttributeList" : null,
"debitExternalAttributeList" : null,
"correspondingDebtAcc" : null
},
{ "id" : "1341683593303703552",
"financeRefNo" : null,
"refNo" : "004300823PR02792",
"seqNo" : 1,
"accountingEntryCode" : "EFT_ENTRY_CODE",
"drCrIndicator" : "C",
"amountCcy" : "USD",
"amount" : 80,
"amountType" : "FINANCE_AMT",
"accountCcy" : "USD",
"amountAccCcy" : 80,
"accountNo" : "988623101",
"exchangeRate" : 1,
"status" : null,
"errorCode" : null,
"errorDesc" : null,
"accRoleCode" : "SUSP_ACC",
"accPartyType" : "SUPP",
"accPartyId" : "000381",
"accSettMethod" : "CBT",
"accEntrySeq" : 1,
"accRoleDesc" : "Suspense GL",
"accEntryDesc" : "EFT Account Entry Code",
"accType" : "C",
"eventSrNo" : 1,
"ecaRefNo" : null,
"eventCode" : "DISBURSEMENT",
"externalAccount" : "123456",
"paymentMode" : "CBT",
"externalAccountCcy" : "USD",
"externalBankId" : "bankId",
"externalBankName" : "DEUTSCHE BANK",
"externalBranchCode" : null,
"externalBranchName" : null,
"externalBranchRoutingCode" : null,
"stage" : null,
"additionalField1" : null,
"additionalField2" : null,
"additionalField3" : null,
"additionalField4" : null,
"additionalField5" : null,
"additionalField6" : null,
"additionalField7" : null,
"additionalField8" : null,
"additionalField9" : null,
"additionalField10" : null,
"applicationCode" : "OBSCF",
"valueDate" : "2023-08-30",
"processingDate" : "2023-08-30",
"txnBranchCode" : "004",
"productCode" : "PRD1",
"vaFlagYN" : null,
"accountName" : "Account 1",
"bicUltimate" : "CITIHRADXXX",
"addressLine1Ultimate" : "Frankfurt",
"addressLine2Ultimate" : null,
"addressLine3Ultimate" : null,
"addressLine4Ultimate" : "Address4",
"country" : "United States",
"phoneNumber" : null,
"emailId" : "abc@example.com",
"bicIntermediary" : null,
"bankNameIntermediary" : null,
"addressLine1Intermediary" : null,
"addressLine2Intermediary" : null,
"addressLine3Intermediary" : null,
"addressLine4Intermediary" : null,
"creditIntAcntList" : null,
"debitIntAcntList" : null,
"accEntryAttributeList" : null,
"creditInternalAttributeList" : null,
"debitInternalAttributeList" : null,
"creditExternalAttributeList" : null,
"debitExternalAttributeList" : null,
"correspondingDebtAcc" : null } ],
"settlementRefNo" : null,
"hostBankBic" : "CITIAEADXXX"
} Response:
{
"txnrefno" : "2505101042689000",
"sourceCode" : "MANL",
"endtoendid" : "2023-08-3086045",
"instrid" : "2023-08-3086045",
"MSGSTATUS" : "SUCCESS",
"TXNID" : "2505101942689000",
"txnRefNo" : "2505101042689000",
"resp" : [ {
"respCode" : "PM-SAVE-002",
"respDesc" : "Transaction Processed and Authorized ."
} ]
}Parent topic: Outbound API configuration in Oracle Banking Routing Hub