CancelRequests_GetCancelPaymentDetailsByCancelRequestId

GET

/cancelrequests/{cancelRequestId}/cancelpayments

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Header Params

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location '/cancelrequests//cancelpayments' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'

Response Example

{
    "adminWitheldAmount": 0,
    "cancelPayments": [
        {
            "payeeName": "string",
            "payeeType": "string",
            "paymentAmount": 0,
            "paymentDate": "2019-08-24T14:15:22.123Z",
            "paymentId": 0,
            "transactionNumber": "string"
        }
    ],
    "contractId": 0,
    "contractIdentifier": "string",
    "contractNumber": "string",
    "contractStatus": "string",
    "hasPendingClaims": true
}

Modified at 2026-07-23 15:06:18

CancelRequests_ExecuteCancelRequest

Cancels_GetCancelById