Jump to

• Request
• Response

Add a new promise

post

/obedm-ptp-services/ptp/create/{accountNumber}

This endpoint is used to add a new promise.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• accountNumber(required): string
  Account Number

Header Parameters

• appId(required): string
  Application ID of promise
• branchCode(required): string
  Branch Code of promise
• contentType: string
  Content Type of promise.
• tenantId: string
  Tenant ID of promise.
• userId(required): string
  User ID of promise.

Body ()

Request Body that contains data required for creating a new promise.

Root Schema : DmPTPDto

Type: object

Show Source

• accountId: string
  Account ID for promise
• cancelReasonCode: string
  Cancelled Reason code for PTP
• caseId: string
  Case ID for promise
• createdBy: string
  PTP Created by user id
• createdDtTm: string
  Created PTP date and time
• currencyCode: string
  Currency Code promise
• id: string
  ID of promise
• lastBy: string
  Last updated PTP user
• lastUpdateDtTm: string
  Last time and date update PTP
• notes: string
  Notes of PTP
• promiseAmount: string
  Promise amount promise
• promiseDate: string
  Promise date for PTP
• ptpTransactionDto: array ptpTransactionDto
  PTP transactional Object
• ptpTypeCode: string
  PTP type code promise
• receivedAmount: string
  Received amount promise
• status: string
  Status of PTP
• taskId: string
  Task ID for promise
• taskTypeCd: string
  Task Type Code of the associated task.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of promise",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID for promise",
            "type":"string"
        },
        "taskId":{
            "description":"Task ID for promise",
            "type":"string"
        },
        "ptpTypeCode":{
            "description":"PTP type code promise",
            "type":"string"
        },
        "promiseAmount":{
            "description":"Promise amount promise",
            "type":"string"
        },
        "receivedAmount":{
            "description":"Received amount promise",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency Code promise",
            "type":"string"
        },
        "status":{
            "description":"Status of PTP",
            "type":"string"
        },
        "promiseDate":{
            "description":"Promise date for PTP",
            "type":"string"
        },
        "cancelReasonCode":{
            "description":"Cancelled Reason code for PTP",
            "type":"string"
        },
        "notes":{
            "description":"Notes of PTP",
            "type":"string"
        },
        "createdBy":{
            "description":"PTP Created by user id",
            "type":"string"
        },
        "createdDtTm":{
            "description":"Created PTP date and time ",
            "type":"string"
        },
        "lastBy":{
            "description":"Last updated PTP user",
            "type":"string"
        },
        "lastUpdateDtTm":{
            "description":"Last time and date update PTP",
            "type":"string"
        },
        "taskTypeCd":{
            "description":"Task Type Code of the associated task.",
            "type":"string"
        },
        "caseId":{
            "description":"Case ID for promise",
            "type":"string"
        },
        "ptpTransactionDto":{
            "type":"array",
            "description":"PTP transactional Object",
            "items":{
                "$ref":"#/definitions/PTPTransactionDto"
            }
        }
    }
}

Nested Schema : ptpTransactionDto

Type: array

PTP transactional Object

Show Source

• Array of: object PTPTransactionDto

{
    "type":"array",
    "description":"PTP transactional Object",
    "items":{
        "$ref":"#/definitions/PTPTransactionDto"
    }
}

Nested Schema : PTPTransactionDto

Type: object

Show Source

• id: string
  The unique identifier for the PTP Transaction.
• origReferenceNumber: string
  The original reference number for the PTP transaction.
• ptpMasterId: string
  The unique identifier for the PTP master record.
• referenceNumber: string
  The reference number for the PTP transaction.
• transactionAmount: string
  The amount of the PTP transaction.
• transactionDate: string
  The date the PTP transaction occurred.
