Jump to

• Request
• Response

Retrieves the list of existing Invoices

get

/service/v1/getCurrentTwPayment

This endpoint is used to get the list of existing Invoices.

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : PaymentCollectionDto

Type: object

ScfPaymentDTO Collection

Show Source

• action(optional): string
  Action
• data(optional): array data
  ScfPaymentDTO
• paging(optional): object paging
  paging

{
    "description":"ScfPaymentDTO Collection",
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"Action"
        },
        "data":{
            "description":"ScfPaymentDTO",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfPaymentDTO"
            }
        },
        "paging":{
            "description":"paging",
            "type":"object"
        }
    }
}

Nested Schema : data

Type: array

ScfPaymentDTO

Show Source

• Array of: object ScfPaymentDTO
  Payment details for Payments Model

{
    "description":"ScfPaymentDTO",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfPaymentDTO"
    }
}

Nested Schema : paging

Type: object

paging

Nested Schema : ScfPaymentDTO

Type: object

Payment details for Payments Model

Show Source

• accOwner(optional): string
  accOwner
• allocatedAmt(optional): number
  allocatedAmt
• allocationRequired(optional): string
  allocationRequired
• allocStatus(optional): string
  allocStatus
• autoReconcile(optional): string
  Auto Reconcile
• bankCode(optional): string
  Bank Code
• beneficiaryCode(optional): string
  Beneficiary Code
• beneficiaryId(optional): string
  Beneficiary Id
• beneficiaryName(optional): string
  Beneficiary Id
• beneficiaryRole(optional): string
  beneficiaryRole
• counterpartyCode(optional): string
  Counterparty Code
• counterpartyId(optional): string
  Counterparty Id
• counterpartyName(optional): string
  counterpartyName
• counterpartyRole(optional): string
  counterpartyRole
• creditAccNo(optional): string
  Credit Account Number
• creditNoteRefNo(optional): string
  Credit Note Reference Number
• dcIndicator(optional): string
  Dc Indicator
• derivedFlag(optional): string
  derivedFlag
• eftRefNo(optional): string
  Eft Reference Number
• entityRefNo(optional): string
  Entity Reference Number
• errorDesc(optional): string
  errorDesc
• excessHandling(optional): string
  excessHandling
• excessRefundParty(optional): string
  excessRefundParty
• excessRefundPartyId(optional): string
  excessRefundPartyId
• excessRefundPaymentMode(optional): string
  excessRefundPaymentMode
• 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
  financeReferenceNo
• 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
  isAutoAuth
• isIndirectPayment(optional): string
  isIndirectPayment
• isPUA(optional): string
  isPUA
• isRecon(optional): string
  isRecon
• lastActionPerformed(optional): string
  Last Action Performed
• mandateRefNo(optional): string
  Mandate Reference Number
• matchedAmount(optional): number
  matchedAmount
• parentPaymentRefNo(optional): string
  parentPaymentRefNo
• partyPaymentCode(optional): string
  Party Payment Code
• paymentAmount(optional): number
  Payment Amount
• paymentBusinessDate(optional): string
  paymentBusinessDate
• paymentCurrency(optional): string
  Payment Currency
• paymentDate(optional): string
  Payment Date
• paymentMode(optional): string
  Payment Mode
• paymentNumber(optional): string
  Payment Number
• paymentPartyCategory(optional): string
  paymentPartyCategory
• paymentPartyId(optional): string
  Payment Party id
• paymentPartyName(optional): string
• paymentPartyRole(optional): string
  paymentPartyRole
• paymentProcessStatus(optional): string
  Payment Process Status
• paymentRefNo(optional): string
  Payment Reference Number
• paymentStatus(optional): string
  Payment Status
• procBranchCode(optional): string
  procBranchCode
• procBranchDate(optional): string
  procBranchDate
• programCode(optional): string
  Program Code
• reasonCode(optional): string
  Reason Code
• reconciledPmtAmt(optional): number
  reconciledPmtAmt
