Jump to

• Request
• Response

Update existing payment details

put

/dmpayment-service/payments

This endpoint is used to update an existing payment details.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Body ()

Request Body that contains data required for updating an existing payment details.

Root Schema : DmFeedPaymentWrapperDTO

Type: object

Collection of payment entity

Show Source

• acctNbr: string
  Account Number.
• mode: string
  Online or feed.
• payment: array payment
• prdProcessrCd: string
  Product processor code.

{
    "description":"Collection of payment entity",
    "type":"object",
    "properties":{
        "acctNbr":{
            "description":"Account Number.",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product processor code.",
            "type":"string"
        },
        "mode":{
            "description":"Online or feed.",
            "type":"string"
        },
        "payment":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmFeedPaymentDTO"
            }
        }
    }
}

Nested Schema : payment

Type: array

Show Source

• Array of: object DmFeedPaymentDTO
  Payment Object

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

Nested Schema : DmFeedPaymentDTO

Type: object

Payment Object

Show Source

• acctNbr: string
  Account Number
• narrationTxt: string
  Narration
• origXrefNo: string
  Original Reference Number
• origXrefSubSeqNo: string
  Original Reference Sub sequence Number
• prdProcessrCd: string
  Product Processor Code
• rcdType: string
  Record type
• transactionAmt: number
  Transaction Amount
• transactionCurrCd: string
  Transaction Currency Code
• transactionDttm: string
  Transaction Date and Time
• transactionTypeFlg: string
  Transaction Type
• udf1: number
  udf1
• udf10: number
  udf10
• udf11: number
  udf11
• udf12: number
  udf12
• udf13: number
  udf13
• udf14: number
  udf14
• udf15: number
  udf15
• udf16: number
  udf16
• udf17: number
  udf17
• udf18: number
  udf18
• udf19: number
  udf19
• udf2: number
  udf2
• udf20: number
  udf20
• udf21: number
  udf21
• udf22: number
  udf22
• udf23: number
  udf23
• udf24: number
  udf24
• udf25: number
  udf25
• udf26: number
  udf26
• udf27: number
  udf27
• udf28: number
  udf28
• udf29: number
  udf29
• udf3: number
  udf3
• udf30: number
  udf30
• udf31: string
  udf31
• udf32: string
  udf32
• udf33: string
  udf33
• udf34: string
  udf34
• udf35: string
  udf35
• udf36: string
  udf36
• udf37: string
  udf37
• udf38: string
  udf38
• udf39: string
  udf39
• udf4: number
  udf4
• udf40: string
  udf40
• udf41: string
  udf41
• udf42: string
  udf42
• udf43: string
  udf43
• udf44: string
  udf44
• udf45: string
  udf45
• udf46: string
  udf46
• udf47: string
  udf47
• udf48: string
  udf48
• udf49: string
  udf49
• udf5: number
  udf5
• udf50: string
  udf50
• udf6: number
  udf6
• udf7: number
  udf7
• udf8: number
  udf8
• udf9: number
  udf9
• valueDt: string
  Value Date
• xrefNo: string
  Payment Reference Number
• xrefSubSeqNo: string
  Reference Sub sequence Number