• transactionType: string
  The type of PTP transaction that occurred.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the PTP Transaction.",
            "type":"string"
        },
        "transactionDate":{
            "description":"The date the PTP transaction occurred.",
            "type":"string"
        },
        "transactionType":{
            "description":"The type of PTP transaction that occurred.",
            "type":"string"
        },
        "transactionAmount":{
            "description":"The amount of the PTP transaction.",
            "type":"string"
        },
        "referenceNumber":{
            "description":"The reference number for the PTP transaction.",
            "type":"string"
        },
        "origReferenceNumber":{
            "description":"The original reference number for the PTP transaction.",
            "type":"string"
        },
        "ptpMasterId":{
            "description":"The unique identifier for the PTP master record.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of promise is success or failure.

Headers

• Location: string
  URL of newly created promise

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
  An array of response codes.
• getResponse: object NotesCollection
  Collection of Notes.
• id: string
  The ID of the response.
• requestId: string
  The ID of the request associated with the response.
• saveResponse: object inlineResponse201
  ID of the newly created order.
• status: string
  The status of the response.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the response."
        },
        "status":{
            "type":"string",
            "description":"The status of the response."
        },
        "codes":{
            "type":"array",
            "description":"An array of response codes.",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"The ID of the request associated with the response."
        },
        "saveResponse":{
            "$ref":"#/definitions/inlineResponse201"
        },
        "getResponse":{
            "$ref":"#/definitions/NotesCollection"
        }
    }
}

Nested Schema : codes

Type: array

An array of response codes.

Show Source

• Array of: object ResponseCode
  Response code for account.

{
    "type":"array",
    "description":"An array of response codes.",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : NotesCollection

Type: object

Collection of Notes.

Show Source

• notesList: array notesList

{
    "description":"Collection of Notes.",
    "type":"object",
    "properties":{
        "notesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NotesModel"
            }
        }
    }
}

Nested Schema : inlineResponse201

Type: object

ID of the newly created order.

Show Source

• id: string

{
    "description":"ID of the newly created order.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ResponseCode

Type: object

Response code for account.

Show Source

• arg: string
  The argument used in the response message.
• args: array args
  The arguments used in the response message.
• Code: string
  The code representing the response status.
• Desc: string
  The description of the response status.
• Language: string
  The language used for the response message.
• Type: string
  The type of the response status.

{
    "type":"object",
    "description":"Response code for account.",
    "properties":{
        "Code":{
            "type":"string",
            "description":"The code representing the response status."
        },
        "Desc":{
            "type":"string",
            "description":"The description of the response status."
        },
        "Type":{
            "type":"string",
            "description":"The type of the response status."
        },
        "Language":{
            "type":"string",
            "description":"The language used for the response message."
        },
        "args":{
            "type":"array",
            "description":"The arguments used in the response message.",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"The argument used in the response message."
        }
    }
}

Nested Schema : args

Type: array

The arguments used in the response message.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The arguments used in the response message.",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : notesList

Type: array

Show Source

• Array of: object NotesModel
  Notes model

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

Nested Schema : NotesModel

Type: object

Notes model

Show Source

• accountId: string
  The unique identifier of the account for which the note is created.
• actionId: string
  Action ID linked to the Note
• alert: string
  Alert Flag
• applyToAllAccounts: boolean
  Apply To All Accounts Flag
• capturedBy: string
  The unique identifier of the user who captured the note.
• caseId: string
  Case Id
• createdDate: string
  Created Date
• desc: string
  A description of the note.
• notesId: string
  The unique identifier of the note.
• notesType: string
  The type of the note.
• status: string
  The status of the note.

{
    "description":"Notes model",
    "type":"object",
    "properties":{
        "notesId":{
            "description":"The unique identifier of the note.",
            "type":"string"
        },
        "accountId":{
            "description":"The unique identifier of the account for which the note is created.",
            "type":"string"
        },
        "alert":{
            "description":"Alert Flag",
            "type":"string"
        },
        "createdDate":{
            "description":"Created Date",
            "type":"string"
        },
        "capturedBy":{
            "description":"The unique identifier of the user who captured the note.",
            "type":"string"
        },
        "status":{
            "description":"The status of the note.",
            "type":"string"
        },
        "notesType":{
            "description":"The type of the note.",
            "type":"string"
        },
        "desc":{
            "description":"A description of the note.",
            "type":"string"
        },
        "actionId":{
            "description":"Action ID linked to the Note",
            "type":"string"
        },
        "applyToAllAccounts":{
            "description":"Apply To All Accounts Flag",
            "type":"boolean"
        },
        "caseId":{
            "description":"Case Id",
            "type":"string"
        }
    }
}

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