• reconTxnStatus(optional): string
  reconTxnStatus
• refundAmount(optional): number
  refundAmount
• relationshipCode(optional): string
  relationshipCode
• remarks(optional): string
  Remarks
• remitterAccNo(optional): string
  Remitter Account Number
• seqNo(optional): integer(int64)
  seqNo
• sourceTxnId(optional): string
  Recon Txn Number
• specificAppropriation(optional): string
  Specific Appropriation
• stageId(optional): string
  stageId
• totalAllocatedAmt(optional): number
  totalAllocatedAmt
• transactionRefNo(optional): string
  transactionRefNo
• transactionStatus(optional): string
  transactionStatus
• unallocatedAmt(optional): number
  unallocatedAmt
• unmatchedAmount(optional): number
  unmatchedAmount
• virtualAcFlag(optional): string
  virtualAcFlag

{
    "description":"Payment details for Payments Model",
    "type":"object",
    "properties":{
        "autoReconcile":{
            "type":"string",
            "description":"Auto Reconcile"
        },
        "bankCode":{
            "type":"string",
            "description":"Bank Code"
        },
        "beneficiaryCode":{
            "type":"string",
            "description":"Beneficiary Code"
        },
        "beneficiaryId":{
            "type":"string",
            "description":"Beneficiary Id"
        },
        "beneficiaryName":{
            "type":"string",
            "description":"Beneficiary Id"
        },
        "counterpartyId":{
            "type":"string",
            "description":"Counterparty Id"
        },
        "counterpartyName":{
            "type":"string",
            "description":"counterpartyName"
        },
        "counterpartyCode":{
            "type":"string",
            "description":"Counterparty Code"
        },
        "creditAccNo":{
            "type":"string",
            "description":"Credit Account Number"
        },
        "creditNoteRefNo":{
            "type":"string",
            "description":"Credit Note Reference Number"
        },
        "dcIndicator":{
            "type":"string",
            "description":"Dc Indicator"
        },
        "eftRefNo":{
            "type":"string",
            "description":"Eft Reference Number"
        },
        "entityRefNo":{
            "type":"string",
            "description":"Entity Reference Number"
        },
        "filler1":{
            "type":"string",
            "description":"Filler 1"
        },
        "filler2":{
            "type":"string",
            "description":"Filler 2"
        },
        "filler3":{
            "type":"string",
            "description":"Filler 3"
        },
        "filler4":{
            "type":"string",
            "description":"Filler 4"
        },
        "filler5":{
            "type":"string",
            "description":"Filler 5"
        },
        "filler6":{
            "type":"string",
            "description":"Filler 6"
        },
        "filler7":{
            "type":"string",
            "description":"Filler 7"
        },
        "filler8":{
            "type":"string",
            "description":"Filler 8"
        },
        "filler9":{
            "type":"string",
            "description":"Filler 9"
        },
        "filler10":{
            "type":"string",
            "description":"Filler 10"
        },
        "flag":{
            "type":"string",
            "description":"Flag"
        },
        "genericAppropriation":{
            "type":"string",
            "description":"Generic Appropriation"
        },
        "specificAppropriation":{
            "type":"string",
            "description":"Specific Appropriation"
        },
        "indicator":{
            "type":"string",
            "description":"Indicator"
        },
        "instrumentBank":{
            "type":"string",
            "description":"Instrument Bank"
        },
        "instrumentBranch":{
            "type":"string",
            "description":"Instrument Branch"
        },
        "instrumentDate":{
            "type":"string",
            "description":"Instrument Date"
        },
        "mandateRefNo":{
            "type":"string",
            "description":"Mandate Reference Number"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount"
        },
        "paymentCurrency":{
            "type":"string",
            "description":"Payment Currency"
        },
        "paymentDate":{
            "type":"string",
            "description":"Payment Date"
        },
        "paymentMode":{
            "type":"string",
            "description":"Payment Mode"
        },
        "paymentNumber":{
            "type":"string",
            "description":"Payment Number"
        },
        "partyPaymentCode":{
            "type":"string",
            "description":"Party Payment Code"
        },
        "paymentPartyId":{
            "type":"string",
            "description":"Payment Party id"
        },
        "paymentPartyName":{
            "type":"string"
        },
        "paymentProcessStatus":{
            "type":"string",
            "description":"Payment Process Status"
        },
        "paymentRefNo":{
            "type":"string",
            "description":"Payment Reference Number"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Payment Status"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "remitterAccNo":{
            "type":"string",
            "description":"Remitter Account Number"
        },
        "fileName":{
            "type":"string",
            "description":"File Name"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason Code"
        },
        "lastActionPerformed":{
            "type":"string",
            "description":"Last Action Performed"
        },
        "matchedAmount":{
            "type":"number",
            "description":"matchedAmount"
        },
        "unmatchedAmount":{
            "type":"number",
            "description":"unmatchedAmount"
        },
        "reconTxnStatus":{
            "type":"string",
            "description":"reconTxnStatus"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"isAutoAuth"
        },
        "virtualAcFlag":{
            "type":"string",
            "description":"virtualAcFlag"
        },
        "paymentBusinessDate":{
            "type":"string",
            "description":"paymentBusinessDate"
        },
        "counterpartyRole":{
            "type":"string",
            "description":"counterpartyRole"
        },
        "beneficiaryRole":{
            "type":"string",
            "description":"beneficiaryRole"
        },
        "paymentPartyRole":{
            "type":"string",
            "description":"paymentPartyRole"
        },
        "relationshipCode":{
            "type":"string",
            "description":"relationshipCode"
        },
        "errorDesc":{
            "type":"string",
            "description":"errorDesc"
        },
        "paymentPartyCategory":{
            "type":"string",
            "description":"paymentPartyCategory"
        },
        "derivedFlag":{
            "type":"string",
            "description":"derivedFlag"
        },
        "allocationRequired":{
            "type":"string",
            "description":"allocationRequired"
        },
        "allocStatus":{
            "type":"string",
            "description":"allocStatus"
        },
        "allocatedAmt":{
            "type":"number",
            "description":"allocatedAmt"
        },
        "unallocatedAmt":{
            "type":"number",
            "description":"unallocatedAmt"
        },
        "accOwner":{
            "type":"string",
            "description":"accOwner"
        },
        "procBranchCode":{
            "type":"string",
            "description":"procBranchCode"
        },
        "procBranchDate":{
            "type":"string",
            "description":"procBranchDate"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"transactionRefNo"
        },
        "transactionStatus":{
            "type":"string",
            "description":"transactionStatus"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "isPUA":{
            "type":"string",
            "description":"isPUA"
        },
        "isIndirectPayment":{
            "type":"string",
            "description":"isIndirectPayment"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"Recon Txn Number"
        },
        "reconciledPmtAmt":{
            "type":"number",
            "description":"reconciledPmtAmt"
        },
        "totalAllocatedAmt":{
            "type":"number",
            "description":"totalAllocatedAmt"
        },
        "isRecon":{
            "type":"string",
            "description":"isRecon"
        },
        "financeReferenceNo":{
            "type":"string",
            "description":"financeReferenceNo"
        },
        "excessHandling":{
            "type":"string",
            "description":"excessHandling"
        },
        "excessRefundParty":{
            "type":"string",
            "description":"excessRefundParty"
        },
        "excessRefundPartyId":{
            "type":"string",
            "description":"excessRefundPartyId"
        },
        "excessRefundPaymentMode":{
            "type":"string",
            "description":"excessRefundPaymentMode"
        },
        "parentPaymentRefNo":{
            "type":"string",
            "description":"parentPaymentRefNo"
        },
        "refundAmount":{
            "type":"number",
            "description":"refundAmount"
        },
        "stageId":{
            "type":"string",
            "description":"stageId"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top