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

The Collection of payment DTO

Show Source

• data(optional): array data

{
    "description":"The Collection of payment DTO",
    "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
  The account Id of the Payment
• origXrefNo(optional): string
  The origXref Number of the Payment
• transactionAmt(optional): number
  The transaction Amount of the Payment
• transactionCurrCd(optional): string
  The transaction Currency code of the DmPayment
• transactionDttm(optional): string
  The transaction Date and Time of the Payment
• transactionTypeFlg(optional): string
  The transaction Type Flag of the Payment
• xrefNo(optional): string
  The xref Number of the Payment

{
    "description":"DmPayment model",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"The account Id of the Payment",
            "type":"string"
        },
        "xrefNo":{
            "description":"The  xref Number of the Payment",
            "type":"string"
        },
        "transactionDttm":{
            "description":"The transaction Date and Time of the Payment",
            "type":"string"
        },
        "transactionCurrCd":{
            "description":"The transaction Currency code of the DmPayment",
            "type":"string"
        },
        "transactionAmt":{
            "description":"The transaction Amount of the Payment",
            "type":"number"
        },
        "transactionTypeFlg":{
            "description":"The transaction Type Flag of the Payment",
            "type":"string"
        },
        "origXrefNo":{
            "description":"The origXref Number of the Payment",
            "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