Jump to

• Request
• Response

Cancel Promise to Pay with Reason and Notes

post

/obedm-ptp-services/ptp/cancel

This endpoint is used to cancel Promise to Pay with reason and notes.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application ID for Cancel Promise To Pay with reason and notes.
• branchCode: string
  Branch code for Cancel Promise To Pay with reason and notes.
• contentType(optional): string
  Content Type for Cancel Promise To Pay with reason and notes.
• tenantId(optional): string
  Tenant ID for Cancel Promise To Pay with reason and notes.
• userId: string
  User ID for Cancel Promise To Pay with reason and notes.

Body ()

Request Body that contains data required for cancel Promise To Pay with reason and notes.

Root Schema : CancelPTPRequestDto

Type: object

Show Source

• cancelReasonCode(optional): string
  The reason code for cancelling the PTP transaction.
• id(optional): string
  The unique identifier for the PTP transaction to be cancelled.
• notes(optional): string
  Additional notes or comments for cancelling the PTP transaction.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the PTP transaction to be cancelled.",
            "type":"string"
        },
        "cancelReasonCode":{
            "description":"The reason code for cancelling the PTP transaction.",
            "type":"string"
        },
        "notes":{
            "description":"Additional notes or comments for cancelling the PTP transaction.",
            "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 Cancel 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