Jump to

• Request
• Response

Appropriate Payment Against Promise To Pay

put

/obedm-ptp-services/ptp/appropriate

This endpoint is used to appropriate payment against Promise to Pay.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application ID for appropriate payment against Promise to Pay.
• branchCode: string
  Branch code for appropriate payment against Promise to Pay.
• contentType(optional): string
  Content Type ID for appropriate payment against Promise to Pay.
• tenantId(optional): string
  Tenant ID for appropriate payment against Promise to Pay.
• userId: string
  User ID for appropriate payment against Promise to Pay.

Body ()

Request Body that contains data of payments to be appropriated.

Root Schema : DmPaymentDTOCollection

Type: object

Collection of DmPaymentDTOs.

Show Source

• data(optional): array data

{
    "description":"Collection of DmPaymentDTOs.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmPaymentDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object DmPaymentDTO
  DmPayment model

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

Nested Schema : DmPaymentDTO

Type: object

DmPayment model

Show Source

• accountId(optional): string
  accountId of the DmPayment
• createdBy(optional): string
  createdBy of the DmPayment
• cretDttm(optional): string
  cretDttm of the DmPayment
• lastUpdatedBy(optional): string
  lastUpdatedBy of the DmPayment
• lastUpdtDttm(optional): string
  lastUpdtDttm of the DmPayment
• narrationTxt(optional): string
  narrationTxt of the DmPayment
• origXrefNo(optional): string
  origXrefNo of the DmPayment
• origXrefSubSeqNo(optional): string
  origXrefSubSeqNo of the DmPayment
• transactionAmt(optional): number
  transactionAmt of the DmPayment
• transactionCurrCd(optional): string
  transactionCurrCd of the DmPayment
• transactionDttm(optional): string
  transactionDttm of the DmPayment
• transactionTypeFlg(optional): string
  transactionTypeFlg of the DmPayment
• udf1(optional): number
  udf1 of the DmPayment
• udf10(optional): number
  udf10 of the DmPayment
• udf11(optional): number
  udf11 of the DmPayment
• udf12(optional): number
  udf12 of the DmPayment
• udf13(optional): number
  udf13 of the DmPayment
• udf14(optional): number
  udf14 of the DmPayment
• udf15(optional): number
  udf15 of the DmPayment
• udf16(optional): number
  udf16 of the DmPayment
• udf17(optional): number
  udf17 of the DmPayment
• udf18(optional): number
  udf18 of the DmPayment
• udf19(optional): number
  udf19 of the DmPayment
• udf2(optional): number
  udf2 of the DmPayment
• udf20(optional): number
  udf20 of the DmPayment
• udf21(optional): number
  udf21 of the DmPayment
• udf22(optional): number
  udf22 of the DmPayment
• udf23(optional): number
  udf23 of the DmPayment
• udf24(optional): number
  udf24 of the DmPayment
• udf25(optional): number
  udf25 of the DmPayment
• udf26(optional): number
  udf26 of the DmPayment
• udf27(optional): number
  udf27 of the DmPayment
• udf28(optional): number
  udf28 of the DmPayment
• udf29(optional): number
  udf29 of the DmPayment
• udf3(optional): number
  udf3 of the DmPayment
• udf30(optional): number
  udf30 of the DmPayment
• udf31(optional): string
  udf31 of the DmPayment
• udf32(optional): string
  udf32 of the DmPayment
• udf33(optional): string
  udf33 of the DmPayment
• udf34(optional): string
  udf34 of the DmPayment
• udf35(optional): string
  udf35 of the DmPayment
• udf36(optional): string
  udf36 of the DmPayment
• udf37(optional): string
  udf37 of the DmPayment
• udf38(optional): string
  udf38 of the DmPayment
• udf39(optional): string
  udf39 of the DmPayment
• udf4(optional): number
  udf4 of the DmPayment
• udf40(optional): string
  udf40 of the DmPayment
• udf41(optional): string
  udf41 of the DmPayment
• udf42(optional): string
  udf42 of the DmPayment
• udf43(optional): string
  udf43 of the DmPayment
• udf44(optional): string
  udf44 of the DmPayment
• udf45(optional): string
  udf45 of the DmPayment
• udf46(optional): string
  udf46 of the DmPayment
• udf47(optional): string
  udf47 of the DmPayment
• udf48(optional): string
  udf48 of the DmPayment
• udf49(optional): string
  udf49 of the DmPayment
• udf5(optional): number
  udf5 of the DmPayment
• udf50(optional): string
  udf50 of the DmPayment
• udf6(optional): number
  udf6 of the DmPayment
• udf7(optional): number
  udf7 of the DmPayment
• udf8(optional): number
  udf8 of the DmPayment
• udf9(optional): number
  udf9 of the DmPayment
• valueDt(optional): string
  valueDt of the DmPayment
• xrefNo(optional): string
  xrefNo of the DmPayment
• xrefSubSeqNo(optional): string
  xrefSubSeqNo of the DmPayment

{
    "description":"DmPayment model",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"accountId of the DmPayment",
            "type":"string"
        },
        "xrefNo":{
            "description":"xrefNo of the DmPayment",
            "type":"string"
        },
        "transactionDttm":{
            "description":"transactionDttm of the DmPayment",
            "type":"string"
        },
        "valueDt":{
            "description":"valueDt of the DmPayment",
            "type":"string"
        },
        "transactionCurrCd":{
            "description":"transactionCurrCd of the DmPayment",
            "type":"string"
        },
        "transactionAmt":{
            "description":"transactionAmt of the DmPayment",
            "type":"number"
        },
        "narrationTxt":{
            "description":"narrationTxt of the DmPayment",
            "type":"string"
        },
        "transactionTypeFlg":{
            "description":"transactionTypeFlg of the DmPayment",
            "type":"string"
        },
        "origXrefNo":{
            "description":"origXrefNo of the DmPayment",
            "type":"string"
        },
        "xrefSubSeqNo":{
            "description":"xrefSubSeqNo of the DmPayment",
            "type":"string"
        },
        "origXrefSubSeqNo":{
            "description":"origXrefSubSeqNo of the DmPayment",
            "type":"string"
        },
        "cretDttm":{
            "description":"cretDttm of the DmPayment",
            "type":"string"
        },
        "lastUpdtDttm":{
            "description":"lastUpdtDttm of the DmPayment",
            "type":"string"
        },
        "createdBy":{
            "description":"createdBy of the DmPayment",
            "type":"string"
        },
        "lastUpdatedBy":{
            "description":"lastUpdatedBy of the DmPayment",
            "type":"string"
        },
        "udf1":{
            "description":"udf1 of the DmPayment",
            "type":"number"
        },
        "udf2":{
            "description":"udf2 of the DmPayment",
            "type":"number"
        },
        "udf3":{
            "description":"udf3 of the DmPayment",
            "type":"number"
        },
        "udf4":{
            "description":"udf4 of the DmPayment",
            "type":"number"
        },
        "udf5":{
            "description":"udf5 of the DmPayment",
            "type":"number"
        },
        "udf6":{
            "description":"udf6 of the DmPayment",
            "type":"number"
        },
        "udf7":{
            "description":"udf7 of the DmPayment",
            "type":"number"
        },
        "udf8":{
            "description":"udf8 of the DmPayment",
            "type":"number"
        },
        "udf9":{
            "description":"udf9 of the DmPayment",
            "type":"number"
        },
        "udf10":{
            "description":"udf10 of the DmPayment",
            "type":"number"
        },
        "udf11":{
            "description":"udf11 of the DmPayment",
            "type":"number"
        },
        "udf12":{
            "description":"udf12 of the DmPayment",
            "type":"number"
        },
        "udf13":{
            "description":"udf13 of the DmPayment",
            "type":"number"
        },
        "udf14":{
            "description":"udf14 of the DmPayment",
            "type":"number"
        },
        "udf15":{
            "description":"udf15 of the DmPayment",
            "type":"number"
        },
        "udf16":{
            "description":"udf16 of the DmPayment",
            "type":"number"
        },
        "udf17":{
            "description":"udf17 of the DmPayment",
            "type":"number"
        },
        "udf18":{
            "description":"udf18 of the DmPayment",
            "type":"number"
        },
        "udf19":{
            "description":"udf19 of the DmPayment",
            "type":"number"
        },
        "udf20":{
            "description":"udf20 of the DmPayment",
            "type":"number"
        },
        "udf21":{
            "description":"udf21 of the DmPayment",
            "type":"number"
        },
        "udf22":{
            "description":"udf22 of the DmPayment",
            "type":"number"
        },
        "udf23":{
            "description":"udf23 of the DmPayment",
            "type":"number"
        },
        "udf24":{
            "description":"udf24 of the DmPayment",
            "type":"number"
        },
        "udf25":{
            "description":"udf25 of the DmPayment",
            "type":"number"
        },
        "udf26":{
            "description":"udf26 of the DmPayment",
            "type":"number"
        },
        "udf27":{
            "description":"udf27 of the DmPayment",
            "type":"number"
        },
        "udf28":{
            "description":"udf28 of the DmPayment",
            "type":"number"
        },
        "udf29":{
            "description":"udf29 of the DmPayment",
            "type":"number"
        },
        "udf30":{
            "description":"udf30 of the DmPayment",
            "type":"number"
        },
        "udf31":{
            "description":"udf31 of the DmPayment",
            "type":"string"
        },
        "udf32":{
            "description":"udf32 of the DmPayment",
            "type":"string"
        },
        "udf33":{
            "description":"udf33 of the DmPayment",
            "type":"string"
        },
        "udf34":{
            "description":"udf34 of the DmPayment",
            "type":"string"
        },
        "udf35":{
            "description":"udf35 of the DmPayment",
            "type":"string"
        },
        "udf36":{
            "description":"udf36 of the DmPayment",
            "type":"string"
        },
        "udf37":{
            "description":"udf37 of the DmPayment",
            "type":"string"
        },
        "udf38":{
            "description":"udf38 of the DmPayment",
            "type":"string"
        },
        "udf39":{
            "description":"udf39 of the DmPayment",
            "type":"string"
        },
        "udf40":{
            "description":"udf40 of the DmPayment",
            "type":"string"
        },
        "udf41":{
            "description":"udf41 of the DmPayment",
            "type":"string"
        },
        "udf42":{
            "description":"udf42 of the DmPayment",
            "type":"string"
        },
        "udf43":{
            "description":"udf43 of the DmPayment",
            "type":"string"
        },
        "udf44":{
            "description":"udf44 of the DmPayment",
            "type":"string"
        },
        "udf45":{
            "description":"udf45 of the DmPayment",
            "type":"string"
        },
        "udf46":{
            "description":"udf46 of the DmPayment",
            "type":"string"
        },
        "udf47":{
            "description":"udf47 of the DmPayment",
            "type":"string"
        },
        "udf48":{
            "description":"udf48 of the DmPayment",
            "type":"string"
        },
        "udf49":{
            "description":"udf49 of the DmPayment",
            "type":"string"
        },
        "udf50":{
            "description":"udf50 of the DmPayment",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Headers

• Location: string
  Additional information of the Payment Against Promise To Pay.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): 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(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): 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(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): 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