{
    "description":"Payment Object",
    "type":"object",
    "properties":{
        "acctNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "xrefNo":{
            "description":"Payment Reference Number",
            "type":"string"
        },
        "rcdType":{
            "description":"Record type",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "transactionDttm":{
            "description":"Transaction Date and Time",
            "type":"string"
        },
        "valueDt":{
            "description":"Value Date",
            "type":"string"
        },
        "transactionCurrCd":{
            "description":"Transaction Currency Code",
            "type":"string"
        },
        "transactionAmt":{
            "description":"Transaction Amount",
            "type":"number"
        },
        "narrationTxt":{
            "description":"Narration",
            "type":"string"
        },
        "transactionTypeFlg":{
            "description":"Transaction Type",
            "type":"string"
        },
        "origXrefNo":{
            "description":"Original Reference Number",
            "type":"string"
        },
        "xrefSubSeqNo":{
            "description":"Reference Sub sequence Number",
            "type":"string"
        },
        "origXrefSubSeqNo":{
            "description":"Original Reference Sub sequence Number ",
            "type":"string"
        },
        "udf1":{
            "description":"udf1",
            "type":"number"
        },
        "udf2":{
            "description":"udf2",
            "type":"number"
        },
        "udf3":{
            "description":"udf3",
            "type":"number"
        },
        "udf4":{
            "description":"udf4",
            "type":"number"
        },
        "udf5":{
            "description":"udf5",
            "type":"number"
        },
        "udf6":{
            "description":"udf6",
            "type":"number"
        },
        "udf7":{
            "description":"udf7",
            "type":"number"
        },
        "udf8":{
            "description":"udf8",
            "type":"number"
        },
        "udf9":{
            "description":"udf9",
            "type":"number"
        },
        "udf10":{
            "description":"udf10",
            "type":"number"
        },
        "udf11":{
            "description":"udf11",
            "type":"number"
        },
        "udf12":{
            "description":"udf12",
            "type":"number"
        },
        "udf13":{
            "description":"udf13",
            "type":"number"
        },
        "udf14":{
            "description":"udf14",
            "type":"number"
        },
        "udf15":{
            "description":"udf15",
            "type":"number"
        },
        "udf16":{
            "description":"udf16",
            "type":"number"
        },
        "udf17":{
            "description":"udf17",
            "type":"number"
        },
        "udf18":{
            "description":"udf18",
            "type":"number"
        },
        "udf19":{
            "description":"udf19",
            "type":"number"
        },
        "udf20":{
            "description":"udf20",
            "type":"number"
        },
        "udf21":{
            "description":"udf21",
            "type":"number"
        },
        "udf22":{
            "description":"udf22",
            "type":"number"
        },
        "udf23":{
            "description":"udf23",
            "type":"number"
        },
        "udf24":{
            "description":"udf24",
            "type":"number"
        },
        "udf25":{
            "description":"udf25",
            "type":"number"
        },
        "udf26":{
            "description":"udf26",
            "type":"number"
        },
        "udf27":{
            "description":"udf27",
            "type":"number"
        },
        "udf28":{
            "description":"udf28",
            "type":"number"
        },
        "udf29":{
            "description":"udf29",
            "type":"number"
        },
        "udf30":{
            "description":"udf30",
            "type":"number"
        },
        "udf31":{
            "description":"udf31",
            "type":"string"
        },
        "udf32":{
            "description":"udf32",
            "type":"string"
        },
        "udf33":{
            "description":"udf33",
            "type":"string"
        },
        "udf34":{
            "description":"udf34",
            "type":"string"
        },
        "udf35":{
            "description":"udf35",
            "type":"string"
        },
        "udf36":{
            "description":"udf36",
            "type":"string"
        },
        "udf37":{
            "description":"udf37",
            "type":"string"
        },
        "udf38":{
            "description":"udf38",
            "type":"string"
        },
        "udf39":{
            "description":"udf39",
            "type":"string"
        },
        "udf40":{
            "description":"udf40",
            "type":"string"
        },
        "udf41":{
            "description":"udf41",
            "type":"string"
        },
        "udf42":{
            "description":"udf42",
            "type":"string"
        },
        "udf43":{
            "description":"udf43",
            "type":"string"
        },
        "udf44":{
            "description":"udf44",
            "type":"string"
        },
        "udf45":{
            "description":"udf45",
            "type":"string"
        },
        "udf46":{
            "description":"udf46",
            "type":"string"
        },
        "udf47":{
            "description":"udf47",
            "type":"string"
        },
        "udf48":{
            "description":"udf48",
            "type":"string"
        },
        "udf49":{
            "description":"udf49",
            "type":"string"
        },
        "udf50":{
            "description":"udf50",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
• id: string
• requestId: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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.

Back to Top